com.jivesoftware.forum.webservices
Class ServiceLocator

java.lang.Object
  com.jivesoftware.forum.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();
Forum forum = svc.getForum(1);


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

protected java.lang.Object	createServiceProxy(java.lang.String serviceName, java.lang.Class serviceClass)
AddressBookService	getAddressBookService() Returns a new instance of AddressBookService
AnnouncementService	getAnnouncementService()
AttachmentManagerService	getAttachmentManagerService() Returns a new instance of AttachmentManagerService
ContentService	getContentService() Returns a new instance of ContentService.
ForumCategoryService	getForumCategoryService() Returns a new instance of ForumCategoryService.
ForumMessageService	getForumMessageService() Returns a new instance of ForumMessageService.
ForumService	getForumService() Returns a new instance of ForumService.
ForumThreadService	getForumThreadService() Returns a new instance of ForumThreadService.
GroupService	getGroupService() Returns a new instance of GroupService
PermissionService	getPermissionService() Returns a new instance of PermissionService
PrivateMessageService	getPrivateMessageService() Returns a new instance of PrivateMessageService
ProfileService	getProfileService() Returns a new instance of ProfileService
User	getServiceUser() Returns the authenticated user.
SystemPropertiesService	getSystemPropertiesService() Returns a new instance of SystemPropertiesService
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

Constructor Detail

ServiceLocator

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

Create a new service locator.

Parameters:

url - Forums installation base url.

username - Username of the forums user to connect with.

password - The Password of the forums 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 - Forums installation base url.

Method Detail

getContentService

public ContentService getContentService()

Returns a new instance of ContentService.

Returns:

a new instance of ContentService.

getForumService

public ForumService getForumService()

Returns a new instance of ForumService.

Returns:

a new instance of ForumService.

getForumCategoryService

public ForumCategoryService getForumCategoryService()

Returns a new instance of ForumCategoryService.

Returns:

a new instance of ForumCategoryService.

getForumThreadService

public ForumThreadService getForumThreadService()

Returns a new instance of ForumThreadService.

Returns:

a new instance of ForumThreadService.

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

getSystemPropertiesService

public SystemPropertiesService getSystemPropertiesService()

Returns a new instance of SystemPropertiesService

Returns:

a new instance of SystemPropertiesService

getForumMessageService

public ForumMessageService getForumMessageService()

Returns a new instance of ForumMessageService.

Returns:

a new instance of ForumMessageService.

getProfileService

public ProfileService getProfileService()

Returns a new instance of ProfileService

Returns:

a new instance of ProfileService

getWatchService

public WatchService getWatchService()

Returns a new instance of WatchService

Returns:

a new instance of WatchService

getAttachmentManagerService

public AttachmentManagerService getAttachmentManagerService()

Returns a new instance of AttachmentManagerService

Returns:

a new instance of AttachmentManagerService

getAddressBookService

public AddressBookService getAddressBookService()

Returns a new instance of AddressBookService

Returns:

a new instance of AddressBookService

getPrivateMessageService

public PrivateMessageService getPrivateMessageService()

Returns a new instance of PrivateMessageService

Returns:

a new instance of PrivateMessageService

getAnnouncementService

public AnnouncementService getAnnouncementService()

getXFire

public org.codehaus.xfire.DefaultXFire getXFire()

Returns the current DefaultXFire instance.

Returns:

the xfire instance.

getServiceUser

public User getServiceUser()

Returns the authenticated user.

Returns:

the authenticated user.

createServiceProxy

protected java.lang.Object createServiceProxy(java.lang.String serviceName,
                                              java.lang.Class serviceClass)