|
NIST SIP Parser and Stack (v1.2) API | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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 String |
ACTIVE
State: The subscription has been accepted and (in general) has been authorized. |
static String |
DEACTIVATED
Reason Code: The subscription has been terminated, but the subscriber SHOULD retry immediately with a new subscription. |
static String |
GIVE_UP
Reason Code: The subscription has been terminated because the notifier could not obtain authorization in a timely fashion. |
static String |
NAME
Name of SubscriptionStateHeader |
static String |
NO_RESOURCE
Reason Code: The subscription has been terminated because the resource state which was being monitored no longer exists. |
static 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 String |
PROBATION
Reason Code: The subscription has been terminated, but the client SHOULD retry at some later time. |
static String |
REJECTED
Reason Code: The subscription has been terminated due to change in authorization policy. |
static 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 String |
TIMEOUT
Reason Code: The subscription has been terminated because it was not refreshed before it expired. |
static String |
UNKNOWN
Reason Code: The reason why the subscription was terminated is Unknown. |
Method Summary | |
int |
getExpires()
Gets the expires value of the SubscriptionStateHeader. |
String |
getReasonCode()
Gets the reason code of SubscriptionStateHeader. |
int |
getRetryAfter()
Gets the retry after value of the SubscriptionStateHeader. |
String |
getState()
Gets the state of SubscriptionStateHeader. |
void |
setExpires(int expires)
Sets the relative expires value of the SubscriptionStateHeader. |
void |
setReasonCode(String reasonCode)
Sets the reason code value of the SubscriptionStateHeader. |
void |
setRetryAfter(int retryAfter)
Sets the retry after value of the SubscriptionStateHeader. |
void |
setState(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, toString |
Field Detail |
public static final String NAME
public static final String UNKNOWN
public static final String DEACTIVATED
public static final String PROBATION
public static final String REJECTED
public static final String TIMEOUT
public static final String GIVE_UP
public static final String NO_RESOURCE
public static final String ACTIVE
public static final String TERMINATED
public static final String PENDING
Method Detail |
public void setExpires(int expires) throws InvalidArgumentException
expires
- - the new expires value of this SubscriptionStateHeader.
InvalidArgumentException
- if supplied value is less than zero.public int getExpires()
public void setRetryAfter(int retryAfter) throws InvalidArgumentException
retryAfter
- - the new retry after value of this SubscriptionStateHeader
InvalidArgumentException
- if supplied value is less than zero.public int getRetryAfter()
public String getReasonCode()
public void setReasonCode(String reasonCode) throws ParseException
reasonCode
- - the new reason code string value of the SubscriptionStateHeader.
ParseException
- which signals that an error has been reached
unexpectedly while parsing the reason code.public String getState()
public void setState(String state) throws ParseException
state
- - the new state string value of the SubscriptionStateHeader.
ParseException
- which signals that an error has been reached
unexpectedly while parsing the state.
|
NIST SIP Parser and Stack (v1.2) API | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |