HttpSupport (JGit - Parent 5.7.0.202003090808-r API)

java.lang.Object
- org.eclipse.jgit.util.HttpSupport

```
public class HttpSupport
extends Object
```
Extra utilities to support usage of HTTP.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ENCODING_GZIP` The `gzip` encoding value for `HDR_ACCEPT_ENCODING`.
`static String`	`ENCODING_X_GZIP` The `x-gzip` encoding value for `HDR_ACCEPT_ENCODING`.
`static String`	`HDR_ACCEPT` The `Accept` header.
`static String`	`HDR_ACCEPT_ENCODING` The `Accept-Encoding` header.
`static String`	`HDR_ACCEPT_RANGES` The `Accept-Ranges` header.
`static String`	`HDR_AUTHORIZATION` The `Authorization` header.
`static String`	`HDR_CACHE_CONTROL` The `Cache-Control` header.
`static String`	`HDR_CONTENT_ENCODING` The `Content-Encoding` header.
`static String`	`HDR_CONTENT_LENGTH` The `Content-Length` header.
`static String`	`HDR_CONTENT_RANGE` The `Content-Range` header.
`static String`	`HDR_CONTENT_TYPE` The `Content-Type` header.
`static String`	`HDR_COOKIE` The `Cookie` header.
`static String`	`HDR_DATE` The `Date` header.
`static String`	`HDR_ETAG` The `ETag` header.
`static String`	`HDR_EXPIRES` The `Expires` header.
`static String`	`HDR_IF_MODIFIED_SINCE` The `If-Modified-Since` header.
`static String`	`HDR_IF_NONE_MATCH` The `If-None-Match` header.
`static String`	`HDR_IF_RANGE` The `If-Range` header.
`static String`	`HDR_LAST_MODIFIED` The `Last-Modified` header.
`static String`	`HDR_LOCATION` The `Location` header.
`static String`	`HDR_PRAGMA` The `Pragma` header.
`static String`	`HDR_RANGE` The `Range` header.
`static String`	`HDR_SERVER` The `Server` header.
`static String`	`HDR_SET_COOKIE` The `Set-Cookie` header.
`static String`	`HDR_SET_COOKIE2` The `Set-Cookie2` header.
`static String`	`HDR_USER_AGENT` The `User-Agent` header.
`static String`	`HDR_WWW_AUTHENTICATE` The `WWW-Authenticate` header.
`static String`	`METHOD_GET` The `GET` HTTP method.
`static String`	`METHOD_HEAD` The `HEAD` HTTP method.
`static String`	`METHOD_POST` The `POST` HTTP method.
`static String`	`METHOD_PUT` The `POST` HTTP method.
`static String`	`TEXT_PLAIN` The standard `text/plain` MIME type.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`configureTLS(SSLSocket socket)` Enables all supported TLS protocol versions on the socket given.
`static void`	`disableSslVerify(HttpConnection conn)` Disable SSL and hostname verification for given HTTP connection
`static void`	`encode(StringBuilder urlstr, String key)` URL encode a value string into an output buffer.
`static Proxy`	`proxyFor(ProxySelector proxySelector, URL u)` Determine the proxy server (if any) needed to obtain a URL.
`static int`	`response(HttpConnection c)` Get the HTTP response code from the request.
`static int`	`response(HttpURLConnection c)` Get the HTTP response code from the request.
`static String`	`responseHeader(HttpConnection c, String headerName)` Extract a HTTP header from the response.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail
- METHOD_GET
```
public static final String METHOD_GET
```
  The GET HTTP method.
  
  See Also:
  
  Constant Field Values
- METHOD_HEAD
```
public static final String METHOD_HEAD
```
  The HEAD HTTP method.
  
  Since:
  
  4.3
  
  See Also:
  
  Constant Field Values
- METHOD_PUT
```
public static final String METHOD_PUT
```
  The POST HTTP method.
  
  Since:
  
  4.3
  
  See Also:
  
  Constant Field Values
- METHOD_POST
```
public static final String METHOD_POST
```
  The POST HTTP method.
  
  See Also:
  
  Constant Field Values
- HDR_CACHE_CONTROL
```
public static final String HDR_CACHE_CONTROL
```
  The Cache-Control header.
  
  See Also:
  
  Constant Field Values
- HDR_PRAGMA
```
public static final String HDR_PRAGMA
```
  The Pragma header.
  
  See Also:
  
  Constant Field Values
- HDR_USER_AGENT
```
public static final String HDR_USER_AGENT
```
  The User-Agent header.
  
  See Also:
  
  Constant Field Values
- HDR_SERVER
```
public static final String HDR_SERVER
```
  The Server header.
  
  Since:
  
  4.0
  
  See Also:
  
  Constant Field Values
- HDR_DATE
```
public static final String HDR_DATE
```
  The Date header.
  
  See Also:
  
  Constant Field Values
- HDR_EXPIRES
```
public static final String HDR_EXPIRES
```
  The Expires header.
  
  See Also:
  
  Constant Field Values
- HDR_ETAG
```
public static final String HDR_ETAG
```
  The ETag header.
  
  See Also:
  
  Constant Field Values
- HDR_IF_NONE_MATCH
```
public static final String HDR_IF_NONE_MATCH
```
  The If-None-Match header.
  
  See Also:
  
  Constant Field Values
- HDR_LAST_MODIFIED
```
public static final String HDR_LAST_MODIFIED
```
  The Last-Modified header.
  
  See Also:
  
  Constant Field Values
- HDR_IF_MODIFIED_SINCE
```
public static final String HDR_IF_MODIFIED_SINCE
```
  The If-Modified-Since header.
  
  See Also:
  
  Constant Field Values
- HDR_ACCEPT
```
public static final String HDR_ACCEPT
```
  The Accept header.
  
  See Also:
  
  Constant Field Values
- HDR_CONTENT_TYPE
```
public static final String HDR_CONTENT_TYPE
```
  The Content-Type header.
  
  See Also:
  
  Constant Field Values
- HDR_CONTENT_LENGTH
```
public static final String HDR_CONTENT_LENGTH
```
  The Content-Length header.
  
  See Also:
  
  Constant Field Values
- HDR_CONTENT_ENCODING
```
public static final String HDR_CONTENT_ENCODING
```
  The Content-Encoding header.
  
  See Also:
  
  Constant Field Values
- HDR_CONTENT_RANGE
```
public static final String HDR_CONTENT_RANGE
```
  The Content-Range header.
  
  See Also:
  
  Constant Field Values
- HDR_ACCEPT_RANGES
```
public static final String HDR_ACCEPT_RANGES
```
  The Accept-Ranges header.
  
  See Also:
  
  Constant Field Values
- HDR_IF_RANGE
```
public static final String HDR_IF_RANGE
```
  The If-Range header.
  
  See Also:
  
  Constant Field Values
- HDR_RANGE
```
public static final String HDR_RANGE
```
  The Range header.
  
  See Also:
  
  Constant Field Values
- HDR_ACCEPT_ENCODING
```
public static final String HDR_ACCEPT_ENCODING
```
  The Accept-Encoding header.
  
  See Also:
  
  Constant Field Values
- HDR_LOCATION
```
public static final String HDR_LOCATION
```
  The Location header.
  
  Since:
  
  4.7
  
  See Also:
  
  Constant Field Values
- ENCODING_GZIP
```
public static final String ENCODING_GZIP
```
  The gzip encoding value for HDR_ACCEPT_ENCODING.
  
  See Also:
  
  Constant Field Values
- ENCODING_X_GZIP
```
public static final String ENCODING_X_GZIP
```
  The x-gzip encoding value for HDR_ACCEPT_ENCODING.
  
  Since:
  
  4.6
  
  See Also:
  
  Constant Field Values
- TEXT_PLAIN
```
public static final String TEXT_PLAIN
```
  The standard text/plain MIME type.
  
  See Also:
  
  Constant Field Values
- HDR_AUTHORIZATION
```
public static final String HDR_AUTHORIZATION
```
  The Authorization header.
  
  See Also:
  
  Constant Field Values
- HDR_WWW_AUTHENTICATE
```
public static final String HDR_WWW_AUTHENTICATE
```
  The WWW-Authenticate header.
  
  See Also:
  
  Constant Field Values
- HDR_COOKIE
```
public static final String HDR_COOKIE
```
  The Cookie header.
  
  Since:
  
  5.4
  
  See Also:
  
  Constant Field Values
- HDR_SET_COOKIE
```
public static final String HDR_SET_COOKIE
```
  The Set-Cookie header.
  
  Since:
  
  5.4
  
  See Also:
  
  Constant Field Values
- HDR_SET_COOKIE2
```
public static final String HDR_SET_COOKIE2
```
  The Set-Cookie2 header.
  
  Since:
  
  5.4
  
  See Also:
  
  Constant Field Values

Method Detail

encode
```
public static void encode(StringBuilder urlstr,
                          String key)
```
URL encode a value string into an output buffer.

Parameters:

urlstr - the output buffer.

key - value which must be encoded to protected special characters.

response
```
public static int response(HttpConnection c)
                    throws IOException
```
Get the HTTP response code from the request.
Roughly the same as c.getResponseCode() but the ConnectException is translated to be more understandable.

Parameters:

c - connection the code should be obtained from.

Returns:

r HTTP status code, usually 200 to indicate success. See HttpConnection for other defined constants.

Throws:

IOException - communications error prevented obtaining the response code.

Since:

3.3

response
```
public static int response(HttpURLConnection c)
                    throws IOException
```
Get the HTTP response code from the request.
Roughly the same as c.getResponseCode() but the ConnectException is translated to be more understandable.

Parameters:

c - connection the code should be obtained from.

Returns:

r HTTP status code, usually 200 to indicate success. See HttpConnection for other defined constants.

Throws:

IOException - communications error prevented obtaining the response code.

responseHeader
```
public static String responseHeader(HttpConnection c,
                                    String headerName)
                             throws IOException
```
Extract a HTTP header from the response.

Parameters:

c - connection the header should be obtained from.

headerName - the header name

Returns:

the header value

Throws:

IOException - communications error prevented obtaining the header.

Since:

4.7

proxyFor
```
public static Proxy proxyFor(ProxySelector proxySelector,
                             URL u)
                      throws ConnectException
```
Determine the proxy server (if any) needed to obtain a URL.

Parameters:

proxySelector - proxy support for the caller.

u - location of the server caller wants to talk to.

Returns:

proxy to communicate with the supplied URL.

Throws:

ConnectException - the proxy could not be computed as the supplied URL could not be read. This failure should never occur.

disableSslVerify
```
public static void disableSslVerify(HttpConnection conn)
                             throws IOException
```
Disable SSL and hostname verification for given HTTP connection

Parameters:

conn - a HttpConnection object.

Throws:

IOException

Since:

4.3

configureTLS

public static void configureTLS(SSLSocket socket)

Enables all supported TLS protocol versions on the socket given. If system property "https.protocols" is set, only protocols specified there are enabled.

This is primarily a mechanism to deal with using TLS on IBM JDK. IBM JDK returns sockets that support all TLS protocol versions but have only the one specified in the context enabled. Oracle or OpenJDK return sockets that have all available protocols enabled already, up to the one specified.

SSLContext.getInstance()	OpenJDK	IDM JDK
"TLS"	Supported: TLSv1, TLSV1.1, TLSv1.2 (+ TLSv1.3) Enabled: TLSv1, TLSV1.1, TLSv1.2 (+ TLSv1.3)	Supported: TLSv1, TLSV1.1, TLSv1.2 Enabled: TLSv1
"TLSv1.2"	Supported: TLSv1, TLSV1.1, TLSv1.2 Enabled: TLSv1, TLSV1.1, TLSv1.2	Supported: TLSv1, TLSV1.1, TLSv1.2 Enabled: TLSv1.2

Parameters:: socket - to configure
Since:: 5.7
See Also:: Behavior of SSLContext.getInstance("TLS") on IBM JDK, Customizing JSSE about https.protocols

Class HttpSupport

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

METHOD_GET

METHOD_HEAD

METHOD_PUT

METHOD_POST

HDR_CACHE_CONTROL

HDR_PRAGMA

HDR_USER_AGENT

HDR_SERVER

HDR_DATE

HDR_EXPIRES

HDR_ETAG

HDR_IF_NONE_MATCH

HDR_LAST_MODIFIED

HDR_IF_MODIFIED_SINCE

HDR_ACCEPT

HDR_CONTENT_TYPE

HDR_CONTENT_LENGTH

HDR_CONTENT_ENCODING

HDR_CONTENT_RANGE

HDR_ACCEPT_RANGES

HDR_IF_RANGE

HDR_RANGE

HDR_ACCEPT_ENCODING

HDR_LOCATION

ENCODING_GZIP

ENCODING_X_GZIP

TEXT_PLAIN

HDR_AUTHORIZATION

HDR_WWW_AUTHENTICATE

HDR_COOKIE

HDR_SET_COOKIE

HDR_SET_COOKIE2

Method Detail

encode

response

response

responseHeader

proxyFor

disableSslVerify

configureTLS