Package org.apache.juneau.rest.client

Class TransportRequest.Builder

java.lang.Object

org.apache.juneau.rest.client.TransportRequest.Builder

Enclosing class:

TransportRequest

public static final class TransportRequest.Builder
extends Object

Fluent builder for TransportRequest.

Since:

9.2.1

Method Summary

Modifier and Type	Method	Description
TransportRequest.Builder	allowedAddressRanges(RemoteUrlPolicy.AllowedRanges value)	Sets the per-client special-purpose address ranges the SSRF guardrail re-permits for this request.
TransportRequest.Builder	body(TransportBody value)	Sets the request body.
TransportRequest	build()	Builds and returns the TransportRequest.
TransportRequest.Builder	header(String name, String value)	Appends a request header.
TransportRequest.Builder	headers(Collection<TransportHeader> value)	Appends multiple request headers.
TransportRequest.Builder	method(String value)	Sets the HTTP method.
TransportRequest.Builder	remoteUrlPolicy(boolean policyEnforced, boolean allowPrivateUrls)	Marks this request as originating from a @Remote/@Url call, subject to the SSRF guardrail, and records whether the allowPrivateUrls opt-in is in effect.
TransportRequest.Builder	timeout(Duration value)	Sets the per-call response timeout.
TransportRequest.Builder	uri(String value)	Sets the request URI from a string.
TransportRequest.Builder	uri(URI value)	Sets the request URI.

Methods inherited from class java.lang.Object

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

Method Details

method

public TransportRequest.Builder method(String value)

Sets the HTTP method.

Parameters:

value - The method (e.g. "GET"). Must not be null.

Returns:

This object.

uri

public TransportRequest.Builder uri(URI value)

Sets the request URI.

Parameters:

value - The URI. Must not be null.

Returns:

This object.

uri

public TransportRequest.Builder uri(String value)

Sets the request URI from a string.

Parameters:

value - The URI string. Must not be null.

Returns:

This object.

Throws:

IllegalArgumentException - If the string is not a valid URI.

header

public TransportRequest.Builder header(String name,
 String value)

Appends a request header.

Parameters:

name - The header name. Must not be null.

value - The header value. Must not be null.

Returns:

This object.

headers

public TransportRequest.Builder headers(Collection<TransportHeader> value)

Appends multiple request headers.

Parameters:

value - The headers to add. Must not be null.

Returns:

This object.

body

public TransportRequest.Builder body(TransportBody value)

Sets the request body.

Parameters:

value - The body. May be null for body-less requests.

Returns:

This object.

timeout

public TransportRequest.Builder timeout(Duration value)

Sets the per-call response timeout.

Parameters:

value - The response timeout. May be null to use the transport default. Must otherwise be positive.

Returns:

This object.

Throws:

IllegalArgumentException - If value is zero or negative.

remoteUrlPolicy

public TransportRequest.Builder remoteUrlPolicy(boolean policyEnforced,
 boolean allowPrivateUrls)

Marks this request as originating from a @Remote/@Url call, subject to the SSRF guardrail, and records whether the allowPrivateUrls opt-in is in effect.

Parameters:

policyEnforced - true if this request is policy-covered.

allowPrivateUrls - true if the allowPrivateUrls opt-in disables the deny-private checks.

Returns:

This object.

allowedAddressRanges

public TransportRequest.Builder allowedAddressRanges(RemoteUrlPolicy.AllowedRanges value)

Sets the per-client special-purpose address ranges the SSRF guardrail re-permits for this request.

Parameters:

value - The allowed ranges. null means none.

Returns:

This object.

build

public TransportRequest build()

Builds and returns the TransportRequest.

Returns:

A new instance. Never null.