org.apache.juneau.http.RetryAfter Maven / Gradle / Ivy
// ***************************************************************************************************************************
// * 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 static org.apache.juneau.internal.StringUtils.*;
import org.apache.juneau.http.annotation.*;
import org.apache.juneau.internal.*;
/**
* 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:
*
* - {@doc RFC2616}
*
*/
@Header("Retry-After")
public final class RetryAfter extends HeaderString {
/**
* Returns a parsed Retry-After header.
*
* @param value The Retry-After header string.
* @return The parsed Retry-After header, or null if the string was null.
*/
public static RetryAfter forString(String value) {
if (value == null)
return null;
return new RetryAfter(value);
}
private RetryAfter(String value) {
super(value);
}
/**
* Returns this header value as a {@link java.util.Date} object.
*
* @return This header value as a {@link java.util.Date} object, or null if the value is not a date.
*/
public java.util.Date asDate() {
char c0 = charAt(value, 0);
if (c0 >= '0' && c0 <= '9')
return null;
return DateUtils.parseDate(toString());
}
/**
* Returns this header value as an integer.
*
* @return This header value as a integer, or -1 if the value is not an integer.
*/
public int asInt() {
char c0 = charAt(value, 0);
if (c0 >= '0' && c0 <= '9') {
try {
return Integer.parseInt(value);
} catch (NumberFormatException e) {
return -1;
}
}
return -1;
}
}