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:

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

public final class SessionExpires
extends ParametersHeader
implements ExtensionHeader, SessionExpiresHeader

ReferredBy SIP Header.

Version:

JAIN-SIP-1.1 $Revision: 1.6 $ $Date: 2010-05-06 14:07:56 $

Author:

Peter Musgrave.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
int	expires
static String	NAME
static String	REFRESHER

Fields inherited from class gov.nist.javax.sip.header.ParametersHeader

duplicates, parameters

Fields inherited from class gov.nist.javax.sip.header.SIPHeader

headerName

Fields inherited from class gov.nist.core.GenericObject

AND, AT, COLON, COMMA, DOT, DOUBLE_QUOTE, EQUALS, GREATER_THAN, HT, immutableClasses, indentation, LESS_THAN, LPAREN, matchExpression, NEWLINE, PERCENT, POUND, QUESTION, QUOTE, RETURN, RPAREN, SEMICOLON, SLASH, SP, STAR, stringRepresentation

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

Constructors

Constructor and Description
SessionExpires() default Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected StringBuilder	encodeBody(StringBuilder retval) Encode the header content into a String.
int	getExpires() Gets the expires value of the SessionExpiresHeader.
String	getRefresher()
void	setExpires(int expires) Sets the relative expires value of the SessionExpiresHeader.
void	setRefresher(String refresher)
void	setValue(String value) Sets the value parameter of the ExtensionHeader.

Methods inherited from class gov.nist.javax.sip.header.ParametersHeader

clone, equalParameters, getMultiParameter, getMultiParameterNames, getMultiParameters, getMultiParameterValue, getNameValue, getParameter, getParameter, getParameterAsBoolean, getParameterAsFloat, getParameterAsHexInt, getParameterAsInt, getParameterAsLong, getParameterAsURI, getParameterNames, getParameters, getParameterValue, hasMultiParameter, hasMultiParameters, hasParameter, hasParameters, removeMultiParameter, removeMultiParameters, removeParameter, removeParameters, setMultiParameter, setMultiParameter, setParameter, setParameter, setParameter, setParameter, 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

dbgPrint, getClassFromName, getIndentation, getMatcher, isMySubclass, makeClone, merge, setMatcher, sprint, sprint, sprint, sprint, sprint, sprint, sprint, sprint, sprint

Methods inherited from class java.lang.Object

finalize, 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.ExtensionHeader

getValue

Methods inherited from interface javax.sip.header.Header

clone, equals, getName, hashCode, toString

Field Detail

NAME

public static final String NAME

See Also:

Constant Field Values

expires

public int expires

REFRESHER

public static final String REFRESHER

See Also:

Constant Field Values

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.

Specified by:

getExpires in interface SessionExpiresHeader

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.

Specified by:

setExpires in interface SessionExpiresHeader

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.

encodeBody

protected StringBuilder encodeBody(StringBuilder retval)

Encode the header content into a String.

Specified by:

encodeBody in class ParametersHeader

Returns:

String

getRefresher

public String getRefresher()

Specified by:

getRefresher in interface SessionExpiresHeader

setRefresher

public void setRefresher(String refresher)

Specified by:

setRefresher in interface SessionExpiresHeader