org.mobicents.slee.enabler.sip

Class SubscriptionData

java.lang.Object

org.mobicents.slee.enabler.sip.SubscriptionData

All Implemented Interfaces:

Externalizable, Serializable

public class SubscriptionData
extends Object
implements Externalizable

Static information needed to create a SIP subscription. Example of usage: SubscriptionData subscriptionData = new SubscriptionData().setSubscriberURI(subscriber ).setNotifierURI(notifier).setEventPackage (EVENT_PACKAGE).setExpires(expires). setAcceptedContentTypes(ACCEPTED_CONTENT_TYPES ).setEventParameters(EVENT_PARAMETERS);

Author:

martins

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SubscriptionData()

Method Summary

Methods

Modifier and Type	Method and Description
ContentType[]	getAcceptedContentTypes() Retrieves the optional content types, which should be accepted by the enabler.
String	getEventPackage() Retrieves the subscription's event package, for instance "presence".
EventPackageParameter[]	getEventParameters() Retrieves the optional subscription event parameters, for instance in xcap-diff event package there is a parameter named diff-processing which can indicate what kind of content/detail should be included in notifications.
int	getExpires() Retrieves the period between subscription refreshes.
String	getNotifierURI() Retrieves the notifier's URI, i.e., the URI identifying the resource being subscribed.
String	getSubscriberDisplayName() Retrieves the subscriber's display name.
String	getSubscriberURI() Retrieves the subscriber's URI, i.e, the entity requesting the subscription.
boolean	isSupportResourceLists() Indicates if the subscription should support resource lists as the notifier.
void	readExternal(ObjectInput in)
SubscriptionData	setAcceptedContentTypes(ContentType[] acceptedContentTypes) Sets the optional content types, which should be accepted by the enabler.
SubscriptionData	setEventPackage(String eventPackage) Sets the subscription's event package, for instance "presence".
SubscriptionData	setEventParameters(EventPackageParameter[] eventParameters) Sets the optional subscription event parameters, for instance in xcap-diff event package there is a parameter named diff-processing which can indicate what kind of content/detail should be included in notifications.
SubscriptionData	setExpires(int expires) Sets the period between subscription refreshes.
SubscriptionData	setNotifierURI(String notifierURI) Sets the notifier's URI, i.e., the URI identifying the resource being subscribed.
SubscriptionData	setSubscriberDisplayName(String subscriberDisplayName) Sets the subscriber's display name.
SubscriptionData	setSubscriberURI(String subscriberURI) Sets the subscriber's URI, i.e, the entity requesting the subscription.
SubscriptionData	setSupportResourceLists(boolean supportResourceLists) Defines if the subscription should support resource lists as the notifier.
void	writeExternal(ObjectOutput out)

Methods inherited from class java.lang.Object

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

Constructor Detail

SubscriptionData

public SubscriptionData()

Method Detail

getSubscriberURI

public String getSubscriberURI()

Retrieves the subscriber's URI, i.e, the entity requesting the subscription.

setSubscriberURI

public SubscriptionData setSubscriberURI(String subscriberURI)

Sets the subscriber's URI, i.e, the entity requesting the subscription.

Parameters:

subscriberURI -

Returns:

getSubscriberDisplayName

public String getSubscriberDisplayName()

Retrieves the subscriber's display name. This information is optional.

Returns:

setSubscriberDisplayName

public SubscriptionData setSubscriberDisplayName(String subscriberDisplayName)

Sets the subscriber's display name. This information is optional.

Parameters:

subscriberDisplayName -

Returns:

getNotifierURI

public String getNotifierURI()

Retrieves the notifier's URI, i.e., the URI identifying the resource being subscribed.

Returns:

setNotifierURI

public SubscriptionData setNotifierURI(String notifierURI)

Sets the notifier's URI, i.e., the URI identifying the resource being subscribed.

Parameters:

notifierURI -

Returns:

getEventPackage

public String getEventPackage()

Retrieves the subscription's event package, for instance "presence".

Returns:

setEventPackage

public SubscriptionData setEventPackage(String eventPackage)

Sets the subscription's event package, for instance "presence".

Parameters:

eventPackage -

Returns:

getEventParameters

public EventPackageParameter[] getEventParameters()

Retrieves the optional subscription event parameters, for instance in xcap-diff event package there is a parameter named diff-processing which can indicate what kind of content/detail should be included in notifications.

Returns:

setEventParameters

public SubscriptionData setEventParameters(EventPackageParameter[] eventParameters)

Sets the optional subscription event parameters, for instance in xcap-diff event package there is a parameter named diff-processing which can indicate what kind of content/detail should be included in notifications.

Parameters:

eventParameters -

Returns:

getAcceptedContentTypes

public ContentType[] getAcceptedContentTypes()

Retrieves the optional content types, which should be accepted by the enabler.

Returns:

setAcceptedContentTypes

public SubscriptionData setAcceptedContentTypes(ContentType[] acceptedContentTypes)

Sets the optional content types, which should be accepted by the enabler.

Parameters:

acceptedContentTypes -

Returns:

isSupportResourceLists

public boolean isSupportResourceLists()

Indicates if the subscription should support resource lists as the notifier. If true the enabler includes all the mandatory accepted content types (rlmi and multipart) related with RLS notifications, it also includes the mandatory Supported header.

Returns:

setSupportResourceLists

public SubscriptionData setSupportResourceLists(boolean supportResourceLists)

Defines if the subscription should support resource lists as the notifier. If true the enabler includes all the mandatory accepted content types (rlmi and multipart) related with RLS notifications, it also includes the mandatory Supported header.

Parameters:

supportResourceLists -

Returns:

getExpires

public int getExpires()

Retrieves the period between subscription refreshes.

Returns:

setExpires

public SubscriptionData setExpires(int expires)

Sets the period between subscription refreshes.

Parameters:

expires -

Returns:

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException