gov.nist.javax.sip.header.extensions
Class SessionExpires

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.extensions.SessionExpires

All Implemented Interfaces:

Cloneable, ExtensionHeader, Header, Parameters, Serializable, SessionExpiresHeader, SIPHeaderNames

public final class SessionExpires

extends ParametersHeader

implements ExtensionHeader, SessionExpiresHeader

ReferredBy SIP Header.

Version:

JAIN-SIP-1.1 $Revision: 1.2 $ $Date: 2006/10/27 20:58:31 $

Author:

Peter Musgrave.

See Also:

Serialized Form

Field Summary

int	expires
static String	NAME

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, 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

SessionExpires()
default Constructor.

Method Summary

int	getExpires() Gets the expires value of the SessionExpiresHeader.
void	setExpires(int expires) Sets the relative expires value of the SessionExpiresHeader.
void	setValue(String value) Sets the value parameter of the ExtensionHeader.

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, 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

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface javax.sip.header.ExtensionHeader

getValue

Methods inherited from interface javax.sip.header.Header

clone, equals, getName, hashCode, toString

Methods inherited from interface javax.sip.header.Parameters

getParameter, getParameterNames, removeParameter, setParameter

Field Detail

NAME

public static final String NAME

See Also:

Constant Field Values

expires

public int expires

Constructor Detail

SessionExpires

public SessionExpires()

default Constructor.

Method Detail

getExpires

public int getExpires()

Gets the expires value of the SessionExpiresHeader. This expires value is relative time.

Returns:

the expires value of the ExpiresHeader.

Since:

JAIN SIP v1.1

setExpires

public void setExpires(int expires)
                throws InvalidArgumentException

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

Parameters:

expires - - the new expires value

Throws:

InvalidArgumentException - if supplied value is less than zero.

Since:

JAIN SIP v1.1

setValue

public void setValue(String value)
              throws ParseException

Description copied from interface: ExtensionHeader

Sets the value parameter of the ExtensionHeader.

Specified by:

setValue in interface ExtensionHeader

Parameters:

value - - the new value of the ExtensionHeader

Throws:

ParseException - which signals that an error has been reached unexpectedly while parsing the value parameter.