gov.nist.javax.sip.header

Class RetryAfter

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.RetryAfter

All Implemented Interfaces:

HeaderExt, ParametersExt, SIPHeaderNames, Serializable, Cloneable, Header, Parameters, RetryAfterHeader

public class RetryAfter
extends ParametersHeader
implements RetryAfterHeader

Retry-After SIP Header.

Version:

1.2 $Revision: 1.10 $ $Date: 2010-05-06 14:07:47 $

Author:

M. Ranganathan
, Olivier Deruelle

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected String	comment comment field
static String	DURATION constant DURATION parameter.
protected Integer	retryAfter duration field

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

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, 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
RetryAfter() Default constructor

Method Summary

Methods

Modifier and Type	Method and Description
StringBuilder	encodeBody(StringBuilder retval) Encode body of this into cannonical form.
String	getComment() Gets the comment of RetryAfterHeader.
int	getDuration() Gets the duration value of the RetryAfterHeader.
int	getRetryAfter() Gets the retry after value of the RetryAfterHeader.
boolean	hasComment() Boolean function
void	removeComment() remove comment field
void	removeDuration() remove duration field
void	setComment(String comment) Sets the comment value of the RetryAfterHeader.
void	setDuration(int duration) Sets the duration value of the RetryAfterHeader.
void	setRetryAfter(int retryAfter) Sets the retry after value of the RetryAfterHeader.

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

equals, finalize, getClass, notify, notifyAll, wait, wait, wait

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

DURATION

public static final String DURATION

constant DURATION parameter.

See Also:

Constant Field Values

retryAfter

protected Integer retryAfter

duration field

comment

protected String comment

comment field

Constructor Detail

RetryAfter

public RetryAfter()

Default constructor

Method Detail

encodeBody

public StringBuilder encodeBody(StringBuilder retval)

Encode body of this into cannonical form.

Specified by:

encodeBody in class ParametersHeader

Returns:

encoded body

hasComment

public boolean hasComment()

Boolean function

Returns:

true if comment exist, false otherwise

removeComment

public void removeComment()

remove comment field

removeDuration

public void removeDuration()

remove duration field

setRetryAfter

public void setRetryAfter(int retryAfter)
                   throws InvalidArgumentException

Sets the retry after value of the RetryAfterHeader. The retry after value MUST be greater than zero and MUST be less than 2**31.

Specified by:

setRetryAfter in interface RetryAfterHeader

Parameters:

retryAfter - - the new retry after value of this RetryAfterHeader

Throws:

InvalidArgumentException - if supplied value is less than zero.

getRetryAfter

public int getRetryAfter()

Gets the retry after value of the RetryAfterHeader. This retry after value is relative time.

Specified by:

getRetryAfter in interface RetryAfterHeader

Returns:

the retry after value of the RetryAfterHeader.

getComment

public String getComment()

Gets the comment of RetryAfterHeader.

Specified by:

getComment in interface RetryAfterHeader

Returns:

the comment of this RetryAfterHeader, return null if no comment is available.

setComment

public void setComment(String comment)
                throws ParseException

Sets the comment value of the RetryAfterHeader.

Specified by:

setComment in interface RetryAfterHeader

Parameters:

comment - - the new comment string value of the RetryAfterHeader.

Throws:

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

setDuration

public void setDuration(int duration)
                 throws InvalidArgumentException

Sets the duration value of the RetryAfterHeader. The retry after value MUST be greater than zero and MUST be less than 2**31.

Specified by:

setDuration in interface RetryAfterHeader

Parameters:

duration - - the new duration value of this RetryAfterHeader

Throws:

InvalidArgumentException - if supplied value is less than zero.

getDuration

public int getDuration()

Gets the duration value of the RetryAfterHeader. This duration value is relative time.

Specified by:

getDuration in interface RetryAfterHeader

Returns:

the duration value of the RetryAfterHeader, return zero if not set.