com.ibm.xcap.client
Class XcapClientResponse

java.lang.Object
  extended by com.ibm.xcap.client.XcapClientResponse
All Implemented Interfaces:
XcapConstants, XcapResponse

public class XcapClientResponse
extends java.lang.Object
implements XcapResponse

The XcapClientResponse is returned from an XcapClientRequest send() method call.

See Also:
XcapClientRequest.send()

Field Summary
static java.lang.String CLASSNAME
          Classname
static java.util.logging.Logger LOGGER
          Logger for this class
 
Fields inherited from interface com.ibm.xcap.XcapConstants
ANONYMOUS_USER, APPEND_CONTENT_TYPE_CHARSET_UTF8, AUID_ACCESS_RULES, AUID_ACCESS_RULES_ACLS, AUID_GROUP_USAGE_LIST, AUID_GROUP_USAGE_LIST_ACLS, AUID_GROUPS, AUID_GROUPS_ACLS, AUID_LOCKED_USER_PROFILE, AUID_LOCKED_USER_PROFILE_ACLS, AUID_OMA_SEARCH, AUID_PRES_RULES, AUID_PRES_RULES_ACLS, AUID_RESOURCE_LISTS, AUID_RESOURCE_LISTS_ACLS, AUID_RLS_SERVICES, AUID_RLS_SERVICES_ACLS, AUID_USER_PROFILE, AUID_USER_PROFILE_ACLS, AUID_XCAP_CAPS, AUID_XCAP_DIRECTORY, CHARSET_UTF8, CLIENT_RESOURCE_BUNDLE, CLOSE_BRACKET, COMPARE_TO_IS_EQUAL, COMPARE_TO_IS_NOT_EQUAL, COMPARE_TO_IS_SUBSET, COMPARE_TO_IS_SUPERSET, CONTENT_TYPE_ACCESS_RULES, CONTENT_TYPE_APPLICATION_ERROR_XML, CONTENT_TYPE_AUTH_POLICY, CONTENT_TYPE_GROUP_USAGE_LIST, CONTENT_TYPE_GROUPS, CONTENT_TYPE_LOCKED_USER_PROFILE, CONTENT_TYPE_NAMESPACE_BINDING, CONTENT_TYPE_OMA_DIRECTORY, CONTENT_TYPE_OMA_SEARCH, CONTENT_TYPE_PRES_RULES, CONTENT_TYPE_RESOURCE_LISTS, CONTENT_TYPE_RLS_SERVICES, CONTENT_TYPE_USER_PROFILE, CONTENT_TYPE_XCAP_CAPS, CONTENT_TYPE_XCAP_DIFF, CONTENT_TYPE_XCAP_ERROR, CONTENT_TYPE_XML_ATTRIBUTE, CONTENT_TYPE_XML_ELEMENT, DOC_GLOBAL_DIRECTORY, DOC_GLOBAL_INDEX, DOC_USER_DIRECTORY, DOC_XCAP_CAPS, DOUBLE_FORWARD_SLASH, EMPTY, ENCODED_SINGLE_QUOTE, ENCODED_SLASH_CLOSE_BRACKET, ENCODED_SLASH_OPEN_BRACKET, EXTENSION_LOCAL_CONSTRAINT_FAILURE, FORWARD_SLASH, GLOBAL, GLOBAL_DOC_DIRECTORY_PREFIX, GLOBAL_DOC_DIRECTORY_SUFFIX, HEADER_ACCEPT, HEADER_ALLOW, HEADER_CONTENT_TYPE, HEADER_ETAG, HEADER_IF_MATCH, HEADER_IF_NONE_MATCH, HEADER_LAST_MODIFIED, HEADER_X_3GPP_ASSERTED_IDENTITY, HEADER_X_3GPP_INTENDED_IDENTITY, HEADER_X_XCAP_ASSERTED_IDENTITY, HTTP_METHOD_DELETE, HTTP_METHOD_GET, HTTP_METHOD_POST, HTTP_METHOD_PUT, NS_ACCESS_RULES, NS_COMMON_POLICY, NS_GROUPS, NS_LOCKED_USER_PROFILE, NS_OMA_APPUSAGE, NS_OMA_COMMON_POLICY, NS_OMA_URIUSAGE, NS_OMA_XCAP_ERROR, NS_PRES_RULES, NS_RESOURCE_LISTS, NS_RLS_SERVICES, NS_USER_PROFILE, NS_XCAP_CAPS, NS_XCAP_DIRECTORY, NS_XCAP_ERROR, NS_XDM_EXTENSIONS, OPEN_BRACKET, PATH_SEARCH, RC_100_CONTINUE, RC_101_SWITCHING_PROTOCOLS, RC_200_OK, RC_201_CREATED, RC_202_ACCEPTED, RC_203_NON_AUTHORITATIVE_INFO, RC_204_NO_CONTENT, RC_205_RESET_CONTENT, RC_206_PARTIAL_CONTENT, RC_300_MULTIPLE_CHOICES, RC_301_MOVED_PERMANANTLY, RC_302_FOUND, RC_303_SEE_OTHER, RC_304_NOT_MODIFIED, RC_305_USE_PROXY, RC_307_TEMPORARY_REDIRECT, RC_400_BAD_REQUEST, RC_401_UNAUTHORIZED, RC_402_PAYMENT_REQUIRED, RC_403_FORBIDDEN, RC_404_NOT_FOUND, RC_405_METHOD_NOT_ALLOWED, RC_406_NOT_ACCEPTABLE, RC_407_PROXY_AUTHENTICATION_REQUIRED, RC_408_REQUEST_TIMEOUT, RC_409_CONFLICT, RC_410_GONE, RC_411_LENGTH_REQUIRED, RC_412_PRECONDITION_FAILED, RC_413_REQUEST_ENTITY_TOO_LARGE, RC_414_REQUEST_URI_TOO_LONG, RC_415_UNSUPPORTED_MEDIA_TYPE, RC_416_REQUESTED_RANGE_NOT_SATISFIABLE, RC_417_EXPECTATION_FAILED, RC_500_INTERNAL_SERVER_ERROR, RC_501_NOT_IMPLEMENTED, RC_502_BAD_GATEWAY, RC_503_SERVICES_UNAVAILABLE, RC_504_GATEWAY_TIMEOUT, RC_505_HTTP_VERSION_NOT_SUPPORTED, SINGLE_QUOTE, SINGLE_SPACE, SLASH_CLOSE_BRACKET, SLASH_OPEN_BRACKET, USERS, UTF_8, UTF8_BYTE_ORDER_MARKER, XML_DECLARATION, XPATH_SEPARATOR
 
