org.mobicents.xcap.client.impl

Class XcapClientImpl

java.lang.Object

org.mobicents.xcap.client.impl.XcapClientImpl

All Implemented Interfaces:

XcapClient

public class XcapClientImpl
extends Object
implements XcapClient

Impl of the XcapClient.

Author:

martins

Constructor Summary

Constructors

Constructor and Description
XcapClientImpl()

Method Summary

Methods

Modifier and Type	Method and Description
XcapResponse	delete(URI uri, Header[] additionalRequestHeaders, Credentials credentials) Deletes the content related the specified XCAP URI uri.
XcapResponse	deleteIfMatch(URI uri, String eTag, Header[] additionalRequestHeaders, Credentials credentials) Deletes the content related the specified XCAP URI uri, if the specified ETag matches the current one on the server.
XcapResponse	deleteIfNoneMatch(URI uri, String eTag, Header[] additionalRequestHeaders, Credentials credentials) Deletes the content related the specified XCAP URI uri, if the specified ETag does not matches the current one on the server.
XcapResponse	get(URI uri, Header[] additionalRequestHeaders, Credentials credentials) Retrieves the XML resource from the XCAP server, for the specified uri.
CredentialsFactoryImpl	getCredentialsFactory() Retrieves the request authentication credentials factory.
HeaderFactoryImpl	getHeaderFactory() Retrieves the request's header factory.
XcapResponse	put(URI uri, String mimetype, byte[] content, Header[] additionalRequestHeaders, Credentials credentials) Puts the specified content in the XCAP Server, in the XCAP URI pointed by the uri.
XcapResponse	put(URI uri, String mimetype, String content, Header[] additionalRequestHeaders, Credentials credentials) Puts the specified content in the XCAP Server, in the XCAP URI pointed by the uri.
XcapResponse	putIfMatch(URI uri, String eTag, String mimetype, byte[] content, Header[] additionalRequestHeaders, Credentials credentials) Puts the specified content in the XCAP Server, in the XCAP URI pointed by the uri, if the specified ETag matches the current one on the server.
XcapResponse	putIfMatch(URI uri, String eTag, String mimetype, String content, Header[] additionalRequestHeaders, Credentials credentials) Puts the specified content in the XCAP Server, in the XCAP URI pointed by the uri, if the specified ETag matches the current one on the server.
XcapResponse	putIfNoneMatch(URI uri, String eTag, String mimetype, byte[] content, Header[] additionalRequestHeaders, Credentials credentials) Puts the specified content in the XCAP Server, in the XCAP URI pointed by the uri, if the specified ETag does not matches the current one on the server.
XcapResponse	putIfNoneMatch(URI uri, String eTag, String mimetype, String content, Header[] additionalRequestHeaders, Credentials credentials) Puts the specified content in the XCAP Server, in the XCAP URI pointed by the uri, if the specified ETag does not matches the current one on the server.
void	setAuthenticationCredentials(Credentials credentials) Sets the global authentication credentials, those will be used when there are no credentials for the request.
void	shutdown() Shutdown the client.
void	unsetAuthenticationCredentials() Unsets the authentication credentials.

Methods inherited from class java.lang.Object

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

Constructor Detail

XcapClientImpl

public XcapClientImpl()

Method Detail

getCredentialsFactory

public CredentialsFactoryImpl getCredentialsFactory()

Description copied from interface: XcapClient

Retrieves the request authentication credentials factory.

Specified by:

getCredentialsFactory in interface XcapClient

Returns:

getHeaderFactory

public HeaderFactoryImpl getHeaderFactory()

Description copied from interface: XcapClient

Retrieves the request's header factory.

Specified by:

getHeaderFactory in interface XcapClient

Returns:

setAuthenticationCredentials

public void setAuthenticationCredentials(Credentials credentials)

Description copied from interface: XcapClient

Sets the global authentication credentials, those will be used when there are no credentials for the request. Those credentials are applied to any host.

Specified by:

setAuthenticationCredentials in interface XcapClient

unsetAuthenticationCredentials

public void unsetAuthenticationCredentials()

Description copied from interface: XcapClient

Unsets the authentication credentials.

Specified by:

unsetAuthenticationCredentials in interface XcapClient

shutdown

public void shutdown()

Description copied from interface: XcapClient

Shutdown the client.

Specified by:

shutdown in interface XcapClient

get

public XcapResponse get(URI uri,
               Header[] additionalRequestHeaders,
               Credentials credentials)
                 throws IOException

Description copied from interface: XcapClient

Retrieves the XML resource from the XCAP server, for the specified uri.

Specified by:

get in interface XcapClient

Parameters:

uri - the request uri

additionalRequestHeaders - additional headers to include in the XCAP request

credentials - authentication credentials, can be null for requests that don't need authentication.

Returns:

Throws:

IOException

put

public XcapResponse put(URI uri,
               String mimetype,
               String content,
               Header[] additionalRequestHeaders,
               Credentials credentials)
                 throws IOException

Description copied from interface: XcapClient

Puts the specified content in the XCAP Server, in the XCAP URI pointed by the uri.

Specified by:

put in interface XcapClient

Parameters:

uri - the request uri

mimetype - the mimetype of the content to put, for document each XCAP App Usage defines their own mimetype, but for elements and attributes you can use ElementResource and AttributeResource static MIMETYPE fields.

additionalRequestHeaders - additional headers to include in the XCAP request

credentials - authentication credentials, can be null for requests that don't need authentication.

Returns:

Throws:

IOException

putIfMatch

