javax.sip.header

Interface RetryAfterHeader

All Superinterfaces:

Cloneable, Header, Parameters, Serializable

All Known Implementing Classes:

RetryAfter

public interface RetryAfterHeader
extends Header, Parameters

The Retry-After header field identifies the time to retry the request after recipt of the response. It can be used with a 500 (Server Internal Error) or 503 (Service Unavailable) response to indicate how long the service is expected to be unavailable to the requesting client and with a 404 (Not Found), 413 (Request Entity Too Large), 480 (Temporarily Unavailable), 486 (Busy Here), 600 (Busy), or 603 (Decline) response to indicate when the called party anticipates being available again. The value of this field is a positive integer number of seconds (in decimal) after the time of the response.

An optional comment can be used to indicate additional information about the time of callback. An optional "duration" parameter indicates how long the called party will be reachable starting at the initial time of availability. If no duration parameter is given, the service is assumed to be available indefinitely.

For Examples:
Retry-After: 18000;duration=3600
Retry-After: 120 (I'm in a meeting)

Version:

1.2

Author:

BEA Systems, NIST

See Also:

Parameters, Header

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME Name of RetryAfterHeader

Method Summary

Methods

Modifier and Type	Method and Description
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.
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 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

static final String NAME

Name of RetryAfterHeader

See Also:

Constant Field Values

Method Detail

setRetryAfter

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.

Parameters:

retryAfter - - the new retry after value of this RetryAfterHeader

Throws:

InvalidArgumentException - if supplied value is less than zero.

getRetryAfter

int getRetryAfter()

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

Returns:

the retry after value of the RetryAfterHeader.

getComment

String getComment()

Gets the comment of RetryAfterHeader.

Returns:

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

setComment

void setComment(String comment)
                throws ParseException

Sets the comment value of the 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

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.

Parameters:

duration - - the new duration value of this RetryAfterHeader

Throws:

InvalidArgumentException - if supplied value is less than zero.

getDuration

int getDuration()

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

Returns:

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