Method Summary
 boolean containsHeader(java.lang.String name)
          Returns a boolean indicating whether the named response header has already been set.
 int getContentLength()
          Returns the content length
 java.lang.String getContentType()
          Retrieves the content-type of the response.
 java.io.IOException getException()
          Returns the exception stored during a request.
 java.lang.String getHeader(java.lang.String header)
           
 java.util.Enumeration getHeaderNames()
           
 java.util.Enumeration getHeaders(java.lang.String header)
           
 java.lang.String getHttpVersion()
           
 int getStatusCode()
           
 java.lang.String getStatusMessage()
           
 java.lang.String getXml()
          Retrieves the XML response returned for GET request.
 void setException(java.io.IOException ioe)
           
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

CLASSNAME

public static final java.lang.String CLASSNAME
Classname


LOGGER

public static final java.util.logging.Logger LOGGER
Logger for this class

Method Detail

getStatusCode

public int getStatusCode()
                  throws java.io.IOException
Throws:
java.io.IOException

getStatusMessage

public java.lang.String getStatusMessage()
                                  throws java.io.IOException
Throws:
java.io.IOException

getXml

public java.lang.String getXml()
Description copied from interface: XcapResponse
Retrieves the XML response returned for GET request.

Specified by:
getXml in interface XcapResponse
Returns:
String Retrieves the XML response returned for GET request.

getHttpVersion

public java.lang.String getHttpVersion()

getContentType

public java.lang.String getContentType()
Description copied from interface: XcapResponse
Retrieves the content-type of the response.

Specified by:
getContentType in interface XcapResponse
Returns:
String Retrieves the content-type of the response.

getHeaderNames

public java.util.Enumeration getHeaderNames()

getHeader

public java.lang.String getHeader(java.lang.String header)

getHeaders

public java.util.Enumeration getHeaders(java.lang.String header)

containsHeader

public boolean containsHeader(java.lang.String name)
Returns a boolean indicating whether the named response header has already been set.

Specified by:
containsHeader in interface XcapResponse
Parameters:
name - The header name
Returns:
true if the named response header has already been set; false otherwise

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

getContentLength

public int getContentLength()
Returns the content length

Returns:
Returns the content length

setException

public void setException(java.io.IOException ioe)

getException

public java.io.IOException getException()
Returns the exception stored during a request. The is used during multithreaded requests to store tasks. The exception will be available when the status code of the instance is equal to -1

Returns:
IOException
See Also:
RequestTask.run()