org.mule.runtime.http.api.domain.message

Class HttpMessageBuilder<B extends HttpMessageBuilder,M extends HttpMessage>

java.lang.Object

org.mule.runtime.http.api.domain.message.HttpMessageBuilder<B,M>

Type Parameters:

B - the type of the builder itself.

M - the type of HttpMessage that the builder creates.

Direct Known Subclasses:

HttpRequestBuilder, HttpResponseBuilder

public abstract class HttpMessageBuilder<B extends HttpMessageBuilder,M extends HttpMessage>
extends Object

Base implementation of an HttpMessage builder. Implementations should extend it and indicate their type and the type of the message they build.

Field Summary

Fields

Modifier and Type	Field and Description
protected HttpEntity	entity
protected MultiMap<String,String>	headers

Constructor Summary

Constructors

Modifier	Constructor and Description
	HttpMessageBuilder()
protected	HttpMessageBuilder(HttpMessage httpMessage)

Method Summary

Modifier and Type	Method and Description
B	addHeader(String name, String value) Includes a new header to be sent in the desired HttpMessage.
B	addHeaders(String name, Collection<String> values) Includes a new header with multiple values to be sent in the desired HttpMessage.
abstract M	build()
B	entity(HttpEntity entity)
MultiMap<String,String>	getHeaders()
Optional<String>	getHeaderValue(String name) Returns the value of a given HTTP request.
Collection<String>	getHeaderValues(String name) Gives access to all current values of a given HTTP header.
B	headers(MultiMap<String,String> headersMap)
protected void	initHeaders()
B	removeHeader(String name) Removes a header.

Methods inherited from class java.lang.Object

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

Field Detail

headers

protected MultiMap<String,String> headers

entity

protected HttpEntity entity

Constructor Detail

HttpMessageBuilder

public HttpMessageBuilder()

HttpMessageBuilder

protected HttpMessageBuilder(HttpMessage httpMessage)

Method Detail

initHeaders

protected void initHeaders()

entity

public B entity(HttpEntity entity)

Parameters:

entity - the HttpEntity that should be used as body for the HttpMessage. Non null.

Returns:

this builder

headers

public B headers(MultiMap<String,String> headersMap)

Parameters:

headersMap - a MultiMap representing the HTTP headers of the HttpRequest desired. Non null.

Returns:

this builder

addHeader

public B addHeader(String name,
                   String value)

Includes a new header to be sent in the desired HttpMessage. Since HTTP headers are case insensitive and can have several values, multiple calls to this method using the same header name will accumulate the values and all of them will be sent.

Parameters:

name - the name of the HTTP header

value - the value of the HTTP header

Returns:

this builder

addHeaders

public B addHeaders(String name,
                    Collection<String> values)

Includes a new header with multiple values to be sent in the desired HttpMessage.

Parameters:

name - the name of the HTTP header

values - the values of the HTTP header

Returns:

this builder

removeHeader

public B removeHeader(String name)

Removes a header. Since multiple values might be present, all are removed.

Parameters:

name - the name of the HTTP header to remove

Returns:

this builder

getHeaderValue

public Optional<String> getHeaderValue(String name)

Returns the value of a given HTTP request. If there are several then the first will be return. Use getHeaderValues(String) instead if all values are required.

Parameters:

name - the name of the desired HTTP header

Returns:

the value of the header or null if there isn't one

getHeaderValues

public Collection<String> getHeaderValues(String name)

Gives access to all current values of a given HTTP header.

Parameters:

name - the name of the desired HTTP header

Returns:

an immutable Collection of String values for the header

getHeaders

public MultiMap<String,String> getHeaders()

Returns:

an immutable version of the current headers in the builder.

build

public abstract M build()