org.mobicents.xcap.client

Interface XcapClient

All Known Implementing Classes:

XcapClientImpl

public interface XcapClient

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.
CredentialsFactory	getCredentialsFactory() Retrieves the request authentication credentials factory.
HeaderFactory	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.

Method Detail

delete

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

Deletes the content related the specified XCAP URI uri.

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

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

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

Parameters:

uri - the request uri

eTag -

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

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

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

Parameters:

uri - the request uri

eTag -

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

get

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

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

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

getCredentialsFactory

CredentialsFactory getCredentialsFactory()

Retrieves the request authentication credentials factory.

Returns:

getHeaderFactory

HeaderFactory getHeaderFactory()

Retrieves the request's header factory.

Returns:

put

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

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

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.

content -

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

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

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

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.

content -

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

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

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.

Parameters:

uri - the request uri

eTag -

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.

content -

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

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

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.

Parameters:

uri - the request uri

eTag -

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.

content -

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

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

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.

Parameters:

uri - the request uri

eTag -

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.

content -

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

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

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.

Parameters:

uri - the request uri

eTag -

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.

content -

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

setAuthenticationCredentials

void setAuthenticationCredentials(Credentials credentials)

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

Parameters:

credentials -

shutdown

void shutdown()

Shutdown the client.

unsetAuthenticationCredentials

void unsetAuthenticationCredentials()

Unsets the authentication credentials.