com.jivesoftware.community.webservices
Class WSConstants

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

public class WSConstants
extends java.lang.Object

Constants used with webservices

Nested Class Summary

static class

WSConstants.AccessType Used to distinguish what kind of access is allowed on the server.

Field Summary

static javax.xml.namespace.QName	FAULT_ATTACHMENT Maps a fault to the com.jivesoftware.community.AttachmentManager
static javax.xml.namespace.QName	FAULT_ATTACHMENT_NOT_FOUND Maps a fault to AttachmentNotFoundException
static javax.xml.namespace.QName	FAULT_AVATAR_EXCEPTION Maps a fault to com.jivesoftware.community.AvatarException
static javax.xml.namespace.QName	FAULT_BINARY_BODY Maps a fault to com.jivesoftware.community.BinaryBodyException
static javax.xml.namespace.QName	FAULT_BLOG_NOT_FOUND Maps a fault to com.jivesoftware.community.BlogNotFoundException
static javax.xml.namespace.QName	FAULT_BLOG_POST_NOT_FOUND Maps a fault to com.jivesoftware.community.BlogPostNotFoundException
static javax.xml.namespace.QName	FAULT_COMMENT_NOT_FOUND Maps a fault to ClassNotFoundException
static javax.xml.namespace.QName	FAULT_COMMUNITY_NOT_FOUND Maps a fault code to the CommunityNotFoundException
static javax.xml.namespace.QName	FAULT_DOCUMENT_ALREADY_EXISTS Maps a fault to the com.jivesoftware.community.DocumentObjectNotFoundException
static javax.xml.namespace.QName	FAULT_DOCUMENT_OBJECT_NOT_FOUND Maps a fault to the com.jivesoftware.community.DocumentObjectNotFoundException
static javax.xml.namespace.QName	FAULT_GROUP_ALREADY_EXISTS Maps a fault to the GroupNotFoundException
static javax.xml.namespace.QName	FAULT_GROUP_NOT_FOUND Maps a fault to the GroupNotFoundException
static javax.xml.namespace.QName	FAULT_JIVE_RUNTIME Maps a fault to the JiveRuntimeException
static javax.xml.namespace.QName	FAULT_LICENSE_EXCEPTION Maps a fault to LicenseException
static javax.xml.namespace.QName	FAULT_MESSAGE_NOT_FOUND Maps a fault code to the ForumMessageNotFoundException
static javax.xml.namespace.QName	FAULT_MESSAGE_REJECTED Maps a fault code to the RejectedException
static javax.xml.namespace.QName	FAULT_NAME_ALREADY_EXISTS Maps a fault code to the NameAlreadyExistsException
static javax.xml.namespace.QName	FAULT_NOT_FOUND Maps a fault code to the RejectedException
static javax.xml.namespace.QName	FAULT_POLL_EXCEPTION Maps a fault to LicenseException
static javax.xml.namespace.QName	FAULT_TAG_OBJECT_NOT_FOUND Maps a fault to com.jivesoftware.community.TagObjectNotFoundException
static javax.xml.namespace.QName	FAULT_THREAD_NOT_FOUND Maps a fault code to the ForumThreadNotFoundException
static javax.xml.namespace.QName	FAULT_UNAUTHORIZED Maps a fault to the UnauthorizedException
static javax.xml.namespace.QName	FAULT_USER_NOT_FOUND Maps a fault code to the UserNotFoundException
static int	MAX_MESSAGE_RESULTS The maximum amount of message IDs that will be returned by any method by default.
static int	MAX_THREAD_RESULTS The maximum amount of thread IDs that will be returned by any method by default.
static int	MAX_USER_RESULTS The maximum amount of user IDs that will be returned by any method by default.
static java.lang.String	NAMESPACE The namespace used for jive web services.
static java.lang.String	PROPERTY_ACCESS_TYPE The Jive Property is set to determine the type of access the webservices will allow.
static java.lang.String	PROPERTY_ALLOWED_GROUPS If access type is set to SPECIFIC_GROUPS then this property should contain a comma seperated list of group names of groups who can access web services.
static java.lang.String	PROPERTY_ALLOWED_USERS If access type is set to SPECIFIC_USERS then this property should contain a comma seperated list of usernames of users who can access web services.
static java.lang.String	PROPERTY_FORCE_SSL If this jive property is set webservices will only work over an ssl connection, non ssl requests will be denied.
static java.lang.String	PROPERTY_PERMISION_HANDLER The inbound handler for xfire that handles permissions
static java.lang.String	PROPERTY_REST_ENABLED The Jive Property should be set to true if REST web services should be enabled.
static java.lang.String	PROPERTY_SOAP_ENABLED This Jive Property should be set to true if SOAP web services should be enabled.
static java.lang.String	PROPERTY_XMLRPC_ENABLED This Jive Property should be set to true if XMLRPC web services should be enabled.

Constructor Summary

WSConstants()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

NAMESPACE

public static final java.lang.String NAMESPACE

The namespace used for jive web services.

See Also:

Constant Field Values

PROPERTY_REST_ENABLED

public static final java.lang.String PROPERTY_REST_ENABLED

The Jive Property should be set to true if REST web services should be enabled.

See Also:

Constant Field Values

PROPERTY_SOAP_ENABLED

public static final java.lang.String PROPERTY_SOAP_ENABLED

This Jive Property should be set to true if SOAP web services should be enabled.

See Also:

Constant Field Values

PROPERTY_XMLRPC_ENABLED

public static final java.lang.String PROPERTY_XMLRPC_ENABLED

This Jive Property should be set to true if XMLRPC web services should be enabled.

See Also:

Constant Field Values

PROPERTY_ACCESS_TYPE

public static final java.lang.String PROPERTY_ACCESS_TYPE

The Jive Property is set to determine the type of access the webservices will allow. See WSConstants.AccessType for details of the kinds of access types.

See Also:

Constant Field Values

PROPERTY_ALLOWED_USERS

public static final java.lang.String PROPERTY_ALLOWED_USERS

If access type is set to SPECIFIC_USERS then this property should contain a comma seperated list of usernames of users who can access web services.

See Also:

Constant Field Values

PROPERTY_ALLOWED_GROUPS

public static final java.lang.String PROPERTY_ALLOWED_GROUPS

If access type is set to SPECIFIC_GROUPS then this property should contain a comma seperated list of group names of groups who can access web services.

See Also:

Constant Field Values

PROPERTY_FORCE_SSL

public static final java.lang.String PROPERTY_FORCE_SSL

If this jive property is set webservices will only work over an ssl connection, non ssl requests will be denied.

See Also:

Constant Field Values

PROPERTY_PERMISION_HANDLER

public static final java.lang.String PROPERTY_PERMISION_HANDLER

The inbound handler for xfire that handles permissions

See Also:

Constant Field Values

MAX_THREAD_RESULTS

public static final int MAX_THREAD_RESULTS

The maximum amount of thread IDs that will be returned by any method by default.

See Also:

Constant Field Values

MAX_MESSAGE_RESULTS

public static final int MAX_MESSAGE_RESULTS

The maximum amount of message IDs that will be returned by any method by default.

See Also:

Constant Field Values

MAX_USER_RESULTS

public static final int MAX_USER_RESULTS

The maximum amount of user IDs that will be returned by any method by default.

See Also:

Constant Field Values

FAULT_COMMUNITY_NOT_FOUND

public static final javax.xml.namespace.QName FAULT_COMMUNITY_NOT_FOUND

Maps a fault code to the CommunityNotFoundException

FAULT_THREAD_NOT_FOUND

public static final javax.xml.namespace.QName FAULT_THREAD_NOT_FOUND

Maps a fault code to the ForumThreadNotFoundException

FAULT_MESSAGE_NOT_FOUND

public static final javax.xml.namespace.QName FAULT_MESSAGE_NOT_FOUND

Maps a fault code to the ForumMessageNotFoundException

FAULT_USER_NOT_FOUND

public static final javax.xml.namespace.QName FAULT_USER_NOT_FOUND

Maps a fault code to the UserNotFoundException

FAULT_NOT_FOUND

public static final javax.xml.namespace.QName FAULT_NOT_FOUND

Maps a fault code to the RejectedException

FAULT_MESSAGE_REJECTED

public static final javax.xml.namespace.QName FAULT_MESSAGE_REJECTED

Maps a fault code to the RejectedException

FAULT_NAME_ALREADY_EXISTS

public static final javax.xml.namespace.QName FAULT_NAME_ALREADY_EXISTS

Maps a fault code to the NameAlreadyExistsException

FAULT_ATTACHMENT

public static final javax.xml.namespace.QName FAULT_ATTACHMENT

Maps a fault to the com.jivesoftware.community.AttachmentManager

FAULT_GROUP_NOT_FOUND

public static final javax.xml.namespace.QName FAULT_GROUP_NOT_FOUND

Maps a fault to the GroupNotFoundException

FAULT_GROUP_ALREADY_EXISTS

public static final javax.xml.namespace.QName FAULT_GROUP_ALREADY_EXISTS

Maps a fault to the GroupNotFoundException

FAULT_UNAUTHORIZED

public static final javax.xml.namespace.QName FAULT_UNAUTHORIZED

Maps a fault to the UnauthorizedException

FAULT_JIVE_RUNTIME

public static final javax.xml.namespace.QName FAULT_JIVE_RUNTIME

Maps a fault to the JiveRuntimeException

FAULT_DOCUMENT_OBJECT_NOT_FOUND

public static final javax.xml.namespace.QName FAULT_DOCUMENT_OBJECT_NOT_FOUND

Maps a fault to the com.jivesoftware.community.DocumentObjectNotFoundException

FAULT_DOCUMENT_ALREADY_EXISTS

public static final javax.xml.namespace.QName FAULT_DOCUMENT_ALREADY_EXISTS

Maps a fault to the com.jivesoftware.community.DocumentObjectNotFoundException

FAULT_BINARY_BODY

public static final javax.xml.namespace.QName FAULT_BINARY_BODY

Maps a fault to com.jivesoftware.community.BinaryBodyException

FAULT_BLOG_NOT_FOUND

public static final javax.xml.namespace.QName FAULT_BLOG_NOT_FOUND

Maps a fault to com.jivesoftware.community.BlogNotFoundException

FAULT_BLOG_POST_NOT_FOUND

public static final javax.xml.namespace.QName FAULT_BLOG_POST_NOT_FOUND

Maps a fault to com.jivesoftware.community.BlogPostNotFoundException

FAULT_LICENSE_EXCEPTION

public static final javax.xml.namespace.QName FAULT_LICENSE_EXCEPTION

Maps a fault to LicenseException

FAULT_POLL_EXCEPTION

public static final javax.xml.namespace.QName FAULT_POLL_EXCEPTION

Maps a fault to LicenseException

FAULT_TAG_OBJECT_NOT_FOUND

public static final javax.xml.namespace.QName FAULT_TAG_OBJECT_NOT_FOUND

Maps a fault to com.jivesoftware.community.TagObjectNotFoundException

FAULT_COMMENT_NOT_FOUND

public static final javax.xml.namespace.QName FAULT_COMMENT_NOT_FOUND

Maps a fault to ClassNotFoundException

FAULT_AVATAR_EXCEPTION

public static final javax.xml.namespace.QName FAULT_AVATAR_EXCEPTION

Maps a fault to com.jivesoftware.community.AvatarException

FAULT_ATTACHMENT_NOT_FOUND

public static final javax.xml.namespace.QName FAULT_ATTACHMENT_NOT_FOUND

Maps a fault to AttachmentNotFoundException

Constructor Detail

WSConstants

public WSConstants()