|
| |
|
| java.lang.Object
 gov.nist.core.GenericObject
gov.nist.siplite.header.Header
gov.nist.siplite.header.ParametersHeader
gov.nist.siplite.header.SubscriptionStateHeader
| SubscriptionStateHeader | | public class SubscriptionStateHeader extends ParametersHeader (Code) | | Subscription-State Header class.
RFC 3265, p. 36:
Subscription-State = "Subscription-State" HCOLON substate-value
( SEMI subexp-params )
substate-value = "active" / "pending" / "terminated"
/ extension-substate
extension-substate = token
subexp-params = ("reason" EQUAL event-reason-value)
/ ("expires" EQUAL delta-seconds)
/ ("retry-after" EQUAL delta-seconds)
/ generic-param
event-reason-value = "deactivated"
/ "probation"
/ "rejected"
/ "timeout"
/ "giveup"
/ "noresource"
/ event-reason-extension
event-reason-extension = token
|
| Method Summary | |
| public String | encodeBody()
Encode this into a cannonical String. | | public String | getExpires()
Returns the subscription expiration time in seconds. | | public String | getState()
Returns the current subscription state. | | public Object | getValue()
Returns the value of the current object, i.e., the subscription state. | | public boolean | isActive()
Checks if the current subscription state is "active". | | public boolean | isTerminated()
Checks if the current subscription state is "terminated". | | public void | setExpires(String expires)
Sets the subscription expiration time in seconds. | | public void | setExpires(int expires)
Sets the subscription expiration time in seconds. | | public void | setState(String newState)
Sets the subscription state. |
| NAME | | final public static String NAME(Code) | | SubscriptionState header field label.
|
| PARAM_EXPIRES | | final public static String PARAM_EXPIRES(Code) | | 'expires' parameter label.
|
| PARAM_REASON | | final public static String PARAM_REASON(Code) | | 'reason' parameter label.
|
| PARAM_RETRY_AFTER | | final public static String PARAM_RETRY_AFTER(Code) | | 'retry-after' parameter label.
|
| STATE_ACTIVE | | final public static String STATE_ACTIVE(Code) | | 'active' state label.
|
| STATE_PENDING | | final public static String STATE_PENDING(Code) | | 'pending' state label.
|
| STATE_TERMINATED | | final public static String STATE_TERMINATED(Code) | | 'terminated' state label.
|
| SubscriptionStateHeader | | public SubscriptionStateHeader()(Code) | | Default constructor.
|
| encodeBody | | public String encodeBody()(Code) | | Encode this into a cannonical String.
String |
| getExpires | | public String getExpires()(Code) | | Returns the subscription expiration time in seconds.
subscription expiration time. |
| getState | | public String getState()(Code) | | Returns the current subscription state.
subscription state. |
| getValue | | public Object getValue()(Code) | | Returns the value of the current object, i.e., the subscription state.
subscription state. |
| isActive | | public boolean isActive()(Code) | | Checks if the current subscription state is "active".
true if the subscription is active, false otherwise. |
| isTerminated | | public boolean isTerminated()(Code) | | Checks if the current subscription state is "terminated".
true if the subscription is terminated, false otherwise. |
|
|
|