public XcapResponse putIfMatch(URI uri,
                      String eTag,
                      String mimetype,
                      String content,
                      Header[] additionalRequestHeaders,
                      Credentials credentials)
                        throws IOException

Description copied from interface: XcapClient

Puts the specified content in the XCAP Server, in the XCAP URI pointed by the uri, if the specified ETag matches the current one on the server.

Specified by:

putIfMatch in interface XcapClient

Parameters:

uri - the request uri

mimetype - the mimetype of the content to put, for document each XCAP App Usage defines their own mimetype, but for elements and attributes you can use ElementResource and AttributeResource static MIMETYPE fields.

additionalRequestHeaders - additional headers to include in the XCAP request

credentials - authentication credentials, can be null for requests that don't need authentication.

Returns:

Throws:

IOException

putIfNoneMatch

public XcapResponse putIfNoneMatch(URI uri,
                          String eTag,
                          String mimetype,
                          String content,
                          Header[] additionalRequestHeaders,
                          Credentials credentials)
                            throws IOException

Description copied from interface: XcapClient

Puts the specified content in the XCAP Server, in the XCAP URI pointed by the uri, if the specified ETag does not matches the current one on the server.

Specified by:

putIfNoneMatch in interface XcapClient

Parameters:

uri - the request uri

mimetype - the mimetype of the content to put, for document each XCAP App Usage defines their own mimetype, but for elements and attributes you can use ElementResource and AttributeResource static MIMETYPE fields.

additionalRequestHeaders - additional headers to include in the XCAP request

credentials - authentication credentials, can be null for requests that don't need authentication.

Returns:

Throws:

IOException

put

public XcapResponse put(URI uri,
               String mimetype,
               byte[] content,
               Header[] additionalRequestHeaders,
               Credentials credentials)
                 throws IOException

Description copied from interface: XcapClient

Puts the specified content in the XCAP Server, in the XCAP URI pointed by the uri.

Specified by:

put in interface XcapClient

Parameters:

uri - the request uri

mimetype - the mimetype of the content to put, for document each XCAP App Usage defines their own mimetype, but for elements and attributes you can use ElementResource and AttributeResource static MIMETYPE fields.

additionalRequestHeaders - additional headers to include in the XCAP request

credentials - authentication credentials, can be null for requests that don't need authentication.

Returns:

Throws:

IOException

putIfMatch

public XcapResponse putIfMatch(URI uri,
                      String eTag,
                      String mimetype,
                      byte[] content,
                      Header[] additionalRequestHeaders,
                      Credentials credentials)
                        throws IOException

Description copied from interface: XcapClient

Puts the specified content in the XCAP Server, in the XCAP URI pointed by the uri, if the specified ETag matches the current one on the server.

Specified by:

putIfMatch in interface XcapClient

Parameters:

uri - the request uri

mimetype - the mimetype of the content to put, for document each XCAP App Usage defines their own mimetype, but for elements and attributes you can use ElementResource and AttributeResource static MIMETYPE fields.

additionalRequestHeaders - additional headers to include in the XCAP request

credentials - authentication credentials, can be null for requests that don't need authentication.

Returns:

Throws:

IOException

putIfNoneMatch

public XcapResponse putIfNoneMatch(URI uri,
                          String eTag,
                          String mimetype,
                          byte[] content,
                          Header[] additionalRequestHeaders,
                          Credentials credentials)
                            throws IOException

Description copied from interface: XcapClient

Puts the specified content in the XCAP Server, in the XCAP URI pointed by the uri, if the specified ETag does not matches the current one on the server.

Specified by:

putIfNoneMatch in interface XcapClient

Parameters:

uri - the request uri

mimetype - the mimetype of the content to put, for document each XCAP App Usage defines their own mimetype, but for elements and attributes you can use ElementResource and AttributeResource static MIMETYPE fields.

additionalRequestHeaders - additional headers to include in the XCAP request

credentials - authentication credentials, can be null for requests that don't need authentication.

Returns:

Throws:

IOException

delete

public XcapResponse delete(URI uri,
                  Header[] additionalRequestHeaders,
                  Credentials credentials)
                    throws IOException

Description copied from interface: XcapClient

Deletes the content related the specified XCAP URI uri.

Specified by:

delete in interface XcapClient

Parameters:

uri - the request uri

additionalRequestHeaders - additional headers to include in the XCAP request

credentials - authentication credentials, can be null for requests that don't need authentication.

Returns:

Throws:

IOException

deleteIfMatch

public XcapResponse deleteIfMatch(URI uri,
                         String eTag,
                         Header[] additionalRequestHeaders,
                         Credentials credentials)
                           throws IOException

Description copied from interface: XcapClient

Deletes the content related the specified XCAP URI uri, if the specified ETag matches the current one on the server.

Specified by:

deleteIfMatch in interface XcapClient

Parameters:

uri - the request uri

additionalRequestHeaders - additional headers to include in the XCAP request

credentials - authentication credentials, can be null for requests that don't need authentication.

Returns:

Throws:

IOException

deleteIfNoneMatch

public XcapResponse deleteIfNoneMatch(URI uri,
                             String eTag,
                             Header[] additionalRequestHeaders,
                             Credentials credentials)
                               throws IOException

Description copied from interface: XcapClient

Deletes the content related the specified XCAP URI uri, if the specified ETag does not matches the current one on the server.

Specified by:

deleteIfNoneMatch in interface XcapClient

Parameters:

uri - the request uri

additionalRequestHeaders - additional headers to include in the XCAP request

credentials - authentication credentials, can be null for requests that don't need authentication.

Returns:

Throws:

IOException