org.mobicents.slee.enabler.xdmc

Interface XDMClientChild

All Known Subinterfaces:

XDMClientChildSbbLocalObject

All Known Implementing Classes:

XDMClientChildSbb

public interface XDMClientChild

Author:

martins

Method Summary

Methods

Modifier and Type	Method and Description
void	delete(URI uri, Credentials credentials) Deletes the content related the specified XCAP URI.
void	delete(URI uri, String assertedUserId) Deletes the content related the specified XCAP URI.
void	deleteIfMatch(URI uri, String eTag, Credentials credentials) Deletes the content related the specified XCAP URI, if the specified ETag matches the current one on the server.
void	deleteIfMatch(URI uri, String eTag, String assertedUserId) Deletes the content related the specified XCAP URI, if the specified ETag matches the current one on the server.
void	deleteIfNoneMatch(URI uri, String eTag, Credentials credentials) Deletes the content related the specified XCAP URI, if the specified ETag does not matches the current one on the server.
void	deleteIfNoneMatch(URI uri, String eTag, String assertedUserId) Deletes the content related the specified XCAP URI, if the specified ETag does not matches the current one on the server.
void	get(URI uri, Credentials credentials) Retrieves the XML resource from the XCAP server, for the specified uri.
void	get(URI uri, String assertedUserId) Retrieves the XML resource from the XCAP server, for the specified uri.
CredentialsFactory	getCredentialsFactory() Retrieves the factory to create request authentication credentials.
void	put(URI uri, String mimetype, byte[] content, Credentials credentials) Puts the specified content in the XCAP Server.
void	put(URI uri, String mimetype, byte[] content, String assertedUserId) Puts the specified content in the XCAP Server.
void	putIfMatch(URI uri, String eTag, String mimetype, byte[] content, Credentials credentials) Puts the specified content in the XCAP Server, if the specified ETag matches the current one on the server.
void	putIfMatch(URI uri, String eTag, String mimetype, byte[] content, String assertedUserId) Puts the specified content in the XCAP Server, if the specified ETag matches the current one on the server.
void	putIfNoneMatch(URI uri, String eTag, String mimetype, byte[] content, Credentials credentials) Puts the specified content in the XCAP Server, if the specified ETag does not matches the current one on the server.
void	putIfNoneMatch(URI uri, String eTag, String mimetype, byte[] content, String assertedUserId) Puts the specified content in the XCAP Server, if the specified ETag does not matches the current one on the server.
void	subscribe(String subscriber, String notifier, int expires, String[] resourceURIs) Method which triggers subscription to changes in XDMS resources.
void	unsubscribe(String subscriber, String notifier) Terminates a subscription to changes in XDMS resources.

Method Detail

getCredentialsFactory

CredentialsFactory getCredentialsFactory()

Retrieves the factory to create request authentication credentials.

Returns:

get

void get(URI uri,
       Credentials credentials)
         throws IOException

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

Parameters:

uri - the request uri

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

Throws:

IOException

get

void get(URI uri,
       String assertedUserId)
         throws IOException

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

Parameters:

uri - the request uri

assertedUserId - user id already authenticated

Throws:

IOException

put

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

Puts the specified content in the XCAP Server.

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 -

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

Throws:

IOException

put

void put(URI uri,
       String mimetype,
       byte[] content,
       String assertedUserId)
         throws IOException

Puts the specified content in the XCAP Server.

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 -

assertedUserId - user id already authenticated

Throws:

IOException

putIfMatch

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

Puts the specified content in the XCAP Server, 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 -

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

Throws:

IOException

putIfMatch

void putIfMatch(URI uri,
              String eTag,
              String mimetype,
              byte[] content,
              String assertedUserId)
                throws IOException

Puts the specified content in the XCAP Server, 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 -

assertedUserId - user id already authenticated

Throws:

IOException

putIfNoneMatch

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

Puts the specified content in the XCAP Server, 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 -

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

Throws:

IOException

putIfNoneMatch

void putIfNoneMatch(URI uri,
                  String eTag,
                  String mimetype,
                  byte[] content,
                  String assertedUserId)
                    throws IOException

Puts the specified content in the XCAP Server, 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 -

assertedUserId - user id already authenticated

Throws:

IOException

delete

void delete(URI uri,
          Credentials credentials)
            throws IOException

Deletes the content related the specified XCAP URI.

Parameters:

uri - the request uri

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

Throws:

IOException

delete

void delete(URI uri,
          String assertedUserId)
            throws IOException

Deletes the content related the specified XCAP URI.

Parameters:

uri - the request uri

assertedUserId - user id already authenticated

Throws:

IOException

deleteIfMatch

void deleteIfMatch(URI uri,
                 String eTag,
                 Credentials credentials)
                   throws IOException

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

Parameters:

uri - the request uri

eTag -

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

Throws:

IOException

deleteIfMatch

void deleteIfMatch(URI uri,
                 String eTag,
                 String assertedUserId)
                   throws IOException

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

Parameters:

uri - the request uri

eTag -

assertedUserId - user id already authenticated

Throws:

IOException

deleteIfNoneMatch

void deleteIfNoneMatch(URI uri,
                     String eTag,
                     Credentials credentials)
                       throws IOException

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

Parameters:

uri - the request uri

eTag -

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

Throws:

IOException

deleteIfNoneMatch

void deleteIfNoneMatch(URI uri,
                     String eTag,
                     String assertedUserId)
                       throws IOException

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

Parameters:

uri - the request uri

eTag -

assertedUserId - user id already authenticated

Throws:

IOException

subscribe

void subscribe(String subscriber,
             String notifier,
             int expires,
             String[] resourceURIs)
               throws org.mobicents.slee.enabler.sip.SubscriptionException

Method which triggers subscription to changes in XDMS resources. XCAP DIFF mode used is agreggated.

Parameters:

subscriber - - address that identifies local entity

notifier - - address that identifies the resource being subscribed (ie. XCAP Diff entity), ie. sip:tests@xcap.example.com

expires - - duration of subscription, in seconds.

resourceURIs - - array of resource uris to which enabler will subscribe, ie. String{}[resource-lists/users/sip:joe@example.com/index,rls-services/users/sip:joe@example.com/index/~~/*\/service%5b@uri='sip:marketing@example.com'%5d]

Throws:

org.mobicents.slee.enabler.sip.SubscriptionException

unsubscribe

void unsubscribe(String subscriber,
               String notifier)

Terminates a subscription to changes in XDMS resources.

Parameters:

subscriber -

notifier -