OpenJDK 27 · jdk.internal.net.http.HttpRequestBuilderImpl

Modifier and Type	Field and Description
private HttpRequest.BodyPublisher	bodyPublisher
private Duration	duration
private boolean	expectContinue
private HttpHeadersBuilder	headersBuilder
private String	method
private final Map<HttpOption<?>, Object>	options
private static final Set<HttpOption<?>>	supportedOptions
private URI	uri
private volatile Optional<HttpClient.Version>	version

Access	Constructor and Description
public	HttpRequestBuilderImpl(URI uri)
public	HttpRequestBuilderImpl()

Method Summary

Modifier and Type	Method and Description
pack-priv HttpRequest.BodyPublisher	bodyPublisher()
public HttpRequest	build() Implements java.net.http.HttpRequest.Builder.build. Builds and returns an `HttpRequest`.
public HttpRequestImpl	buildForWebSocket()
private void	checkNameAndValue(String name, String value)
pack-priv static void	checkURI(URI uri)
public HttpRequestBuilderImpl	copy() Implements java.net.http.HttpRequest.Builder.copy. Returns an exact duplicate copy of this `Builder` based on current state.
public static Map<HttpOption<?>, Object>	copySupportedOptions(HttpRequest request)
public static Map<HttpOption<?>, Object>	copySupportedOptions(Map<HttpOption<?>, Object> options)
public HttpRequest.Builder	DELETE() Implements java.net.http.HttpRequest.Builder.DELETE. Sets the request method of this builder to DELETE.
public HttpRequestBuilderImpl	expectContinue(boolean enable) Implements java.net.http.HttpRequest.Builder.expectContinue. Requests the server to acknowledge the request before sending the body.
pack-priv boolean	expectContinue()
public HttpRequest.Builder	GET() Implements java.net.http.HttpRequest.Builder.GET. Sets the request method of this builder to GET.
public HttpRequest.Builder	HEAD() Overrides default java.net.http.HttpRequest.Builder.HEAD. Sets the request method of this builder to HEAD.
public HttpRequestBuilderImpl	header(String name, String value) Implements java.net.http.HttpRequest.Builder.header. Adds the given name value pair to the set of headers for this request.
public HttpRequestBuilderImpl	headers(String... params) Implements java.net.http.HttpRequest.Builder.headers. Adds the given name value pairs to the set of headers for this request.
pack-priv HttpHeadersBuilder	headersBuilder()
pack-priv String	method()
public HttpRequest.Builder	method(String method, HttpRequest.BodyPublisher body) Implements java.net.http.HttpRequest.Builder.method. Sets the request method and request body of this builder to the given values.
private HttpRequest.Builder	method0(String method, HttpRequest.BodyPublisher body)
pack-priv Map<HttpOption<?>, Object>	options()
public HttpRequest.Builder	POST(HttpRequest.BodyPublisher body) Implements java.net.http.HttpRequest.Builder.POST. Sets the request method of this builder to POST and sets its request body publisher to the given value.
public HttpRequest.Builder	PUT(HttpRequest.BodyPublisher body) Implements java.net.http.HttpRequest.Builder.PUT. Sets the request method of this builder to PUT and sets its request body publisher to the given value.
public HttpRequestBuilderImpl	setHeader(String name, String value) Implements java.net.http.HttpRequest.Builder.setHeader. Sets the given name value pair to the set of headers for this request.
public <T> HttpRequest.Builder	setOption(HttpOption<T> option, T value) Overrides default java.net.http.HttpRequest.Builder.setOption. Provides request configuration option hints modeled as key value pairs to help an `HttpClient` implementation decide how the request/response exchange should be established or carried out.
public HttpRequest.Builder	timeout(Duration duration) Implements java.net.http.HttpRequest.Builder.timeout. Sets a timeout for this request.
pack-priv Duration	timeout()
public HttpRequestBuilderImpl	uri(URI uri) Implements java.net.http.HttpRequest.Builder.uri. Sets this `HttpRequest`'s request `URI`.
pack-priv URI	uri()
public HttpRequestBuilderImpl	version(HttpClient.Version version) Implements java.net.http.HttpRequest.Builder.version. Sets the preferred `HttpClient.Version` for this request.
pack-priv Optional<HttpClient.Version>	version()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

bodyPublisher	back to summary
private HttpRequest.BodyPublisher bodyPublisher

duration	back to summary
private Duration duration

expectContinue	back to summary
private boolean expectContinue

headersBuilder	back to summary
private HttpHeadersBuilder headersBuilder

method	back to summary
private String method

options	back to summary
private final Map<HttpOption<?>, Object> options

supportedOptions	back to summary
private static final Set<HttpOption<?>> supportedOptions

uri	back to summary
private URI uri

version	back to summary
private volatile Optional<HttpClient.Version> version

HttpRequestBuilderImpl	back to summary
public HttpRequestBuilderImpl(URI uri)

HttpRequestBuilderImpl	back to summary
public HttpRequestBuilderImpl()

Method Detail

bodyPublisher	back to summary
pack-priv HttpRequest.BodyPublisher bodyPublisher()

build back to summary

build	back to summary
public HttpRequest build() Implements java.net.http.HttpRequest.Builder.build. Doc from java.net.http.HttpRequest.Builder.build. Builds and returns an `HttpRequest`. Annotations @Override

public HttpRequest build()

Implements java.net.http.HttpRequest.Builder.build.

Doc from java.net.http.HttpRequest.Builder.build.

Builds and returns an HttpRequest.

Annotations

@Override

buildForWebSocket	back to summary
public HttpRequestImpl buildForWebSocket()

checkNameAndValue	back to summary
private void checkNameAndValue(String name, String value)

checkURI	back to summary
pack-priv static void checkURI(URI uri)

copy back to summary

copy	back to summary
public HttpRequestBuilderImpl copy() Implements java.net.http.HttpRequest.Builder.copy. Doc from java.net.http.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. Annotations @Override

public HttpRequestBuilderImpl copy()

Implements java.net.http.HttpRequest.Builder.copy.

Doc from java.net.http.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.

Annotations

@Override

copySupportedOptions	back to summary
public static Map<HttpOption<?>, Object> copySupportedOptions(HttpRequest request)

copySupportedOptions	back to summary
public static Map<HttpOption<?>, Object> copySupportedOptions(Map<HttpOption<?>, Object> options)

DELETE	back to summary
public HttpRequest.Builder DELETE() Implements java.net.http.HttpRequest.Builder.DELETE. Doc from java.net.http.HttpRequest.Builder.DELETE. Sets the request method of this builder to DELETE. Annotations @Override

DELETE

back to summary

public HttpRequest.Builder DELETE()

Implements java.net.http.HttpRequest.Builder.DELETE.

Doc from java.net.http.HttpRequest.Builder.DELETE.

Sets the request method of this builder to DELETE.

Annotations

@Override

expectContinue back to summary

expectContinue	back to summary
public HttpRequestBuilderImpl expectContinue(boolean enable) Implements java.net.http.HttpRequest.Builder.expectContinue. Doc from java.net.http.HttpRequest.Builder.expectContinue. Requests the server to acknowledge the request before sending the 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 publisher for the request will not be invoked until this interim response is received. Annotations @Override

public HttpRequestBuilderImpl expectContinue(boolean enable)

Implements java.net.http.HttpRequest.Builder.expectContinue.

Doc from java.net.http.HttpRequest.Builder.expectContinue.

Requests the server to acknowledge the request before sending the 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 publisher for the request will not be invoked until this interim response is received.

Annotations

@Override

expectContinue	back to summary
pack-priv boolean expectContinue()

GET	back to summary
public HttpRequest.Builder GET() Implements java.net.http.HttpRequest.Builder.GET. Doc from java.net.http.HttpRequest.Builder.GET. Sets the request method of this builder to GET. This is the default. Annotations @Override

GET

back to summary

public HttpRequest.Builder GET()

Implements java.net.http.HttpRequest.Builder.GET.

Doc from java.net.http.HttpRequest.Builder.GET.

Sets the request method of this builder to GET. This is the default.

Annotations

@Override

HEAD	back to summary
public HttpRequest.Builder HEAD() Overrides default java.net.http.HttpRequest.Builder.HEAD. Doc from java.net.http.HttpRequest.Builder.HEAD. Sets the request method of this builder to HEAD. Annotations @Override

HEAD

back to summary

public HttpRequest.Builder HEAD()

Overrides default java.net.http.HttpRequest.Builder.HEAD.

Doc from java.net.http.HttpRequest.Builder.HEAD.

Sets the request method of this builder to HEAD.

Annotations

@Override

header	back to summary
public HttpRequestBuilderImpl header(String name, String value) Implements java.net.http.HttpRequest.Builder.header. Doc from java.net.http.HttpRequest.Builder.header. Adds the given name value pair to the set of headers for this request. The given value is added to the list of values for that name. Annotations @Override

header

back to summary

public HttpRequestBuilderImpl header(String name, String value)

Implements java.net.http.HttpRequest.Builder.header.

Doc from java.net.http.HttpRequest.Builder.header.

Adds the given name value pair to the set of headers for this request. The given value is added to the list of values for that name.

Annotations

@Override

headers back to summary

headers	back to summary
public HttpRequestBuilderImpl headers(String... params) Implements java.net.http.HttpRequest.Builder.headers. Doc from java.net.http.HttpRequest.Builder.headers. Adds the given name value pairs to the set of headers for this request. The supplied `String` instances must alternate as header names and header values. To add several values to the same name then the same name must be supplied with each new value. Annotations @Override

public HttpRequestBuilderImpl headers(String... params)

Implements java.net.http.HttpRequest.Builder.headers.

Doc from java.net.http.HttpRequest.Builder.headers.

Adds the given name value pairs to the set of headers for this request. The supplied String instances must alternate as header names and header values. To add several values to the same name then the same name must be supplied with each new value.

Annotations

@Override

headersBuilder	back to summary
pack-priv HttpHeadersBuilder headersBuilder()

method	back to summary
pack-priv String method()

method	back to summary
public HttpRequest.Builder method(String method, HttpRequest.BodyPublisher body) Implements java.net.http.HttpRequest.Builder.method. Doc from java.net.http.HttpRequest.Builder.method. Sets the request method and request body of this builder to the given values. Annotations @Override

method

back to summary

public HttpRequest.Builder method(String method, HttpRequest.BodyPublisher body)

Implements java.net.http.HttpRequest.Builder.method.

Doc from java.net.http.HttpRequest.Builder.method.

Sets the request method and request body of this builder to the given values.

Annotations

@Override

method0	back to summary
private HttpRequest.Builder method0(String method, HttpRequest.BodyPublisher body)

options	back to summary
pack-priv Map<HttpOption<?>, Object> options()

POST	back to summary
public HttpRequest.Builder POST(HttpRequest.BodyPublisher body) Implements java.net.http.HttpRequest.Builder.POST. Doc from java.net.http.HttpRequest.Builder.POST. Sets the request method of this builder to POST and sets its request body publisher to the given value. Annotations @Override

POST

back to summary

public HttpRequest.Builder POST(HttpRequest.BodyPublisher body)

Implements java.net.http.HttpRequest.Builder.POST.

Doc from java.net.http.HttpRequest.Builder.POST.

Sets the request method of this builder to POST and sets its request body publisher to the given value.

Annotations

@Override

PUT	back to summary
public HttpRequest.Builder PUT(HttpRequest.BodyPublisher body) Implements java.net.http.HttpRequest.Builder.PUT. Doc from java.net.http.HttpRequest.Builder.PUT. Sets the request method of this builder to PUT and sets its request body publisher to the given value. Annotations @Override

PUT

back to summary

public HttpRequest.Builder PUT(HttpRequest.BodyPublisher body)

Implements java.net.http.HttpRequest.Builder.PUT.

Doc from java.net.http.HttpRequest.Builder.PUT.

Sets the request method of this builder to PUT and sets its request body publisher to the given value.

Annotations

@Override

setHeader	back to summary
public HttpRequestBuilderImpl setHeader(String name, String value) Implements java.net.http.HttpRequest.Builder.setHeader. Doc from java.net.http.HttpRequest.Builder.setHeader. Sets the given name value pair to the set of headers for this request. This overwrites any previously set values for name. Annotations @Override

setHeader

back to summary

public HttpRequestBuilderImpl setHeader(String name, String value)

Implements java.net.http.HttpRequest.Builder.setHeader.

Doc from java.net.http.HttpRequest.Builder.setHeader.

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

Annotations

@Override

setOption back to summary

setOption	back to summary
public <T> HttpRequest.Builder setOption(HttpOption<T> option, T value) Overrides default java.net.http.HttpRequest.Builder.setOption. Doc from java.net.http.HttpRequest.Builder.setOption. Provides request configuration option hints modeled as key value pairs to help an `HttpClient` implementation decide how the request/response exchange should be established or carried out. An `HttpClient` implementation may decide to ignore request configuration option hints, or fail the request, if provided with any option hints that it does not understand. If this method is invoked twice for the same request option, any value previously provided to this builder for the corresponding option is replaced by the new value. If `null` is supplied as a value, any value previously provided is discarded. Annotations @Override

public <T> HttpRequest.Builder setOption(HttpOption<T> option, T value)

Overrides default java.net.http.HttpRequest.Builder.setOption.

Doc from java.net.http.HttpRequest.Builder.setOption.

Provides request configuration option hints modeled as key value pairs to help an HttpClient implementation decide how the request/response exchange should be established or carried out.

An HttpClient implementation may decide to ignore request configuration option hints, or fail the request, if provided with any option hints that it does not understand.

If this method is invoked twice for the same request option, any value previously provided to this builder for the corresponding option is replaced by the new value. If null is supplied as a value, any value previously provided is discarded.

Annotations

@Override

timeout back to summary

timeout	back to summary
public HttpRequest.Builder timeout(Duration duration) Implements java.net.http.HttpRequest.Builder.timeout. Doc from java.net.http.HttpRequest.Builder.timeout. Sets a timeout for this request. If the response is not received within the specified timeout then an `HttpTimeoutException` is thrown from `HttpClient::send` or `HttpClient::sendAsync` completes exceptionally with an `HttpTimeoutException`. The effect of not setting a timeout is the same as setting an infinite `Duration`, i.e., block forever. Annotations @Override

public HttpRequest.Builder timeout(Duration duration)

Implements java.net.http.HttpRequest.Builder.timeout.

Doc from java.net.http.HttpRequest.Builder.timeout.

Sets a timeout for this request. If the response is not received within the specified timeout then an HttpTimeoutException is thrown from HttpClient::send or HttpClient::sendAsync completes exceptionally with an HttpTimeoutException. The effect of not setting a timeout is the same as setting an infinite Duration, i.e., block forever.

Annotations

@Override

timeout	back to summary
pack-priv Duration timeout()

uri back to summary

uri	back to summary
public HttpRequestBuilderImpl uri(URI uri) Implements java.net.http.HttpRequest.Builder.uri. Doc from java.net.http.HttpRequest.Builder.uri. Sets this `HttpRequest`'s request `URI`. Annotations @Override

public HttpRequestBuilderImpl uri(URI uri)

Implements java.net.http.HttpRequest.Builder.uri.

Doc from java.net.http.HttpRequest.Builder.uri.

Sets this HttpRequest's request URI.

Annotations

@Override

uri	back to summary
pack-priv URI uri()

version back to summary

version	back to summary
public HttpRequestBuilderImpl version(HttpClient.Version version) Implements java.net.http.HttpRequest.Builder.version. Doc from java.net.http.HttpRequest.Builder.version. Sets the preferred `HttpClient.Version` for this request. The corresponding `HttpResponse` should be checked for the version that was actually used. If the version is not set in a request, then the version requested will be that of the sending `HttpClient`. Annotations @Override

public HttpRequestBuilderImpl version(HttpClient.Version version)

Implements java.net.http.HttpRequest.Builder.version.

Doc from java.net.http.HttpRequest.Builder.version.

Sets the preferred HttpClient.Version for this request.

The corresponding HttpResponse should be checked for the version that was actually used. If the version is not set in a request, then the version requested will be that of the sending HttpClient.

Annotations

@Override

version	back to summary
pack-priv Optional<HttpClient.Version> version()

public Class HttpRequestBuilderImpl

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail