|
Oracle Communications Converged Application Server Java API Reference 5.0 E18767-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ProfileSubscription
This is a class returned by ProfileServiceSpi.subscribe
. It is also used by callbacks invoked because of this subscription.
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 |
---|
ProfileSubscription.ProfileSubscriptionState getSubscriptionState()
SipApplicationSession getApplicationSession()
java.lang.String getDocumentSelector()
java.io.Serializable getInfo()
void cancel() throws ProfileException
ProfileException
int getExpires()
void setExpires(int seconds) throws ProfileException
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.
seconds
-ProfileException
|
Oracle Communications Converged Application Server Java API Reference 5.0 E18767-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |