Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.forum.webservices
Class WSConstants

java.lang.Object
  extended by com.jivesoftware.forum.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_ANNOUNCEMENT_NOT_FOUND
          Maps a fault code to the ForumMessageNotFoundException
static javax.xml.namespace.QName FAULT_ATTACHMENT
          Maps a fault to the AttachmentException
static javax.xml.namespace.QName FAULT_CATEGORY_NOT_FOUND
          Maps a fault code to the ForumCategoryNotFoundException
static javax.xml.namespace.QName FAULT_FORUM_NOT_FOUND
          Maps a fault code to the ForumNotFoundException
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_MESSAGE_NOT_FOUND
          Maps a fault code to the ForumMessageNotFoundException
static javax.xml.namespace.QName FAULT_MESSAGE_REJECTED
          Maps a fault code to the MessageRejectedException
static javax.xml.namespace.QName FAULT_NAME_ALREADY_EXISTS
          Maps a fault code to the NameAlreadyExistsException
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_CUSTOM_CRYPTO_FILE_NAME
          The jive property containing the file name of the crypto.properties file used by wss4j.
static java.lang.String PROPERTY_CUSTOM_IN_HANDLER
          The Jive Property is set to determine if the CustomXFireServlet should be deployed for customized security options.
static java.lang.String PROPERTY_CUSTOM_PERMISSION_HANDLER
          The inbound handler for the CustomXFireServlet that handles permissions.
static java.lang.String PROPERTY_CUSTOM_WSS4J_HANDLER_PROVIDER
          The inbound handler for the CustomXFireServlet that handles permissions.
static java.lang.String PROPERTY_CUSTOM_XFIRE_ACTIVE
          If this jive property is set the CustomXFireServlet will be activated.
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_PERMISSION_HANDLER
          The inbound handler for xfire that handles permissions.
static java.lang.String PROPERTY_READ_WRITE
          This Jive Property should be set to true if SOAP web services are to be write enabled.
static java.lang.String PROPERTY_SOAP_ENABLED
          This Jive Property should be set to true if SOAP 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_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_READ_WRITE

public static final java.lang.String PROPERTY_READ_WRITE
This Jive Property should be set to true if SOAP web services are to be write 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_CUSTOM_IN_HANDLER

public static final java.lang.String PROPERTY_CUSTOM_IN_HANDLER
The Jive Property is set to determine if the CustomXFireServlet should be deployed for customized security options.

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_PERMISSION_HANDLER

public static final java.lang.String PROPERTY_PERMISSION_HANDLER
The inbound handler for xfire that handles permissions. Used by the JiveXFireServlet.

See Also:
Constant Field Values

PROPERTY_CUSTOM_XFIRE_ACTIVE

public static final java.lang.String PROPERTY_CUSTOM_XFIRE_ACTIVE
If this jive property is set the CustomXFireServlet will be activated.

See Also:
Constant Field Values

PROPERTY_CUSTOM_PERMISSION_HANDLER

public static final java.lang.String PROPERTY_CUSTOM_PERMISSION_HANDLER
The inbound handler for the CustomXFireServlet that handles permissions. Used by the CustomXFireServlet.

See Also:
Constant Field Values

PROPERTY_CUSTOM_WSS4J_HANDLER_PROVIDER

public static final java.lang.String PROPERTY_CUSTOM_WSS4J_HANDLER_PROVIDER
The inbound handler for the CustomXFireServlet that handles permissions. Used by the CustomXFireServlet.

See Also:
Constant Field Values

PROPERTY_CUSTOM_CRYPTO_FILE_NAME

public static final java.lang.String PROPERTY_CUSTOM_CRYPTO_FILE_NAME
The jive property containing the file name of the crypto.properties file used by wss4j.

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_FORUM_NOT_FOUND

public static final javax.xml.namespace.QName FAULT_FORUM_NOT_FOUND
Maps a fault code to the ForumNotFoundException


FAULT_CATEGORY_NOT_FOUND

public static final javax.xml.namespace.QName FAULT_CATEGORY_NOT_FOUND
Maps a fault code to the ForumCategoryNotFoundException


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_ANNOUNCEMENT_NOT_FOUND

public static final javax.xml.namespace.QName FAULT_ANNOUNCEMENT_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_MESSAGE_REJECTED

public static final javax.xml.namespace.QName FAULT_MESSAGE_REJECTED
Maps a fault code to the MessageRejectedException


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 AttachmentException


FAULT_GROUP_NOT_FOUND

public static final javax.xml.namespace.QName FAULT_GROUP_NOT_FOUND
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

Constructor Detail

WSConstants

public WSConstants()

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.