Package org.apache.juneau.http.header

Class RetryAfter

java.lang.Object

org.apache.juneau.http.header.HttpHeaderBean

org.apache.juneau.http.header.RetryAfter

All Implemented Interfaces:

HttpHeader

public class RetryAfter
extends HttpHeaderBean

Represents an HTTP Retry-After header.

Delay before retrying, as a delta-seconds integer or an HTTP-date.

See Also:

• Next-Generation REST Client

Since:

9.2.1

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME	The header name

Constructor Summary

Constructors

Constructor	Description
RetryAfter(Integer value)	Constructor with delay seconds.
RetryAfter(String value)	Constructor with a wire string (integer or HTTP-date).
RetryAfter(ZonedDateTime value)	Constructor with an HTTP-date.
RetryAfter(Supplier<?> valueSupplier)	Constructor with a lazy supplier of Integer or ZonedDateTime.

Method Summary

Modifier and Type	Method	Description
Optional<Integer>	asInteger()
Optional<ZonedDateTime>	asZonedDateTime()
String	getValue()	Returns the header value, or null if the header has no value.
static RetryAfter	of(Integer value)
static RetryAfter	of(String value)
static RetryAfter	of(ZonedDateTime value)
static RetryAfter	of(Supplier<?> valueSupplier)

Methods inherited from class org.apache.juneau.http.header.HttpHeaderBean

equals, equalsIgnoreCase, getName, hashCode, of, of, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

NAME

public static final String NAME

The header name

See Also:

• Constant Field Values

Constructor Details

RetryAfter

public RetryAfter(Integer value)

Constructor with delay seconds.

Parameters:

value - Seconds to wait. May be null.

RetryAfter

public RetryAfter(String value)

Constructor with a wire string (integer or HTTP-date).

Parameters:

value - The header value. May be null.

RetryAfter

public RetryAfter(Supplier<?> valueSupplier)

Constructor with a lazy supplier of Integer or ZonedDateTime.

Parameters:

valueSupplier - Supplier for the value. Must not be null.

RetryAfter

public RetryAfter(ZonedDateTime value)

Constructor with an HTTP-date.

Parameters:

value - The retry time. May be null.

Method Details

asInteger

public Optional<Integer> asInteger()

Returns:

The value as seconds when encoded as a delta-seconds integer.

asZonedDateTime

public Optional<ZonedDateTime> asZonedDateTime()

Returns:

The value as ZonedDateTime when encoded as an HTTP-date.

getValue

public String getValue()

Description copied from interface: HttpHeader

Returns the header value, or null if the header has no value.

Specified by:

getValue in interface HttpHeader

Overrides:

getValue in class HttpHeaderBean

Returns:

The header value, possibly null.

of

public static RetryAfter of(Integer value)

Parameters:

value - Delay seconds. May be null, in which case null is returned.

Returns:

A new instance, or null if value is null.

of

public static RetryAfter of(String value)

Parameters:

value - Wire string. May be null, in which case null is returned.

Returns:

A new instance, or null if value is null.

of

public static RetryAfter of(Supplier<?> valueSupplier)

Parameters:

valueSupplier - Supplier of Integer or ZonedDateTime. Must not be null.

Returns:

A new instance. Never null.

of

public static RetryAfter of(ZonedDateTime value)

Parameters:

value - HTTP-date. May be null, in which case null is returned.

Returns:

A new instance, or null if value is null.