org.restcomm.slee.enabler.xdmc

Class XDMClientChildSbb

java.lang.Object

org.restcomm.slee.enabler.xdmc.XDMClientChildSbb

All Implemented Interfaces:

javax.slee.Sbb, org.mobicents.slee.enabler.sip.SubscriptionClientParent, XDMClientChild

public abstract class XDMClientChildSbb
extends Object
implements javax.slee.Sbb, XDMClientChild, org.mobicents.slee.enabler.sip.SubscriptionClientParent

XDM Client SLEE Enabler.

Author:

martins

Field Summary

Fields

Modifier and Type	Field and Description
static org.mobicents.slee.enabler.sip.ContentType[]	ACCEPTED_CONTENT_TYPES
static org.mobicents.slee.enabler.sip.ContentType	CONTENT_TYPE
static String	EVENT_PACKAGE
static org.mobicents.slee.enabler.sip.EventPackageParameter[]	EVENT_PARAMETERS
protected org.mobicents.slee.SbbContextExt	sbbContext
protected XCAPClientActivityContextInterfaceFactory	xcapClientACIF
protected XCAPClientResourceAdaptorSbbInterface	xcapClientSbbInterface

Constructor Summary

Constructors

Constructor and Description
XDMClientChildSbb()

Method Summary

Methods

Modifier and Type	Method and Description
void	delete(URI uri, org.restcomm.xcap.client.auth.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, org.restcomm.xcap.client.auth.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, org.restcomm.xcap.client.auth.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, org.restcomm.xcap.client.auth.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.
org.restcomm.xcap.client.auth.CredentialsFactory	getCredentialsFactory() Retrieves the factory to create request authentication credentials.
protected XDMClientParentSbbLocalObject	getParent()
abstract org.mobicents.slee.ChildRelationExt	getSubscriptionClientChildSbbChildRelation()
void	onDeleteResponseEvent(ResponseEvent event, javax.slee.ActivityContextInterface aci) Handles XCAP DELETE response events.
void	onGetResponseEvent(ResponseEvent event, javax.slee.ActivityContextInterface aci) Handles XCAP GET response events.
void	onNotify(org.mobicents.slee.enabler.sip.Notify ntfy, org.mobicents.slee.enabler.sip.SubscriptionClientChildSbbLocalObject subscriptionChild)
void	onPutResponseEvent(ResponseEvent event, javax.slee.ActivityContextInterface aci) Handles XCAP PUT response events.
void	put(URI uri, String mimetype, byte[] content, org.restcomm.xcap.client.auth.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, org.restcomm.xcap.client.auth.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, org.restcomm.xcap.client.auth.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	resubscribeFailed(int responseCode, org.mobicents.slee.enabler.sip.SubscriptionClientChildSbbLocalObject subscriptionChild)
void	sbbActivate()
void	sbbCreate()
void	sbbExceptionThrown(Exception arg0, Object arg1, javax.slee.ActivityContextInterface arg2)
void	sbbLoad()
void	sbbPassivate()
void	sbbPostCreate()
void	sbbRemove()
void	sbbRolledBack(javax.slee.RolledBackContext arg0)
void	sbbStore()
void	setSbbContext(javax.slee.SbbContext sbbContext)
void	subscribe(String subscriber, String notifier, int expires, String[] resourceURIs) Method which triggers subscription to changes in XDMS resources.
void	subscribeFailed(int responseCode, org.mobicents.slee.enabler.sip.SubscriptionClientChildSbbLocalObject subscriptionChild)
void	unsetSbbContext()
void	unsubscribe(String subscriber, String notifier) Terminates a subscription to changes in XDMS resources.
void	unsubscribeFailed(int arg0, org.mobicents.slee.enabler.sip.SubscriptionClientChildSbbLocalObject subscriptionChild)

Methods inherited from class java.lang.Object

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

Field Detail

sbbContext

protected org.mobicents.slee.SbbContextExt sbbContext

xcapClientSbbInterface

protected XCAPClientResourceAdaptorSbbInterface xcapClientSbbInterface

xcapClientACIF

protected XCAPClientActivityContextInterfaceFactory xcapClientACIF

CONTENT_TYPE

public static final org.mobicents.slee.enabler.sip.ContentType CONTENT_TYPE

ACCEPTED_CONTENT_TYPES

public static final org.mobicents.slee.enabler.sip.ContentType[] ACCEPTED_CONTENT_TYPES

EVENT_PACKAGE

public static final String EVENT_PACKAGE

See Also:

Constant Field Values

EVENT_PARAMETERS

public static final org.mobicents.slee.enabler.sip.EventPackageParameter[] EVENT_PARAMETERS

Constructor Detail

XDMClientChildSbb

public XDMClientChildSbb()

Method Detail

getCredentialsFactory

public org.restcomm.xcap.client.auth.CredentialsFactory getCredentialsFactory()

Description copied from interface: XDMClientChild

Retrieves the factory to create request authentication credentials.

Specified by:

getCredentialsFactory in interface XDMClientChild

Returns:

delete

public void delete(URI uri,
          org.restcomm.xcap.client.auth.Credentials credentials)
            throws IOException

Description copied from interface: XDMClientChild

Deletes the content related the specified XCAP URI.

Specified by:

delete in interface XDMClientChild

Parameters:

uri - the request uri

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

Throws:

IOException

delete

public void delete(URI uri,
          String assertedUserId)
            throws IOException

Description copied from interface: XDMClientChild

Deletes the content related the specified XCAP URI.

Specified by:

delete in interface XDMClientChild

Parameters:

uri - the request uri

assertedUserId - user id already authenticated

Throws:

IOException

deleteIfMatch

public void deleteIfMatch(URI uri,
                 String eTag,
                 org.restcomm.xcap.client.auth.Credentials credentials)
                   throws IOException

Description copied from interface: XDMClientChild

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

Specified by:

deleteIfMatch in interface XDMClientChild

Parameters:

uri - the request uri

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

Throws:

IOException

deleteIfMatch

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

Description copied from interface: XDMClientChild

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

Specified by:

deleteIfMatch in interface XDMClientChild

Parameters:

uri - the request uri

assertedUserId - user id already authenticated

Throws:

IOException

deleteIfNoneMatch

public void deleteIfNoneMatch(URI uri,
                     String eTag,
                     org.restcomm.xcap.client.auth.Credentials credentials)
                       throws IOException

Description copied from interface: XDMClientChild

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

Specified by:

deleteIfNoneMatch in interface XDMClientChild

Parameters:

uri - the request uri

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

Throws:

IOException

deleteIfNoneMatch

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

Description copied from interface: XDMClientChild

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

Specified by:

deleteIfNoneMatch in interface XDMClientChild

Parameters:

uri - the request uri

assertedUserId - user id already authenticated

Throws:

IOException

get

public void get(URI uri,
       org.restcomm.xcap.client.auth.Credentials credentials)
         throws IOException

Description copied from interface: XDMClientChild

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

Specified by:

get in interface XDMClientChild

Parameters:

uri - the request uri

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

Throws:

IOException

get

public void get(URI uri,
       String assertedUserId)
         throws IOException

Description copied from interface: XDMClientChild

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

Specified by:

get in interface XDMClientChild

Parameters:

uri - the request uri

assertedUserId - user id already authenticated

Throws:

IOException

put

public void put(URI uri,
       String mimetype,
       byte[] content,
       org.restcomm.xcap.client.auth.Credentials credentials)
         throws IOException

Description copied from interface: XDMClientChild

Puts the specified content in the XCAP Server.

Specified by:

put in interface XDMClientChild

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.

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

Throws:

IOException

put

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

Description copied from interface: XDMClientChild

Puts the specified content in the XCAP Server.

Specified by:

put in interface XDMClientChild

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.

assertedUserId - user id already authenticated

Throws:

IOException

putIfMatch

public void putIfMatch(URI uri,
              String eTag,
              String mimetype,
              byte[] content,
              org.restcomm.xcap.client.auth.Credentials credentials)
                throws IOException

Description copied from interface: XDMClientChild

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

Specified by:

putIfMatch in interface XDMClientChild

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.

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

Throws:

IOException

putIfMatch

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

Description copied from interface: XDMClientChild

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

Specified by:

putIfMatch in interface XDMClientChild

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.

assertedUserId - user id already authenticated

Throws:

IOException

putIfNoneMatch

public void putIfNoneMatch(URI uri,
                  String eTag,
                  String mimetype,
                  byte[] content,
                  org.restcomm.xcap.client.auth.Credentials credentials)
                    throws IOException

Description copied from interface: XDMClientChild

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

Specified by:

putIfNoneMatch in interface XDMClientChild

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.

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

Throws:

IOException

putIfNoneMatch

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

Description copied from interface: XDMClientChild

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

Specified by:

putIfNoneMatch in interface XDMClientChild

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.

assertedUserId - user id already authenticated

Throws:

IOException

getParent

protected XDMClientParentSbbLocalObject getParent()

onDeleteResponseEvent

public void onDeleteResponseEvent(ResponseEvent event,
                         javax.slee.ActivityContextInterface aci)

Handles XCAP DELETE response events.

Parameters:

event -

aci -

onGetResponseEvent

public void onGetResponseEvent(ResponseEvent event,
                      javax.slee.ActivityContextInterface aci)

Handles XCAP GET response events.

Parameters:

event -

aci -

onPutResponseEvent

public void onPutResponseEvent(ResponseEvent event,
                      javax.slee.ActivityContextInterface aci)

Handles XCAP PUT response events.

Parameters:

event -

aci -

subscribe

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

Description copied from interface: XDMClientChild

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

Specified by:

subscribe in interface XDMClientChild

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

public void unsubscribe(String subscriber,
               String notifier)

Description copied from interface: XDMClientChild

Terminates a subscription to changes in XDMS resources.

Specified by:

unsubscribe in interface XDMClientChild

onNotify

public void onNotify(org.mobicents.slee.enabler.sip.Notify ntfy,
            org.mobicents.slee.enabler.sip.SubscriptionClientChildSbbLocalObject subscriptionChild)

Specified by:

onNotify in interface org.mobicents.slee.enabler.sip.SubscriptionClientParent

resubscribeFailed

public void resubscribeFailed(int responseCode,
                     org.mobicents.slee.enabler.sip.SubscriptionClientChildSbbLocalObject subscriptionChild)

Specified by:

resubscribeFailed in interface org.mobicents.slee.enabler.sip.SubscriptionClientParent

subscribeFailed

public void subscribeFailed(int responseCode,
                   org.mobicents.slee.enabler.sip.SubscriptionClientChildSbbLocalObject subscriptionChild)

Specified by:

subscribeFailed in interface org.mobicents.slee.enabler.sip.SubscriptionClientParent

unsubscribeFailed

public void unsubscribeFailed(int arg0,
                     org.mobicents.slee.enabler.sip.SubscriptionClientChildSbbLocalObject subscriptionChild)

Specified by:

unsubscribeFailed in interface org.mobicents.slee.enabler.sip.SubscriptionClientParent

getSubscriptionClientChildSbbChildRelation

public abstract org.mobicents.slee.ChildRelationExt getSubscriptionClientChildSbbChildRelation()

sbbActivate

public void sbbActivate()

Specified by:

sbbActivate in interface javax.slee.Sbb

sbbCreate

public void sbbCreate()
               throws javax.slee.CreateException

Specified by:

sbbCreate in interface javax.slee.Sbb

Throws:

javax.slee.CreateException

sbbExceptionThrown

public void sbbExceptionThrown(Exception arg0,
                      Object arg1,
                      javax.slee.ActivityContextInterface arg2)

Specified by:

sbbExceptionThrown in interface javax.slee.Sbb

sbbLoad

public void sbbLoad()

Specified by:

sbbLoad in interface javax.slee.Sbb

sbbPassivate

public void sbbPassivate()

Specified by:

sbbPassivate in interface javax.slee.Sbb

sbbPostCreate

public void sbbPostCreate()
                   throws javax.slee.CreateException

Specified by:

sbbPostCreate in interface javax.slee.Sbb

Throws:

javax.slee.CreateException

sbbRemove

public void sbbRemove()

Specified by:

sbbRemove in interface javax.slee.Sbb

sbbRolledBack

public void sbbRolledBack(javax.slee.RolledBackContext arg0)

Specified by:

sbbRolledBack in interface javax.slee.Sbb

sbbStore

public void sbbStore()

Specified by:

sbbStore in interface javax.slee.Sbb

setSbbContext

public void setSbbContext(javax.slee.SbbContext sbbContext)

Specified by:

setSbbContext in interface javax.slee.Sbb

unsetSbbContext

public void unsetSbbContext()

Specified by:

unsetSbbContext in interface javax.slee.Sbb