|
JSIP API v1.2 November 2006 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface RetryAfterHeader
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)
Parameters
,
Header
Field Summary | |
---|---|
static java.lang.String |
NAME
Name of RetryAfterHeader |
Method Summary | |
---|---|
java.lang.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(java.lang.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 |
---|
static final java.lang.String NAME
Method Detail |
---|
void setRetryAfter(int retryAfter) throws InvalidArgumentException
retryAfter
- - the new retry after value of this RetryAfterHeader
InvalidArgumentException
- if supplied value is less than zero.int getRetryAfter()
java.lang.String getComment()
void setComment(java.lang.String comment) throws java.text.ParseException
comment
- - the new comment string value of the RetryAfterHeader.
java.text.ParseException
- which signals that an error has been reached
unexpectedly while parsing the comment.void setDuration(int duration) throws InvalidArgumentException
duration
- - the new duration value of this RetryAfterHeader
InvalidArgumentException
- if supplied value is less than zero.int getDuration()
|
JSIP API v1.2 November 2006 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |