java.net.httpclient

Class HttpRequest.Builder

java.lang.Object

java.net.httpclient.HttpRequest.Builder

Enclosing class:

HttpRequest

public abstract static class HttpRequest.Builder
extends java.lang.Object

A builder of HttpRequests. HttpRequest.Builders are created by calling HttpRequest.create(URI) or HttpClient.request(URI).

Each of the setter methods in this class modifies the state of the builder and returns this (ie. the same instance). The methods are not synchronized and should not be called from multiple threads without external synchronization.

The build methods return a new HttpRequest each time they are called.

Since:

1.9

Method Summary

Modifier and Type	Method and Description
abstract HttpRequest.Builder	body(HttpRequest.BodyProcessor reqproc) Sets a request body for this builder.
abstract HttpRequest.Builder	copy() Returns an exact duplicate copy of this Builder based on current state.
abstract HttpRequest.Builder	expectContinue(boolean enable) Request server to acknowledge request before sending request body.
abstract HttpRequest.Builder	followRedirects(HttpClient.Redirect policy) Specifies whether this request will automatically follow redirects issued by the server.
abstract HttpRequest	GET() Builds and returns a GET HttpRequest from this builder.
abstract HttpRequest.Builder	header(java.lang.String name, java.lang.String value) Adds the given name value pair to the set of headers for this request.
abstract HttpRequest.Builder	headers(java.lang.String... headers) Adds the given name value pairs to the set of headers for this request.
abstract HttpRequest	method(java.lang.String method) Builds and returns a HttpRequest from this builder using the given method String.
abstract HttpRequest	POST() Builds and returns a POST HttpRequest from this builder.
abstract HttpRequest.Builder	proxy(java.net.ProxySelector proxy) Overrides the ProxySelector set on the request's client for this request.
abstract HttpRequest	PUT() Builds and returns a PUT HttpRequest from this builder.
abstract HttpRequest.Builder	setHeader(java.lang.String name, java.lang.String value) Sets the given name value pair to the set of headers for this request.
abstract HttpRequest.Builder	timeout(java.util.concurrent.TimeUnit unit, long timeval) Sets a timeout for this request.
abstract HttpRequest.Builder	uri(java.net.URI uri) Sets this HttpRequest's request URI.
abstract HttpRequest.Builder	version(HttpClient.Version version) Overrides the HttpClient.version() setting for this request.

Methods inherited from class java.lang.Object

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

Method Detail

uri

public abstract HttpRequest.Builder uri(java.net.URI uri)

Sets this HttpRequest's request URI.

Parameters:

uri - the request URI

Returns:

this request builder

followRedirects

public abstract HttpRequest.Builder followRedirects(HttpClient.Redirect policy)

Specifies whether this request will automatically follow redirects issued by the server. The default value for this setting is the value of HttpClient.followRedirects()

Parameters:

policy - the redirection policy

Returns:

this request builder

expectContinue

public abstract HttpRequest.Builder expectContinue(boolean enable)

Request server to acknowledge request before sending request body. This is disabled by default. If enabled, the server is requested to send an error response or a 100-Continue response before the client sends the request body. This means the request processor for the request will not be invoked until this interim response is received.

Parameters:

enable - true if Expect continue to be sent

Returns:

this request builder

version

public abstract HttpRequest.Builder version(HttpClient.Version version)

Overrides the HttpClient.version() setting for this request.

Parameters:

version - the HTTP protocol version requested

Returns:

this request builder

header

public abstract HttpRequest.Builder header(java.lang.String name,
                                           java.lang.String value)

Adds the given name value pair to the set of headers for this request.

Parameters:

name - the header name

value - the header value

Returns:

this request builder

proxy

public abstract HttpRequest.Builder proxy(java.net.ProxySelector proxy)

Overrides the ProxySelector set on the request's client for this request.

Parameters:

proxy - the ProxySelector to use

Returns:

this request builder

headers

public abstract HttpRequest.Builder headers(java.lang.String... headers)

Adds the given name value pairs to the set of headers for this request. The supplied Strings must alternate as names and values.

Parameters:

headers - the list of String name value pairs

Returns:

this request builder

Throws:

java.lang.IllegalArgumentException - if there isn't an even number of parameters

timeout

public abstract HttpRequest.Builder timeout(java.util.concurrent.TimeUnit unit,
                                            long timeval)

Sets a timeout for this request. If the response is not received within the specified timeout then a HttpTimeoutException is thrown from HttpRequest.response() or HttpRequest.responseAsync() completes exceptionally with a HttpTimeoutException.

Parameters:

unit - the timeout units

timeval - the number of units to wait for

Returns:

this request builder

setHeader

public abstract HttpRequest.Builder setHeader(java.lang.String name,
                                              java.lang.String value)

Sets the given name value pair to the set of headers for this request. This overwrites any previously set values for name.

Parameters:

name - the header name

value - the header value

Returns:

this request builder

body

public abstract HttpRequest.Builder body(HttpRequest.BodyProcessor reqproc)

Sets a request body for this builder. See HttpRequest for example BodyProcessor implementations. If no body is specified, then no body is sent with the request.

Parameters:

reqproc - the request body processor

Returns:

this request builder

GET

public abstract HttpRequest GET()

Builds and returns a GET HttpRequest from this builder.

Returns:

a HttpRequest

POST

public abstract HttpRequest POST()

Builds and returns a POST HttpRequest from this builder.

Returns:

a HttpRequest

PUT

public abstract HttpRequest PUT()

Builds and returns a PUT HttpRequest from this builder.

Returns:

a HttpRequest

method

public abstract HttpRequest method(java.lang.String method)

Builds and returns a HttpRequest from this builder using the given method String. The method string is case-sensitive, and may be rejected if an upper-case string is not used.

Parameters:

method - the method to use

Returns:

a HttpRequest

Throws:

java.lang.IllegalArgumentException - if an unrecognised method is used

copy

public abstract HttpRequest.Builder copy()

Returns an exact duplicate copy of this Builder based on current state. The new builder can then be modified independently of this builder.

Returns:

an exact copy of this Builder