org.apache.juneau.http

Class RetryAfter

java.lang.Object

org.apache.juneau.http.HeaderString

org.apache.juneau.http.RetryAfter

public final class RetryAfter
extends HeaderString

Represents a parsed Retry-After HTTP response header.

If an entity is temporarily unavailable, this instructs the client to try again later. Value could be a specified period of time (in seconds) or a HTTP-date.

Example

Retry-After: 120 Retry-After: Fri, 07 Nov 2014 23:59:59 GMT

RFC2616 Specification

The Retry-After response-header field can be used with a 503 (Service Unavailable) response to indicate how long the service is expected to be unavailable to the requesting client. This field MAY also be used with any 3xx (Redirection) response to indicate the minimum time the user-agent is asked wait before issuing the redirected request. The value of this field can be either an HTTP-date or an integer number of seconds (in decimal) after the time of the response.

Retry-After = "Retry-After" ":" ( HTTP-date | delta-seconds )

Two examples of its use are

Retry-After: Fri, 31 Dec 1999 23:59:59 GMT Retry-After: 120

In the latter example, the delay is 2 minutes.

See Also:

• Hypertext Transfer Protocol -- HTTP/1.1

Method Summary

Modifier and Type	Method and Description
Date	asDate() Returns this header value as a Date object.
int	asInt() Returns this header value as an integer.
static RetryAfter	forString(String value) Returns a parsed Retry-After header.

Methods inherited from class org.apache.juneau.http.HeaderString

asString, eq, eqIC, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

forString

public static RetryAfter forString(String value)

Returns a parsed Retry-After header.

Parameters:

value - The Retry-After header string.

Returns:

The parsed Retry-After header, or null if the string was null.

asDate

public Date asDate()

Returns this header value as a Date object.

Returns:

This header value as a Date object, or null if the value is not a date.

asInt

public int asInt()

Returns this header value as an integer.

Returns:

This header value as a integer, or -1 if the value is not an integer.