org.apache.juneau.http

Class MaxForwards

java.lang.Object

org.apache.juneau.http.HeaderInteger

org.apache.juneau.http.MaxForwards

public final class MaxForwards
extends HeaderInteger

Represents a parsed Max-Forwards HTTP request header.

Limit the number of times the message can be forwarded through proxies or gateways.

Example

Max-Forwards: 10

RFC2616 Specification

The Max-Forwards request-header field provides a mechanism with the TRACE (section 9.8) and OPTIONS (section 9.2) methods to limit the number of proxies or gateways that can forward the request to the next inbound server. This can be useful when the client is attempting to trace a request chain which appears to be failing or looping in mid-chain.

Max-Forwards = "Max-Forwards" ":" 1*DIGIT

The Max-Forwards value is a decimal integer indicating the remaining number of times this request message may be forwarded.

Each proxy or gateway recipient of a TRACE or OPTIONS request containing a Max-Forwards header field MUST check and update its value prior to forwarding the request. If the received value is zero (0), the recipient MUST NOT forward the request; instead, it MUST respond as the final recipient. If the received Max-Forwards value is greater than zero, then the forwarded message MUST contain an updated Max-Forwards field with a value decremented by one (1).

The Max-Forwards header field MAY be ignored for all other methods defined by this specification and for any extension methods for which it is not explicitly referred to as part of that method definition.

See Also:

• Hypertext Transfer Protocol -- HTTP/1.1

Method Summary

Modifier and Type	Method and Description
static MaxForwards	forString(String value) Returns a parsed Max-Forwards header.

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

asInt, toString

Methods inherited from class java.lang.Object

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

Method Detail

forString

public static MaxForwards forString(String value)

Returns a parsed Max-Forwards header.

Parameters:

value - The Max-Forwards header string.

Returns:

The parsed Max-Forwards header, or null if the string was null.