Package io.wcm.caravan.io.http.request

Class CaravanHttpRequestBuilder

java.lang.Object

io.wcm.caravan.io.http.request.CaravanHttpRequestBuilder

@ProviderType
public final class CaravanHttpRequestBuilder
extends Object

UriTemplate using HTTP request builder.

Constructor Summary

Constructors

Constructor	Description
CaravanHttpRequestBuilder()	Default constructor.
CaravanHttpRequestBuilder(String serviceId)

Method Summary

Modifier and Type	Method	Description
CaravanHttpRequestBuilder	append(String urlFragment)	Appends a URL fragment.
CaravanHttpRequestBuilder	body(byte[] newBody, Charset newCharset)	Sets the HTTP body and charset.
CaravanHttpRequestBuilder	body(String template)	Sets a template for the HTTP body.
CaravanHttpRequest	build()	Creates the request object with no values for the templates.
CaravanHttpRequest	build(Map<String,Object> parameters)	Creates the request object with given values for the templates.
CaravanHttpRequestBuilder	correlationId(String correlationId)
CaravanHttpRequestBuilder	header(String name, String value)	Adds a header to the HTTP request
CaravanHttpRequestBuilder	header(String name, Collection<String> headerValues)	Sets and replaces a header for the HTTP request
CaravanHttpRequestBuilder	method(String newMethod)
CaravanHttpRequestBuilder	query(String name)	Adds a query template expression.
CaravanHttpRequestBuilder	query(String name, Object value)	Adds a parameter with value to the request query
CaravanHttpRequestBuilder	value(String name, Object value)	Adds a value for any UriTemplate expression in URL, header or body.

Methods inherited from class java.lang.Object

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

Constructor Detail

CaravanHttpRequestBuilder

public CaravanHttpRequestBuilder()

Default constructor.

CaravanHttpRequestBuilder

public CaravanHttpRequestBuilder(String serviceId)

Parameters:

serviceId - Logical service ID. Can be null.

Method Detail

correlationId

public CaravanHttpRequestBuilder correlationId(String correlationId)

Parameters:

correlationId - Correlation Id. Can be null.

Returns:

Builder

method

public CaravanHttpRequestBuilder method(String newMethod)

Parameters:

newMethod - HTTP method

Returns:

Builder

See Also:

CaravanHttpRequest.getMethod()

header

public CaravanHttpRequestBuilder header(String name,
                                        String value)

Adds a header to the HTTP request

Parameters:

name - Header name

value - Header value

Returns:

Builder

See Also:

CaravanHttpRequest.getHeaders()

header

public CaravanHttpRequestBuilder header(String name,
                                        Collection<String> headerValues)

Sets and replaces a header for the HTTP request

Parameters:

name - Header name

headerValues - Header values

Returns:

Builder

See Also:

CaravanHttpRequest.getHeaders()

append

public CaravanHttpRequestBuilder append(String urlFragment)

Appends a URL fragment.

Parameters:

urlFragment - URL fragment

Returns:

Builder

query

public CaravanHttpRequestBuilder query(String name)

Adds a query template expression.

Parameters:

name - Query parameter name

Returns:

Builder

query

public CaravanHttpRequestBuilder query(String name,
                                       Object value)

Adds a parameter with value to the request query

Parameters:

name - Parameter name

value - Parameter value

Returns:

Builder

See Also:

CaravanHttpRequest.getUrl()

value

public CaravanHttpRequestBuilder value(String name,
                                       Object value)

Adds a value for any UriTemplate expression in URL, header or body.

Parameters:

name - Parameter name

value - Parameter value

Returns:

Builder

body

public CaravanHttpRequestBuilder body(String template)

Sets a template for the HTTP body.

Parameters:

template - Body template

Returns:

Builder

See Also:

CaravanHttpRequest.getBody()

body

public CaravanHttpRequestBuilder body(byte[] newBody,
                                      Charset newCharset)

Sets the HTTP body and charset.

Parameters:

newBody - HTTP body

newCharset - HTTP charset

Returns:

Builder

See Also:

CaravanHttpRequest.getBody()

build

public CaravanHttpRequest build()

Creates the request object with no values for the templates.

Returns:

Request

build

public CaravanHttpRequest build(Map<String,Object> parameters)

Creates the request object with given values for the templates.

Parameters:

parameters - Template values

Returns:

Request