gov.nist.javax.sip.header
クラス SubscriptionState

java.lang.Object
  gov.nist.core.GenericObject
      gov.nist.javax.sip.header.SIPObject
          gov.nist.javax.sip.header.SIPHeader
              gov.nist.javax.sip.header.ParametersHeader
                  gov.nist.javax.sip.header.SubscriptionState

すべての実装されたインタフェース:

SIPHeaderNames, java.io.Serializable, java.lang.Cloneable, javax.sip.header.Header, javax.sip.header.Parameters, javax.sip.header.SubscriptionStateHeader

public class SubscriptionState
extends ParametersHeader
implements javax.sip.header.SubscriptionStateHeader

SubscriptionState header

バージョン:

JAIN-SIP-1.1 $Revision: 1.2 $ $Date: 2004/01/22 13:26:29 $

作成者:

Olivier Deruelle
This code is in the public domain.

関連項目:

直列化された形式

フィールドの概要

インタフェース javax.sip.header.SubscriptionStateHeader から継承されたフィールド

ACTIVE, DEACTIVATED, GIVE_UP, NAME, NO_RESOURCE, PENDING, PROBATION, REJECTED, TERMINATED, TIMEOUT, UNKNOWN

インタフェース 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, MAX_FORWARDS, MIME_VERSION, MIN_EXPIRES, ORGANIZATION, PRIORITY, PROXY_AUTHENTICATE, PROXY_AUTHORIZATION, PROXY_REQUIRE, RACK, REASON, RECORD_ROUTE, REPLY_TO, REQUIRE, RETRY_AFTER, ROUTE, RSEQ, SERVER, SUBJECT, SUBSCRIPTION_STATE, SUPPORTED, TIMESTAMP, TO, UNSUPPORTED, USER_AGENT, VIA, WARNING, WWW_AUTHENTICATE

コンストラクタの概要

SubscriptionState()
Creates a new instance of SubscriptionState

メソッドの概要

java.lang.String	encodeBody() Just the encoded body of the header.
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.

クラス gov.nist.javax.sip.header.ParametersHeader から継承されたメソッド

getNameValue, getParameter, getParameterNames, getParameters, getParameterValue, hasParameter, hasParameters, removeParameter, removeParameters, setParameter, setParameter, setParameters, setQuotedParameter

クラス gov.nist.javax.sip.header.SIPHeader から継承されたメソッド

encode, getHeaderName, getHeaderValue, getName, getValue, isHeaderList, setHeaderName

クラス gov.nist.javax.sip.header.SIPObject から継承されたメソッド

clone, dbgPrint, debugDump, debugDump, equals, match, merge, replace, replace, replace, replace, toString

クラス gov.nist.core.GenericObject から継承されたメソッド

getClassFromName, getMatcher, isMySubclass, setMatcher

クラス java.lang.Object から継承されたメソッド

getClass, hashCode, notify, notifyAll, wait, wait, wait

インタフェース javax.sip.header.Parameters から継承されたメソッド

getParameter, getParameterNames, removeParameter, setParameter

インタフェース javax.sip.header.Header から継承されたメソッド

clone, equals, getName, toString

コンストラクタの詳細

SubscriptionState

public SubscriptionState()

Creates a new instance of SubscriptionState

メソッドの詳細

setExpires

public void setExpires(int expires)
                throws javax.sip.InvalidArgumentException

Sets the relative expires value of the SubscriptionStateHeader. The expires value MUST be greater than zero and MUST be less than 2**31.

定義:

インタフェース javax.sip.header.SubscriptionStateHeader 内の setExpires

パラメータ:

expires - - the new expires value of this SubscriptionStateHeader.

例外:

javax.sip.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.

定義:

インタフェース javax.sip.header.SubscriptionStateHeader 内の getExpires

戻り値:

the expires value of the SubscriptionStateHeader.

setRetryAfter

public void setRetryAfter(int retryAfter)
                   throws javax.sip.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.

定義:

インタフェース javax.sip.header.SubscriptionStateHeader 内の setRetryAfter

パラメータ:

retryAfter - - the new retry after value of this SubscriptionStateHeader

例外:

javax.sip.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.

定義:

インタフェース javax.sip.header.SubscriptionStateHeader 内の getRetryAfter

戻り値:

the retry after value of the SubscriptionStateHeader.

getReasonCode

public java.lang.String getReasonCode()

Gets the reason code of SubscriptionStateHeader.

定義:

インタフェース javax.sip.header.SubscriptionStateHeader 内の getReasonCode

戻り値:

the comment of this SubscriptionStateHeader, return null if no reason code is available.

setReasonCode

public void setReasonCode(java.lang.String reasonCode)
                   throws java.text.ParseException

Sets the reason code value of the SubscriptionStateHeader.

定義:

インタフェース javax.sip.header.SubscriptionStateHeader 内の setReasonCode

パラメータ:

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.

getState

public java.lang.String getState()

Gets the state of SubscriptionStateHeader.

定義:

インタフェース javax.sip.header.SubscriptionStateHeader 内の getState

戻り値:

the state of this SubscriptionStateHeader.

setState

public void setState(java.lang.String state)
              throws java.text.ParseException

Sets the state value of the SubscriptionStateHeader.

定義:

インタフェース javax.sip.header.SubscriptionStateHeader 内の setState

パラメータ:

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.

encodeBody

public java.lang.String encodeBody()

Just the encoded body of the header.

戻り値:

the string encoded header body.