BEA WebLogic SIP Server 3.1 API Reference

com.bea.wcp.profile
Interface ProfileSubscription

public interface ProfileSubscription

This is a class returned by ProfileServiceSpi.subscribe. It is also used by callbacks invoked because of this subscription.

Copyright © 2006 BEA Systems, Inc. All Rights Reserved.

Nested Class Summary

static class

ProfileSubscription.ProfileSubscriptionState PENDING means the subscription request has been submitted, and the final state of the subscription is not yet known.

Method Summary

void	cancel() Cancel this subscription.
SipApplicationSession	getApplicationSession() The SipApplicationSession that was used to register
java.lang.String	getDocumentSelector() The document selector that was used to register
int	getExpires() Return the remaining length of this subscription, in seconds.
java.io.Serializable	getInfo() The information that was used when registering.
ProfileSubscription.ProfileSubscriptionState	getSubscriptionState() This method indicates the current state of the subscription.
void	setExpires(int seconds) Request that this subscription expires seconds seconds from now.

Method Detail

cancel

public void cancel()
            throws ProfileException

Cancel this subscription.

Throws:

ProfileException

getApplicationSession

public SipApplicationSession getApplicationSession()

The SipApplicationSession that was used to register

Returns:

the SipApplicationSession corresponding to this subscription.

getDocumentSelector

public java.lang.String getDocumentSelector()

The document selector that was used to register

Returns:

the document selector corresponding to this subscription.

getExpires

public int getExpires()

Return the remaining length of this subscription, in seconds. -1 means the subscription has no defined duration.

Returns:

The length of this subscription in seconds.

getInfo

public java.io.Serializable getInfo()

The information that was used when registering. The data may have been changed since registration.

Returns:

the document selector corresponding to this subscription.

getSubscriptionState

public ProfileSubscription.ProfileSubscriptionState getSubscriptionState()

This method indicates the current state of the subscription.

Returns:

the subscription state

setExpires

public void setExpires(int seconds)
                throws ProfileException

Request that this subscription expires seconds seconds from now. Calling this methods with zero seconds is equivalent to calling cancel().

Modifying the length of the subscription may not be possible in all cases. If it is not possible, no exception is thrown; user code interested in this case should catch SubscriptionModificationFailedException, a subclass of ProfileException.

Note also that in some implementations the update may not be instantaneous. If it is not, the application should wait for an ProfileListener.modification(ProfileSubscription) call indicating the update was successful.

Parameters:

seconds -

Throws:

ProfileException