NIST-SIP: The Reference Implementation for JAIN-SIP 1.2

gov.nist.javax.sip.header
Class SubscriptionState

java.lang.Object
  extended by gov.nist.core.GenericObject
      extended by gov.nist.javax.sip.header.SIPObject
          extended by gov.nist.javax.sip.header.SIPHeader
              extended by gov.nist.javax.sip.header.ParametersHeader
                  extended by gov.nist.javax.sip.header.SubscriptionState
All Implemented Interfaces:
HeaderExt, SIPHeaderNames, Serializable, Cloneable, Header, Parameters, SubscriptionStateHeader

public class SubscriptionState
extends ParametersHeader
implements SubscriptionStateHeader

SubscriptionState header

Version:
1.2 $Revision: 1.7 $ $Date: 2009/07/17 18:57:39 $
Author:
Olivier Deruelle
See Also:
Serialized Form

Field Summary
 
Fields inherited from interface javax.sip.header.SubscriptionStateHeader
ACTIVE, DEACTIVATED, GIVE_UP, NAME, NO_RESOURCE, PENDING, PROBATION, REJECTED, TERMINATED, TIMEOUT, UNKNOWN
 
Fields inherited from interface gov.nist.javax.sip.header.SIPHeaderNames
ACCEPT, ACCEPT_ENCODING, ACCEPT_LANGUAGE, ALERT_INFO, ALLOW, ALLOW_EVENTS, AUTHENTICATION_INFO, AUTHORIZATION, CALL_ID, CALL_INFO, CONTACT, CONTENT_DISPOSITION, CONTENT_ENCODING, CONTENT_LANGUAGE, CONTENT_LENGTH, CONTENT_TYPE, CSEQ, DATE, ERROR_INFO, EVENT, EXPIRES, FROM, IN_REPLY_TO, JOIN, MAX_FORWARDS, MIME_VERSION, MIN_EXPIRES, MIN_SE, ORGANIZATION, PRIORITY, PROXY_AUTHENTICATE, PROXY_AUTHORIZATION, PROXY_REQUIRE, RACK, REASON, RECORD_ROUTE, REFERRED_BY, REPLACES, REPLY_TO, REQUIRE, RETRY_AFTER, ROUTE, RSEQ, SERVER, SESSION_EXPIRES, SIP_ETAG, SIP_IF_MATCH, SUBJECT, SUBSCRIPTION_STATE, SUPPORTED, TIMESTAMP, TO, UNSUPPORTED, USER_AGENT, VIA, WARNING, WWW_AUTHENTICATE
 
Constructor Summary
SubscriptionState()
          Creates a new instance of SubscriptionState
 
Method Summary
 String encodeBody()
          Just the encoded body of the header.
 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 class gov.nist.javax.sip.header.ParametersHeader
clone, getNameValue, getParameter, getParameterNames, getParameters, getParameterValue, hasParameter, hasParameters, removeParameter, removeParameters, setParameter, setParameter, setParameters, setQuotedParameter
 
Methods inherited from class gov.nist.javax.sip.header.SIPHeader
encode, encode, getHeaderName, getHeaderValue, getName, getValue, hashCode, isHeaderList, setHeaderName, toString
 
Methods inherited from class gov.nist.javax.sip.header.SIPObject
dbgPrint, debugDump, debugDump, equals, match
 
Methods inherited from class gov.nist.core.GenericObject
getClassFromName, getMatcher, isMySubclass, makeClone, merge, setMatcher
 
Methods inherited from class java.lang.Object
equals, getClass, notify, notifyAll, wait, wait, wait
 
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
 

Constructor Detail

SubscriptionState

public SubscriptionState()
Creates a new instance of SubscriptionState

Method Detail

setExpires

public void setExpires(int expires)
                throws InvalidArgumentException
Sets the relative expires value of the SubscriptionStateHeader. The expires value MUST be greater than zero and MUST be less than 2**31.

Specified by:
setExpires in interface SubscriptionStateHeader
Parameters:
expires - - the new expires value of this SubscriptionStateHeader.
Throws:
InvalidArgumentException - if supplied value is less than zero.

getExpires

public int getExpires()
Gets the expires value of the SubscriptionStateHeader. This expires value is relative time.

Specified by:
getExpires in interface SubscriptionStateHeader
Returns:
the expires value of the SubscriptionStateHeader.

setRetryAfter

public void setRetryAfter(int retryAfter)
                   throws InvalidArgumentException
Sets the retry after value of the SubscriptionStateHeader. The retry after value MUST be greater than zero and MUST be less than 2**31.

Specified by:
setRetryAfter in interface SubscriptionStateHeader
Parameters:
retryAfter - - the new retry after value of this SubscriptionStateHeader
Throws:
InvalidArgumentException - if supplied value is less than zero.

getRetryAfter

public int getRetryAfter()
Gets the retry after value of the SubscriptionStateHeader. This retry after value is relative time.

Specified by:
getRetryAfter in interface SubscriptionStateHeader
Returns:
the retry after value of the SubscriptionStateHeader.

getReasonCode

public String getReasonCode()
Gets the reason code of SubscriptionStateHeader.

Specified by:
getReasonCode in interface SubscriptionStateHeader
Returns:
the comment of this SubscriptionStateHeader, return null if no reason code is available.

setReasonCode

public void setReasonCode(String reasonCode)
                   throws ParseException
Sets the reason code value of the SubscriptionStateHeader.

Specified by:
setReasonCode in interface SubscriptionStateHeader
Parameters:
reasonCode - - the new reason code string value of the SubscriptionStateHeader.
Throws:
ParseException - which signals that an error has been reached unexpectedly while parsing the reason code.

getState

public String getState()
Gets the state of SubscriptionStateHeader.

Specified by:
getState in interface SubscriptionStateHeader
Returns:
the state of this SubscriptionStateHeader.

setState

public void setState(String state)
              throws ParseException
Sets the state value of the SubscriptionStateHeader.

Specified by:
setState in interface SubscriptionStateHeader
Parameters:
state - - the new state string value of the SubscriptionStateHeader.
Throws:
ParseException - which signals that an error has been reached unexpectedly while parsing the state.

encodeBody

public String encodeBody()
Just the encoded body of the header.

Returns:
the string encoded header body.

NIST-SIP: The Reference Implementation for JAIN-SIP 1.2

A product of the NIST/ITL Advanced Networking Technologies Division.
See conditions of use.
Submit a bug report or feature request.