org.apache.juneau.http.Connection 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;
/**
* Represents a parsed Connection HTTP request header.
*
*
* Control options for the current connection and list of hop-by-hop request fields.
*
*
Example
*
* Connection: keep-alive
* Connection: Upgrade
*
*
* RFC2616 Specification
*
* The Connection general-header field allows the sender to specify options that are desired for that particular
* connection and MUST NOT be communicated by proxies over further connections.
*
*
* The Connection header has the following grammar:
*
* Connection = "Connection" ":" 1#(connection-token)
* connection-token = token
*
*
*
* HTTP/1.1 proxies MUST parse the Connection header field before a message is forwarded and, for each connection-token
* in this field, remove any header field(s) from the message with the same name as the connection-token.
* Connection options are signaled by the presence of a connection-token in the Connection header field, not by any
* corresponding additional header field(s), since the additional header field may not be sent if there are no
* parameters associated with that connection option.
*
*
* Message headers listed in the Connection header MUST NOT include end-to-end headers, such as Cache-Control.
*
*
* HTTP/1.1 defines the "close" connection option for the sender to signal that the connection will be closed after
* completion of the response.
* For example...
*
* Connection: close
*
*
* ...in either the request or the response header fields indicates that the connection SHOULD NOT be considered
* `persistent' (section 8.1) after the current request/response is complete.
*
*
* HTTP/1.1 applications that do not support persistent connections MUST include the "close" connection option in
* every message.
*
*
* A system receiving an HTTP/1.0 (or lower-version) message that includes a Connection header MUST, for each
* connection-token in this field, remove and ignore any header field(s) from the message with the same name as the
* connection-token.
* This protects against mistaken forwarding of such header fields by pre-HTTP/1.1 proxies.
* See section 19.6.2.
*
*
Additional Information
*
*/
public final class Connection extends HeaderString {
/**
* Returns a parsed Connection header.
*
* @param value The Connection header string.
* @return The parsed Connection header, or null if the string was null.
*/
public static Connection forString(String value) {
if (value == null)
return null;
return new Connection(value);
}
private Connection(String value) {
super(value);
}
/**
* Returns true if the header value is close.
*
* @return true if the header value is close.
*/
public boolean isClose() {
return eqIC("close");
}
/**
* Returns true if the header value is keep-alive.
*
* @return true if the header value is keep-alive.
*/
public boolean isKeepAlive() {
return eqIC("keep-alive");
}
/**
* Returns true if the header value is upgrade.
*
* @return true if the header value is upgrade.
*/
public boolean isUpgrade() {
return eqIC("upgrade");
}
}