com.jivesoftware.community.webservices
Class ServiceLocator

java.lang.Object
  com.jivesoftware.community.webservices.ServiceLocator

public class ServiceLocator
extends java.lang.Object

Entry point to the jive java soap webservices api. Supplies the client with access to all of the different services.

General Usage:
ServiceLocator locator = new ServiceLocator("https://myforums.com", "user", "password");
ContentService svc = locator.getContentService();
Community community = svc.getCommunity(1);


Nested Class Summary

protected static class

ServiceLocator.CacheKey Cache key used by CacheHandler

Field Summary

protected AddressBookService	addressBookService
protected AttachmentService	attachmentManagerService
protected BlogService	blogService
protected CommentService	commentService
protected CommunityService	communityService
protected DocumentService	documentService
protected ForumService	forumService
protected GroupService	groupService
protected org.codehaus.xfire.service.binding.ObjectServiceFactory	objectServiceFactory
protected java.lang.String	password
protected PermissionService	permissionService
protected PollService	pollService
protected ProfileFieldService	profileFieldService
protected ProfileService	profileService
protected org.codehaus.xfire.client.XFireProxyFactory	proxyFactory
protected java.lang.String	proxyHost
protected java.lang.String	proxyPort
protected RatingsService	ratingsService
protected SearchService	searchService
protected SystemPropertiesService	systemPropertiesService
protected TagService	tagService
protected java.lang.String	url
protected java.lang.String	username
protected UserService	userService
protected WatchService	watchService
protected org.codehaus.xfire.DefaultXFire	xfire

Constructor Summary

ServiceLocator(java.lang.String url)
Creates a new anonymous Service Locator.

ServiceLocator(java.lang.String url, java.lang.String username, java.lang.String password)
Create a new service locator.

ServiceLocator(java.lang.String url, java.lang.String username, java.lang.String password, java.lang.String proxyHost, java.lang.String proxyPort)

Method Summary

<U> U	createServiceProxy(java.lang.Class<U> serviceClass, boolean mtomEnabled) This will create an service proxy for the specified class interface.
AddressBookService	getAddressBookService() Returns a new instance of AddressBookService.
AttachmentService	getAttachmentManagerService() Returns a new instance of AttachmentService
BlogService	getBlogService() Returns an instance of BlogService.
CommentService	getCommentService() Returns an instance of CommentService.
CommunityService	getCommunityService() Returns a new instance of CommunityService.
DocumentService	getDocumentService()
ForumService	getForumService() Returns a new instance of ForumService.
GroupService	getGroupService() Returns a new instance of GroupService
PermissionService	getPermissionService() Returns a new instance of PermissionService
PollService	getPollService() Return an instance of PollService
ProfileFieldService	getProfileFieldService() Returns an instance of ProfileFieldService.
ProfileService	getProfileService() Returns an instance of ProfileService
RatingsService	getRatingsService() Return an instance of RatingsService
SearchService	getSearchService() Returns a new instance of SearchService.
SystemPropertiesService	getSystemPropertiesService() Returns a new instance of SystemPropertiesService
TagService	getTagService() Returns an instance of TagService.
UserService	getUserService() Returns a new instance of UserService
WatchService	getWatchService() Returns a new instance of WatchService
org.codehaus.xfire.DefaultXFire	getXFire() Returns the current DefaultXFire instance.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

url

protected java.lang.String url

password

protected java.lang.String password

searchService

protected SearchService searchService

communityService

protected CommunityService communityService

forumService

protected ForumService forumService

userService

protected UserService userService

groupService

protected GroupService groupService

watchService

protected WatchService watchService

permissionService

protected PermissionService permissionService

documentService

protected DocumentService documentService

pollService

protected PollService pollService

ratingsService

protected RatingsService ratingsService

attachmentManagerService

protected AttachmentService attachmentManagerService

systemPropertiesService

protected SystemPropertiesService systemPropertiesService

blogService

protected BlogService blogService

proxyHost

protected java.lang.String proxyHost

