| // *************************************************************************************************************************** |
| // * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file * |
| // * distributed with this work for additional information regarding copyright ownership. The ASF licenses this file * |
| // * to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance * |
| // * with the License. You may obtain a copy of the License at * |
| // * * |
| // * http://www.apache.org/licenses/LICENSE-2.0 * |
| // * * |
| // * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an * |
| // * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the * |
| // * specific language governing permissions and limitations under the License. * |
| // *************************************************************************************************************************** |
| package org.apache.juneau.http; |
| |
| import org.apache.juneau.http.annotation.*; |
| |
| /** |
| * Represents a parsed <l>Max-Forwards</l> HTTP request header. |
| * |
| * <p> |
| * Limit the number of times the message can be forwarded through proxies or gateways. |
| * |
| * <h5 class='figure'>Example</h5> |
| * <p class='bcode w800'> |
| * Max-Forwards: 10 |
| * </p> |
| * |
| * <h5 class='topic'>RFC2616 Specification</h5> |
| * |
| * 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. |
| * |
| * <p class='bcode w800'> |
| * Max-Forwards = "Max-Forwards" ":" 1*DIGIT |
| * </p> |
| * |
| * <p> |
| * The Max-Forwards value is a decimal integer indicating the remaining number of times this request message may be |
| * forwarded. |
| * |
| * <p> |
| * 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). |
| * |
| * <p> |
| * 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. |
| * |
| * <ul class='seealso'> |
| * <li class='extlink'>{@doc RFC2616} |
| * </ul> |
| */ |
| @Header("Max-Forwards") |
| public final class MaxForwards extends HeaderInteger { |
| |
| /** |
| * Constructor. |
| * |
| * @param value The value for this header. |
| */ |
| public MaxForwards(Integer value) { |
| super(value); |
| } |
| |
| /** |
| * Returns a parsed <c>Max-Forwards</c> header. |
| * |
| * @param value The <c>Max-Forwards</c> header string. |
| * @return The parsed <c>Max-Forwards</c> header, or <jk>null</jk> if the string was null. |
| */ |
| public static MaxForwards forString(String value) { |
| if (value == null) |
| return null; |
| return new MaxForwards(value); |
| } |
| |
| private MaxForwards(String value) { |
| super(value); |
| } |
| } |