|
JSIP API v1.2 November 2006 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface SubscriptionStateHeader
This interface represents the Subscription State header, as defined by RFC3265, this header is not part of RFC3261.
NOTIFY requests MUST contain SubscriptionState headers which indicate the status of the subscription. The subscription states are:
Field Summary | |
---|---|
static java.lang.String |
ACTIVE
State: The subscription has been accepted and (in general) has been authorized. |
static java.lang.String |
DEACTIVATED
Reason Code: The subscription has been terminated, but the subscriber SHOULD retry immediately with a new subscription. |
static java.lang.String |
GIVE_UP
Reason Code: The subscription has been terminated because the notifier could not obtain authorization in a timely fashion. |
static java.lang.String |
NAME
Name of SubscriptionStateHeader |
static java.lang.String |
NO_RESOURCE
Reason Code: The subscription has been terminated because the resource state which was being monitored no longer exists. |
static java.lang.String |
PENDING
State: The subscription has been received by the notifier, but there is insufficient policy information to grant or deny the subscription yet. |
static java.lang.String |
PROBATION
Reason Code: The subscription has been terminated, but the client SHOULD retry at some later time. |
static java.lang.String |
REJECTED
Reason Code: The subscription has been terminated due to change in authorization policy. |
static java.lang.String |
TERMINATED
State: The subscription has been terminated, if a reason code is present, the client should behave as described in the reason code. |
static java.lang.String |
TIMEOUT
Reason Code: The subscription has been terminated because it was not refreshed before it expired. |
static java.lang.String |
UNKNOWN
Reason Code: The reason why the subscription was terminated is Unknown. |
Method Summary | |
---|---|
int |
getExpires()
Gets the expires value of the SubscriptionStateHeader. |
java.lang.String |
getReasonCode()
Gets the reason code of SubscriptionStateHeader. |
int |
getRetryAfter()
Gets the retry after value of the SubscriptionStateHeader. |
java.lang.String |
getState()
Gets the state of SubscriptionStateHeader. |
void |
setExpires(int expires)
Sets the relative expires value of the SubscriptionStateHeader. |
void |
setReasonCode(java.lang.String reasonCode)
Sets the reason code value of the SubscriptionStateHeader. |
void |
setRetryAfter(int retryAfter)
Sets the retry after value of the SubscriptionStateHeader. |
void |
setState(java.lang.String state)
Sets the state value of the SubscriptionStateHeader. |
Methods inherited from interface javax.sip.header.Parameters |
---|
getParameter, getParameterNames, removeParameter, setParameter |
Methods inherited from interface javax.sip.header.Header |
---|
clone, equals, getName, hashCode, toString |
Field Detail |
---|
static final java.lang.String NAME
static final java.lang.String UNKNOWN
static final java.lang.String DEACTIVATED
static final java.lang.String PROBATION
static final java.lang.String REJECTED
static final java.lang.String TIMEOUT
static final java.lang.String GIVE_UP
static final java.lang.String NO_RESOURCE
static final java.lang.String ACTIVE
static final java.lang.String TERMINATED
static final java.lang.String PENDING
Method Detail |
---|
void setExpires(int expires) throws InvalidArgumentException
expires
- - the new expires value of this SubscriptionStateHeader.
InvalidArgumentException
- if supplied value is less than zero.int getExpires()
void setRetryAfter(int retryAfter) throws InvalidArgumentException
retryAfter
- - the new retry after value of this SubscriptionStateHeader
InvalidArgumentException
- if supplied value is less than zero.int getRetryAfter()
java.lang.String getReasonCode()
void setReasonCode(java.lang.String reasonCode) throws java.text.ParseException
reasonCode
- - the new reason code string value of the SubscriptionStateHeader.
java.text.ParseException
- which signals that an error has been reached
unexpectedly while parsing the reason code.java.lang.String getState()
void setState(java.lang.String state) throws java.text.ParseException
state
- - the new state string value of the SubscriptionStateHeader.
java.text.ParseException
- which signals that an error has been reached
unexpectedly while parsing the state.
|
JSIP API v1.2 November 2006 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |