OpenJDK 27 · jdk.internal.net.http.HttpRequestImpl · APIdia, the JavaDoc alternative

Field Summary

Modifier and Type	Field and Description
private final InetSocketAddress	authority
pack-priv final boolean	expectContinue
private volatile boolean	isWebSocket
private final String	method
private final Map<HttpOption<?>, Object>	options
private volatile Proxy	proxy
pack-priv final HttpRequest.BodyPublisher	requestPublisher
pack-priv final boolean	secure
private final HttpHeadersBuilder	systemHeadersBuilder
private final Duration	timeout
private final URI	uri
public static final String	USER_AGENT The value of the User-Agent header for all requests sent by the client.
private final HttpHeaders	userHeaders
private volatile boolean	userSetAuthorization
private volatile boolean	userSetProxyAuthorization
private final Optional<HttpClient.Version>	version

Constructor Summary

Access	Constructor and Description
public	HttpRequestImpl(HttpRequestBuilderImpl builder) Creates an HttpRequestImpl from the given builder.
public	HttpRequestImpl(HttpRequest request, ProxySelector ps) Creates an HttpRequestImpl from the given request.
private	HttpRequestImpl(URI uri, String method, HttpRequestImpl other, boolean mayHaveBody) Creates a HttpRequestImpl using fields of an existing request impl.
private	HttpRequestImpl(URI uri, String method, HttpRequestImpl other, boolean mayHaveBody, Optional<BiPredicate<String, String>> redirectHeadersFilter)
pack-priv	HttpRequestImpl(String method, InetSocketAddress authority, Utils.ProxyHeaders headers)
private	HttpRequestImpl(HttpRequestImpl parent, HttpHeaders headers)

Method Summary

Modifier and Type	Method and Description
pack-priv InetSocketAddress	authority()
public Optional<HttpRequest.BodyPublisher>	bodyPublisher() Implements abstract java.net.http.HttpRequest.bodyPublisher. Returns an `Optional` containing the `BodyPublisher` set on this request.
private static void	checkTimeout(Duration duration)
pack-priv static HttpRequestImpl	createPushRequest(HttpRequestImpl parent, HttpHeaders headers) Creates a HttpRequestImpl from the given set of Headers and the associated "parent" request.
public boolean	expectContinue() Implements abstract java.net.http.HttpRequest.expectContinue. Returns this request's expect continue setting.
pack-priv InetSocketAddress	getAddress()
public <T> Optional<T>	getOption(HttpOption<T> option) Overrides java.net.http.HttpRequest.getOption. Returns the value configured on this request for the given option, if any.
pack-priv HttpHeadersBuilder	getSystemHeadersBuilder()
pack-priv HttpHeaders	getUserHeaders()
public boolean	getUserSetAuthFlag(Authenticator.RequestorType type)
public HttpHeaders	headers() Implements abstract java.net.http.HttpRequest.headers. The (user-accessible) request headers that this request was (or will be) sent with.
pack-priv final HttpOption.Http3DiscoveryMode	http3Discovery()
pack-priv final boolean	isConnect()
pack-priv final boolean	isHttp3Only(HttpClient.Version version)
public void	isWebSocket(boolean is) Implements jdk.internal.net.http.websocket.WebSocketRequest.isWebSocket.
pack-priv boolean	isWebSocket()
public String	method() Implements abstract java.net.http.HttpRequest.method. Returns the request method for this request.
public static HttpRequestImpl	newInstanceForAuthentication(HttpRequestImpl other) Returns a new instance suitable for authentication.
public static HttpRequestImpl	newInstanceForRedirection(URI uri, String method, HttpRequestImpl other, boolean mayHaveBody) Returns a new instance suitable for redirection.
private Map<HttpOption<?>, Object>	optionsFor(URI uri)
pack-priv InetSocketAddress	proxy()
private HttpRequest.BodyPublisher	publisher(HttpRequestImpl other)
private static Proxy	retrieveProxy(HttpRequest request, ProxySelector ps, URI uri) Retrieves a copy of the proxy either from the given `HttpRequest` or `ProxySelector`, if there is one.
pack-priv boolean	secure()
pack-priv void	setH2Upgrade(Exchange<?> exchange)
public void	setProxy(Proxy proxy) Implements jdk.internal.net.http.websocket.WebSocketRequest.setProxy.
public void	setSystemHeader(String name, String value) Implements jdk.internal.net.http.websocket.WebSocketRequest.setSystemHeader.
public void	setUserSetAuthFlag(Authenticator.RequestorType type, boolean value) These flags are set if the user set an Authorization or Proxy-Authorization header overriding headers produced by an Authenticator that was also set The values are checked in the AuthenticationFilter which tells the library to return whatever response received to the user instead of causing request to be resent, in case of error.
public Optional<Duration>	timeout() Implements abstract java.net.http.HttpRequest.timeout. Returns an `Optional` containing this request's timeout duration.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public URI	uri() Implements abstract java.net.http.HttpRequest.uri. Returns this request's `URI`.
private static String	userAgent()
public Optional<HttpClient.Version>	version() Implements abstract java.net.http.HttpRequest.version. Returns an `Optional` containing the HTTP protocol version that will be requested for this `HttpRequest`.

Inherited from java.net.http.HttpRequest:: equals hashCode newBuilder newBuilder newBuilder

Field Detail

authority	back to summary
private final InetSocketAddress authority

expectContinue	back to summary
pack-priv final boolean expectContinue

isWebSocket	back to summary
private volatile boolean isWebSocket

method	back to summary
private final String method

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

proxy	back to summary
private volatile Proxy proxy

requestPublisher	back to summary
pack-priv final HttpRequest.BodyPublisher requestPublisher

secure	back to summary
pack-priv final boolean secure

systemHeadersBuilder	back to summary
private final HttpHeadersBuilder systemHeadersBuilder

timeout	back to summary
private final Duration timeout

uri	back to summary
private final URI uri

USER_AGENT	back to summary
public static final String USER_AGENT The value of the User-Agent header for all requests sent by the client.

userHeaders	back to summary
private final HttpHeaders userHeaders

userSetAuthorization	back to summary
private volatile boolean userSetAuthorization

userSetProxyAuthorization	back to summary
private volatile boolean userSetProxyAuthorization

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

Constructor Detail

HttpRequestImpl	back to summary
public HttpRequestImpl(HttpRequestBuilderImpl builder) Creates an HttpRequestImpl from the given builder.

HttpRequestImpl	back to summary
public HttpRequestImpl(HttpRequest request, ProxySelector ps) Creates an HttpRequestImpl from the given request.

HttpRequestImpl	back to summary
private HttpRequestImpl(URI uri, String method, HttpRequestImpl other, boolean mayHaveBody) Creates a HttpRequestImpl using fields of an existing request impl. The newly created HttpRequestImpl does not copy the system headers.

HttpRequestImpl	back to summary
private HttpRequestImpl(URI uri, String method, HttpRequestImpl other, boolean mayHaveBody, Optional<BiPredicate<String, String>> redirectHeadersFilter)

HttpRequestImpl	back to summary
pack-priv HttpRequestImpl(String method, InetSocketAddress authority, Utils.ProxyHeaders headers)

HttpRequestImpl	back to summary
private HttpRequestImpl(HttpRequestImpl parent, HttpHeaders headers) throws IOException

Method Detail

authority	back to summary
pack-priv InetSocketAddress authority()

bodyPublisher back to summary

bodyPublisher	back to summary
public Optional<HttpRequest.BodyPublisher> bodyPublisher() Implements abstract java.net.http.HttpRequest.bodyPublisher. Doc from java.net.http.HttpRequest.bodyPublisher. Returns an `Optional` containing the `BodyPublisher` set on this request. If no `BodyPublisher` was set in the requests's builder, then the `Optional` is empty. Annotations @Override

public Optional<HttpRequest.BodyPublisher> bodyPublisher()

Implements abstract java.net.http.HttpRequest.bodyPublisher.

Doc from java.net.http.HttpRequest.bodyPublisher.

Returns an Optional containing the BodyPublisher set on this request. If no BodyPublisher was set in the requests's builder, then the Optional is empty.

Annotations

@Override

checkTimeout	back to summary
private static void checkTimeout(Duration duration)

createPushRequest	back to summary
pack-priv static HttpRequestImpl createPushRequest(HttpRequestImpl parent, HttpHeaders headers) throws IOException Creates a HttpRequestImpl from the given set of Headers and the associated "parent" request. Fields not taken from the headers are taken from the parent.

expectContinue	back to summary
public boolean expectContinue() Implements abstract java.net.http.HttpRequest.expectContinue. Doc from java.net.http.HttpRequest.expectContinue. Returns this request's expect continue setting. Annotations @Override

expectContinue

back to summary

public boolean expectContinue()

Implements abstract java.net.http.HttpRequest.expectContinue.

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

Returns this request's expect continue setting.

Annotations

@Override

getAddress	back to summary
pack-priv InetSocketAddress getAddress()

getOption	back to summary
public <T> Optional<T> getOption(HttpOption<T> option) Overrides java.net.http.HttpRequest.getOption. Doc from java.net.http.HttpRequest.getOption. Returns the value configured on this request for the given option, if any. Annotations @Override

getOption

back to summary

public <T> Optional<T> getOption(HttpOption<T> option)

Overrides java.net.http.HttpRequest.getOption.

Doc from java.net.http.HttpRequest.getOption.

Returns the value configured on this request for the given option, if any.

Annotations

@Override

getSystemHeadersBuilder	back to summary
pack-priv HttpHeadersBuilder getSystemHeadersBuilder()

getUserHeaders	back to summary
pack-priv HttpHeaders getUserHeaders()

getUserSetAuthFlag	back to summary
public boolean getUserSetAuthFlag(Authenticator.RequestorType type)

headers	back to summary
public HttpHeaders headers() Implements abstract java.net.http.HttpRequest.headers. Doc from java.net.http.HttpRequest.headers. The (user-accessible) request headers that this request was (or will be) sent with. Annotations @Override

headers

back to summary

public HttpHeaders headers()

Implements abstract java.net.http.HttpRequest.headers.

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

The (user-accessible) request headers that this request was (or will be) sent with.

Annotations

@Override

http3Discovery	back to summary
pack-priv final HttpOption.Http3DiscoveryMode http3Discovery()

isConnect	back to summary
pack-priv final boolean isConnect()

isHttp3Only	back to summary
pack-priv final boolean isHttp3Only(HttpClient.Version version)

isWebSocket	back to summary
public void isWebSocket(boolean is) Implements jdk.internal.net.http.websocket.WebSocketRequest.isWebSocket. Annotations @Override

isWebSocket

back to summary

public void isWebSocket(boolean is)

Implements jdk.internal.net.http.websocket.WebSocketRequest.isWebSocket.

Annotations

@Override

isWebSocket	back to summary
pack-priv boolean isWebSocket()

method	back to summary
public String method() Implements abstract java.net.http.HttpRequest.method. Returns the request method for this request. If not set explicitly, the default method for any request is "GET". Annotations @Override

method

back to summary

public String method()

Implements abstract java.net.http.HttpRequest.method.

Returns the request method for this request. If not set explicitly, the default method for any request is "GET".

Annotations

@Override

newInstanceForAuthentication	back to summary
public static HttpRequestImpl newInstanceForAuthentication(HttpRequestImpl other) Returns a new instance suitable for authentication.

newInstanceForRedirection	back to summary
public static HttpRequestImpl newInstanceForRedirection(URI uri, String method, HttpRequestImpl other, boolean mayHaveBody) Returns a new instance suitable for redirection.

optionsFor	back to summary
private Map<HttpOption<?>, Object> optionsFor(URI uri)

proxy	back to summary
pack-priv InetSocketAddress proxy()

publisher	back to summary
private HttpRequest.BodyPublisher publisher(HttpRequestImpl other)

retrieveProxy	back to summary
private static Proxy retrieveProxy(HttpRequest request, ProxySelector ps, URI uri) Retrieves a copy of the proxy either from the given `HttpRequest` or `ProxySelector`, if there is one.

secure	back to summary
pack-priv boolean secure()

setH2Upgrade	back to summary
pack-priv void setH2Upgrade(Exchange<?> exchange)

setProxy

back to summary

public void setProxy(Proxy proxy)

Implements jdk.internal.net.http.websocket.WebSocketRequest.setProxy.

Annotations

@Override

setSystemHeader

back to summary

public void setSystemHeader(String name, String value)

Implements jdk.internal.net.http.websocket.WebSocketRequest.setSystemHeader.

Annotations

@Override

setUserSetAuthFlag

back to summary

public void setUserSetAuthFlag(Authenticator.RequestorType type, boolean value)

These flags are set if the user set an Authorization or Proxy-Authorization header overriding headers produced by an Authenticator that was also set The values are checked in the AuthenticationFilter which tells the library to return whatever response received to the user instead of causing request to be resent, in case of error.

timeout back to summary

public Optional<Duration> timeout()

Implements abstract java.net.http.HttpRequest.timeout.

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

Returns an Optional containing this request's timeout duration. If the timeout duration was not set in the request's builder, then the Optional is empty.

Annotations

@Override

toString back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Annotations

@Override

uri back to summary

public URI uri()

Implements abstract java.net.http.HttpRequest.uri.

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

Returns this request's URI.

Annotations

@Override

userAgent	back to summary
private static String userAgent()

version back to summary

public Optional<HttpClient.Version> version()

Implements abstract java.net.http.HttpRequest.version.

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

Returns an Optional containing the HTTP protocol version that will be requested for this HttpRequest. If the version was not set in the request's builder, then the Optional is empty. In that case, the version requested will be that of the sending HttpClient. The corresponding HttpResponse should be queried to determine the version that was actually used.

Annotations

@Override

public Class HttpRequestImpl

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail