org.openstreetmap.josm.tools

Class HttpClient

java.lang.Object

org.openstreetmap.josm.tools.HttpClient

public final class HttpClient
extends java.lang.Object

Provides a uniform access for a HTTP/HTTPS server. This class should be used in favour of HttpURLConnection.

Since:

9168

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HttpClient.Response A wrapper for the HTTP response.

Field Summary

Fields

Modifier and Type	Field and Description
private java.net.HttpURLConnection	connection
private int	connectTimeout
private java.util.Map<java.lang.String,java.lang.String>	headers
private long	ifModifiedSince
private int	maxRedirects
private int	readTimeout
private java.lang.String	reasonForRequest
private byte[]	requestBody
private java.lang.String	requestMethod
private HttpClient.Response	response
private java.net.URL	url
private boolean	useCache

Constructor Summary

Constructors

Modifier	Constructor and Description
private	HttpClient(java.net.URL url, java.lang.String requestMethod)

Method Summary

Modifier and Type	Method and Description
HttpClient.Response	connect() Opens the HTTP connection.
HttpClient.Response	connect(ProgressMonitor progressMonitor) Opens the HTTP connection.
static HttpClient	create(java.net.URL url) Creates a new instance for the given URL and a GET request
static HttpClient	create(java.net.URL url, java.lang.String requestMethod) Creates a new instance for the given URL and a GET request
void	disconnect()
private static void	disconnect(java.net.HttpURLConnection connection)
java.lang.String	getRequestHeader(java.lang.String header) Returns the set value for the given header.
java.lang.String	getRequestMethod() Returns the request method set for this connection.
HttpClient.Response	getResponse() Returns the HTTP response which is set only after calling connect().
java.net.URL	getURL() Returns the URL set for this connection.
private static boolean	isRedirect(int statusCode)
HttpClient	keepAlive(boolean keepAlive) Sets whether not to set header Connection=close
HttpClient	setAccept(java.lang.String accept) Sets the Accept header.
HttpClient	setConnectTimeout(int connectTimeout) Sets a specified timeout value, in milliseconds, to be used when opening a communications link to the resource referenced by this URLConnection.
HttpClient	setHeader(java.lang.String key, java.lang.String value) Sets an arbitrary HTTP header.
HttpClient	setHeaders(java.util.Map<java.lang.String,java.lang.String> headers) Sets arbitrary HTTP headers.
HttpClient	setIfModifiedSince(long ifModifiedSince) Sets the If-Modified-Since header.
HttpClient	setMaxRedirects(int maxRedirects) Sets the maximum number of redirections to follow.
HttpClient	setReadTimeout(int readTimeout) Sets the read timeout to a specified timeout, in milliseconds.
HttpClient	setReasonForRequest(java.lang.String reasonForRequest) Sets a reason to show on console.
HttpClient	setRequestBody(byte[] requestBody) Sets the request body for PUT/POST requests.
HttpClient	useCache(boolean useCache) Sets whether not to set header Cache-Control=no-cache

Methods inherited from class java.lang.Object

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

Field Detail

url

private java.net.URL url

requestMethod

private final java.lang.String requestMethod

connectTimeout

private int connectTimeout

readTimeout

private int readTimeout

requestBody

private byte[] requestBody

ifModifiedSince

private long ifModifiedSince

headers

private final java.util.Map<java.lang.String,java.lang.String> headers

maxRedirects

private int maxRedirects

useCache

private boolean useCache

reasonForRequest

private java.lang.String reasonForRequest

connection

private java.net.HttpURLConnection connection

response

private HttpClient.Response response

Constructor Detail

HttpClient

private HttpClient(java.net.URL url,
                   java.lang.String requestMethod)

Method Detail

connect

public HttpClient.Response connect()
                            throws java.io.IOException

Opens the HTTP connection.

Returns:

HTTP response

Throws:

java.io.IOException - if any I/O error occurs

connect

public HttpClient.Response connect(ProgressMonitor progressMonitor)
                            throws java.io.IOException

Opens the HTTP connection.

Parameters:

progressMonitor - progress monitor

Returns:

HTTP response

Throws:

java.io.IOException - if any I/O error occurs

Since:

9179

getResponse

public HttpClient.Response getResponse()

Returns the HTTP response which is set only after calling connect(). Calling this method again, returns the identical object (unless another connect() is performed).

Returns:

the HTTP response

Since:

9309

create

public static HttpClient create(java.net.URL url)

Creates a new instance for the given URL and a GET request

Parameters:

url - the URL

Returns:

a new instance

create

public static HttpClient create(java.net.URL url,
                                java.lang.String requestMethod)

Creates a new instance for the given URL and a GET request

Parameters:

url - the URL

requestMethod - the HTTP request method to perform when calling

Returns:

a new instance

getURL

public java.net.URL getURL()

Returns the URL set for this connection.

Returns:

the URL

Since:

9172

See Also:

create(URL), create(URL, String)

getRequestMethod

public java.lang.String getRequestMethod()

Returns the request method set for this connection.

Returns:

the HTTP request method

Since:

9172

See Also:

create(URL, String)

getRequestHeader

public java.lang.String getRequestHeader(java.lang.String header)

Returns the set value for the given header.

Parameters:

header - HTTP header name

Returns:

HTTP header value

Since:

9172

useCache

public HttpClient useCache(boolean useCache)

Sets whether not to set header Cache-Control=no-cache

Parameters:

useCache - whether not to set header Cache-Control=no-cache

Returns:

this

See Also:

URLConnection.setUseCaches(boolean)

keepAlive

public HttpClient keepAlive(boolean keepAlive)

Sets whether not to set header Connection=close

This might fix #7640, see here.

Parameters:

keepAlive - whether not to set header Connection=close

Returns:

this

setConnectTimeout

public HttpClient setConnectTimeout(int connectTimeout)

Sets a specified timeout value, in milliseconds, to be used when opening a communications link to the resource referenced by this URLConnection. If the timeout expires before the connection can be established, a SocketTimeoutException is raised. A timeout of zero is interpreted as an infinite timeout.

Parameters:

connectTimeout - an int that specifies the connect timeout value in milliseconds

Returns:

this

See Also:

URLConnection.setConnectTimeout(int)

setReadTimeout

public HttpClient setReadTimeout(int readTimeout)

Sets the read timeout to a specified timeout, in milliseconds. A non-zero value specifies the timeout when reading from input stream when a connection is established to a resource. If the timeout expires before there is data available for read, a SocketTimeoutException is raised. A timeout of zero is interpreted as an infinite timeout.

Parameters:

readTimeout - an int that specifies the read timeout value in milliseconds

Returns:

this

See Also:

URLConnection.setReadTimeout(int)

setAccept

public HttpClient setAccept(java.lang.String accept)

Sets the Accept header.

Parameters:

accept - header value

Returns:

this

setRequestBody

public HttpClient setRequestBody(byte[] requestBody)

Sets the request body for PUT/POST requests.

Parameters:

requestBody - request body

Returns:

this

setIfModifiedSince

public HttpClient setIfModifiedSince(long ifModifiedSince)

Sets the If-Modified-Since header.

Parameters:

ifModifiedSince - header value

Returns:

this

setMaxRedirects

public HttpClient setMaxRedirects(int maxRedirects)

Sets the maximum number of redirections to follow. Set maxRedirects to -1 in order to ignore redirects, i.e., to not throw an IOException in connect().

Parameters:

maxRedirects - header value

Returns:

this

setHeader

public HttpClient setHeader(java.lang.String key,
                            java.lang.String value)

Sets an arbitrary HTTP header.

Parameters:

key - header name

value - header value

Returns:

this

setHeaders

public HttpClient setHeaders(java.util.Map<java.lang.String,java.lang.String> headers)

Sets arbitrary HTTP headers.

Parameters:

headers - HTTP headers

Returns:

this

setReasonForRequest

public HttpClient setReasonForRequest(java.lang.String reasonForRequest)

Sets a reason to show on console. Can be null if no reason is given.

Parameters:

reasonForRequest - Reason to show

Returns:

this

Since:

9172

isRedirect

private static boolean isRedirect(int statusCode)

disconnect

public void disconnect()

Since:

9309

See Also:

HttpURLConnection.disconnect()

disconnect

private static void disconnect(java.net.HttpURLConnection connection)