proxyPort

protected java.lang.String proxyPort

xfire

protected org.codehaus.xfire.DefaultXFire xfire

objectServiceFactory

protected org.codehaus.xfire.service.binding.ObjectServiceFactory objectServiceFactory

username

protected java.lang.String username

proxyFactory

protected org.codehaus.xfire.client.XFireProxyFactory proxyFactory

tagService

protected TagService tagService

commentService

protected CommentService commentService

profileFieldService

protected ProfileFieldService profileFieldService

profileService

protected ProfileService profileService

addressBookService

protected AddressBookService addressBookService

Constructor Detail

ServiceLocator

public ServiceLocator(java.lang.String url,
                      java.lang.String username,
                      java.lang.String password)

Create a new service locator.

Parameters:

url - Community installation base url.

username - Username of the community user to connect with.

password - The Password of the community user.

ServiceLocator

public ServiceLocator(java.lang.String url,
                      java.lang.String username,
                      java.lang.String password,
                      java.lang.String proxyHost,
                      java.lang.String proxyPort)

ServiceLocator

public ServiceLocator(java.lang.String url)

Creates a new anonymous Service Locator.

Parameters:

url - community installation base url.

Method Detail

getSearchService

public SearchService getSearchService()

Returns a new instance of SearchService.

Returns:

a new instance of SearchService.

getCommunityService

public CommunityService getCommunityService()

Returns a new instance of CommunityService.

Returns:

a new instance of CommunityService.

getGroupService

public GroupService getGroupService()

Returns a new instance of GroupService

Returns:

a new instance of GroupService

getPermissionService

public PermissionService getPermissionService()

Returns a new instance of PermissionService

Returns:

a new instance of PermissionService

getAddressBookService

public AddressBookService getAddressBookService()

Returns a new instance of AddressBookService.

Returns:

a new instance of AddressBookService.

getForumService

public ForumService getForumService()

Returns a new instance of ForumService.

Returns:

a new instance of ForumService.

getUserService

public UserService getUserService()

Returns a new instance of UserService

Returns:

a new instance of UserService

getWatchService

public WatchService getWatchService()

Returns a new instance of WatchService

Returns:

a new instance of WatchService

getDocumentService

public DocumentService getDocumentService()

getAttachmentManagerService

public AttachmentService getAttachmentManagerService()

Returns a new instance of AttachmentService

Returns:

a new instance of AttachmentService

getSystemPropertiesService

public SystemPropertiesService getSystemPropertiesService()

Returns a new instance of SystemPropertiesService

Returns:

a new instance of SystemPropertiesService

getPollService

public PollService getPollService()

Return an instance of PollService

Returns:

an instance of PollService

getRatingsService

public RatingsService getRatingsService()

Return an instance of RatingsService

Returns:

an instance of RatingsService

getBlogService

public BlogService getBlogService()

Returns an instance of BlogService.

Returns:

an instance of BlogService.

getTagService

public TagService getTagService()

Returns an instance of TagService.

Returns:

an instance of TagService.

getCommentService

public CommentService getCommentService()

Returns an instance of CommentService.

Returns:

an instance of CommentService.

Since:

1.9

getProfileFieldService

public ProfileFieldService getProfileFieldService()

Returns an instance of ProfileFieldService.

Returns:

an instance of ProfileFieldService.

Since:

1.9

getProfileService

public ProfileService getProfileService()

Returns an instance of ProfileService

Returns:

an instance of ProfileService

Since:

1.9

getXFire

public org.codehaus.xfire.DefaultXFire getXFire()

Returns the current DefaultXFire instance.

Returns:

the xfire instance.

createServiceProxy

public <U> U createServiceProxy(java.lang.Class<U> serviceClass,
                                boolean mtomEnabled)

This will create an service proxy for the specified class interface. The serviceClass must be annotated with WebService with the serviceName specified.

Parameters:

serviceClass - The service interface.

mtomEnabled - Whether or not to enable MTOM encoding

Returns:

returns an instance of serviceClass