co.paralleluniverse.comsat.webactors

Class HttpRequest.Builder

java.lang.Object

co.paralleluniverse.comsat.webactors.HttpRequest.Builder

Enclosing class:

HttpRequest

public static class HttpRequest.Builder
extends Object

Constructor Summary

Constructors

Constructor and Description
HttpRequest.Builder(ActorRef<? super WebMessage> from)
HttpRequest.Builder(ActorRef<? super WebMessage> from, ByteBuffer body)
HttpRequest.Builder(ActorRef<? super WebMessage> from, String body)

Method Summary

Methods

Modifier and Type	Method and Description
HttpRequest.Builder	addCookie(Cookie cookie) Adds the specified cookie to the request.
HttpRequest.Builder	addHeader(String name, String value) Adds a request header with the given name and value.
HttpRequest.Builder	addParam(String name, String value) Adds a request parameter with the given name and value.
HttpRequest	build() Instantiates a new immutable HttpRequest based on the values set in this builder.
HttpRequest.Builder	setCharacterEncoding(Charset charset) Sets the character encoding (MIME charset) of the response being sent to the client, for example, UTF-8.
HttpRequest.Builder	setContentType(String contentType) Sets the content type of the request being sent to the client.
HttpRequest.Builder	setMethod(String method)
HttpRequest.Builder	setPath(String path)
HttpRequest.Builder	setPort(int port)
HttpRequest.Builder	setScheme(String scheme)
HttpRequest.Builder	setServer(String server)
HttpRequest.Builder	setSourceHost(String sourceAddress)
HttpRequest.Builder	setSourcePort(int sourcePort)

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpRequest.Builder

public HttpRequest.Builder(ActorRef<? super WebMessage> from,
                   String body)

HttpRequest.Builder

public HttpRequest.Builder(ActorRef<? super WebMessage> from,
                   ByteBuffer body)

HttpRequest.Builder

public HttpRequest.Builder(ActorRef<? super WebMessage> from)

Method Detail

setSourceHost

public HttpRequest.Builder setSourceHost(String sourceAddress)

setSourcePort

public HttpRequest.Builder setSourcePort(int sourcePort)

setContentType

public HttpRequest.Builder setContentType(String contentType)

Sets the content type of the request being sent to the client.

The given content type may include a character encoding specification, for example, text/html;charset=UTF-8.

The Content-Type header is used to communicate the content type and the character encoding used in the response writer to the client

Parameters:

contentType - the MIME type of the content

setCharacterEncoding

public HttpRequest.Builder setCharacterEncoding(Charset charset)

Sets the character encoding (MIME charset) of the response being sent to the client, for example, UTF-8. If the character encoding has already been set by setContentType(java.lang.String), this method overrides it. Calling setContentType(java.lang.String) with "text/html" and calling this method with Charset.forName("UTF-8") is equivalent with calling setContentType with "text/html; charset=UTF-8".

Note that the character encoding cannot be communicated via HTTP headers if content type is not specified; however, it is still used to encode text written in this response’s body.

Parameters:

charset - only the character sets defined by IANA Character Sets (http://www.iana.org/assignments/character-sets)

See Also:

setContentType(java.lang.String)

addHeader

public HttpRequest.Builder addHeader(String name,
                            String value)

Adds a request header with the given name and value. This method allows response headers to have multiple values.

Parameters:

name - the name of the header

value - the additional header value. If it contains octet string, it should be encoded according to RFC 2047 (http://www.ietf.org/rfc/rfc2047.txt)

addCookie

public HttpRequest.Builder addCookie(Cookie cookie)

Adds the specified cookie to the request. This method can be called multiple times to set multiple cookies.

Parameters:

cookie - the Cookie to return to the client

Returns:

this

setMethod

public HttpRequest.Builder setMethod(String method)

setScheme

public HttpRequest.Builder setScheme(String scheme)

setServer

public HttpRequest.Builder setServer(String server)

setPort

public HttpRequest.Builder setPort(int port)

setPath

public HttpRequest.Builder setPath(String path)

addParam

public HttpRequest.Builder addParam(String name,
                           String value)

Adds a request parameter with the given name and value.

Parameters:

name - the name of the parameter

value - the additional header value. If it contains octet string, it should be encoded according to RFC 2047 (http://www.ietf.org/rfc/rfc2047.txt)

build

public HttpRequest build()

Instantiates a new immutable HttpRequest based on the values set in this builder.

Returns:

a new HttpRequest