Package org.threadly.litesockets.protocols.http.request

Class HTTPRequestBuilder

java.lang.Object

org.threadly.litesockets.protocols.http.request.HTTPRequestBuilder

public class HTTPRequestBuilder
extends java.lang.Object

A builder object for HTTPRequest. This helps construct different types of httpRequests.

Constructor Summary

Constructors

Constructor	Description
HTTPRequestBuilder()	Creates a new HTTPRequestBuilder object.
HTTPRequestBuilder(java.net.URL url)	Creates a new HTTPRequestBuilder object from a URL.

Method Summary

Modifier and Type	Method	Description
HTTPRequestBuilder	appendQuery(java.lang.String key, java.lang.String value)	Adds a query key/value to this HTTPRequestBuilder.
ClientHTTPRequest	buildClientHTTPRequest()
HTTPAddress	buildHTTPAddress()	Builds an HTTPAddress object from the set host/port name.
HTTPRequest	buildHTTPRequest()	Builds an Immutable HTTPRequest object that can be used to send a request.
HTTPRequestBuilder	duplicate()	Creates an independent copy of this HTTPRequestBuilder.
HTTPRequestBuilder	removeHeader(java.lang.String key)	Removes a header on the HTTPRequest.
HTTPRequestBuilder	removeQuery(java.lang.String key)	Removes a Key from the query portion of the http request.
HTTPRequestBuilder	replaceHTTPHeaders(HTTPHeaders hh)	Replaces all the HTTPHeaders for this HTTPRequestBuilder with the ones provided.
HTTPRequestBuilder	setBody(java.lang.String str)
HTTPRequestBuilder	setBody(java.lang.String str, java.nio.charset.Charset cs)
HTTPRequestBuilder	setBody(java.nio.ByteBuffer bb)
HTTPRequestBuilder	setHeader(java.lang.String key, java.lang.String value)	Set a header on the HTTPRequest.
HTTPRequestBuilder	setHost(java.lang.String host)	Sets the Host: header in the client.
HTTPRequestBuilder	setHost(java.lang.String host, boolean setHeader)	Sets the Host: header in the client.
HTTPRequestBuilder	setHTTPAddress(HTTPAddress ha, boolean setHostHeader)	Sets the HTTPAddress for this builder.
HTTPRequestBuilder	setHTTPRequestHeader(HTTPRequestHeader hrh)	Set the HTTPRequestHeader object for this HTTPRequestBuilder.
HTTPRequestBuilder	setHTTPVersion(java.lang.String version)	Set the HTTPVersion for this HTTPRequestBuilder.
HTTPRequestBuilder	setPath(java.lang.String path)	This sets the request path for the HTTPRequestBuilder.
HTTPRequestBuilder	setPort(int port)	This sets the port to use in the buildHTTPAddress() method.
HTTPRequestBuilder	setQueryString(java.lang.String query)	Set the query on this HTTPRequestBuilder.
HTTPRequestBuilder	setRequestMethod(java.lang.String rm)	Sets the HTTPRequestMethod for this request.
HTTPRequestBuilder	setRequestMethod(HTTPRequestMethod rm)	Sets the HTTPRequestMethod for this request.
HTTPRequestBuilder	setSSL(boolean doSSL)	Sets if the request should be made using ssl or not.
HTTPRequestBuilder	setTimeout(long size, java.util.concurrent.TimeUnit unit)
HTTPRequestBuilder	setURL(java.net.URL url)	Uses a URL to set the path and query on this HTTPRequestBuilder object.

Methods inherited from class java.lang.Object

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

Constructor Detail

HTTPRequestBuilder

public HTTPRequestBuilder()

Creates a new HTTPRequestBuilder object.

HTTPRequestBuilder

public HTTPRequestBuilder(java.net.URL url)

Creates a new HTTPRequestBuilder object from a URL. The Path and query will be set from it.

Parameters:

url - the URL to use to create the HTTPRequestBuilder object with.

Method Detail

setURL

public HTTPRequestBuilder setURL(java.net.URL url)

Uses a URL to set the path and query on this HTTPRequestBuilder object.

Parameters:

url - the URL to use to set.

Returns:

the current HTTPRequestBuilder object.

setHTTPRequestHeader

public HTTPRequestBuilder setHTTPRequestHeader(HTTPRequestHeader hrh)

Set the HTTPRequestHeader object for this HTTPRequestBuilder.

Parameters:

hrh - the HTTPRequestHeader object to set.

Returns:

the current HTTPRequestBuilder object.

setRequestMethod

public HTTPRequestBuilder setRequestMethod(java.lang.String rm)

Sets the HTTPRequestMethod for this request. This will accept non-stander strings in the for the request.

Parameters:

rm - the http request method to set this request too.

Returns:

the current HTTPRequestBuilder object.

setHTTPVersion

public HTTPRequestBuilder setHTTPVersion(java.lang.String version)

Set the HTTPVersion for this HTTPRequestBuilder.

Parameters:

version - the HttpVersion to set

Returns:

the current HTTPRequestBuilder object.

setPath

public HTTPRequestBuilder setPath(java.lang.String path)

This sets the request path for the HTTPRequestBuilder. If a query is on this path it will replace the current query in this builder.

Parameters:

path - the path to set.

Returns:

the current HTTPRequestBuilder object.

setQueryString

public HTTPRequestBuilder setQueryString(java.lang.String query)

Set the query on this HTTPRequestBuilder. If there are currently any query params they will be removed before this is set.

Parameters:

query - the query string to set.

Returns:

the current HTTPRequestBuilder object.

appendQuery

public HTTPRequestBuilder appendQuery(java.lang.String key,
                                      java.lang.String value)

Adds a query key/value to this HTTPRequestBuilder. Duplicate keys can be added.

Parameters:

key - the query key to set.

value - the query value for the set key.

Returns:

the current HTTPRequestBuilder object.

removeQuery

public HTTPRequestBuilder removeQuery(java.lang.String key)

Removes a Key from the query portion of the http request.

Parameters:

key - the Key to remove

Returns:

the current HTTPRequestBuilder object.

setHTTPAddress

public HTTPRequestBuilder setHTTPAddress(HTTPAddress ha,
                                         boolean setHostHeader)

Sets the HTTPAddress for this builder. This will add a Host header into the headers of this builder when this object it built. This is also used with the buildHTTPAddress() method.

Parameters:

ha - the HTTPAddress to be set.

setHostHeader - true if you want to chage the Host header to the host in the HTTPAddress, false if you do not.

Returns:

the current HTTPRequestBuilder object.

setHost

public HTTPRequestBuilder setHost(java.lang.String host)

Sets the Host: header in the client. This is also used with the buildHTTPAddress() method. Setting to null will remove this header. NOTE: this will override the HTTP Host header.

Parameters:

host - the host name or ip to set.

Returns:

the current HTTPRequestBuilder object.

setHost

public HTTPRequestBuilder setHost(java.lang.String host,
                                  boolean setHeader)

Sets the Host: header in the client. This is also used with the buildHTTPAddress() method. Setting to null will remove this header.

Parameters:

host - the host name or ip to set.

setHeader - lets you choose if you want to set the host header as well. Set to false if you want to have a different HTTPAddress host then whats in the http host header.

Returns:

the current HTTPRequestBuilder object.

setSSL

public HTTPRequestBuilder setSSL(boolean doSSL)

Sets if the request should be made using ssl or not.

Parameters:

doSSL - true if ssl should be used.

Returns:

the current HTTPRequestBuilder object.

setPort

public HTTPRequestBuilder setPort(int port)

This sets the port to use in the buildHTTPAddress() method. If not set the default port for the protocol type (http or https) will be used.

Parameters:

port - port number to set.

Returns:

the current HTTPRequestBuilder object.

setBody

public HTTPRequestBuilder setBody(java.nio.ByteBuffer bb)

setBody

public HTTPRequestBuilder setBody(java.lang.String str)

setBody

public HTTPRequestBuilder setBody(java.lang.String str,
                                  java.nio.charset.Charset cs)

setTimeout

public HTTPRequestBuilder setTimeout(long size,
                                     java.util.concurrent.TimeUnit unit)

duplicate

public HTTPRequestBuilder duplicate()

Creates an independent copy of this HTTPRequestBuilder.

Returns:

a new HTTPRequestBuilder object with all the same values set.

setHeader

public HTTPRequestBuilder setHeader(java.lang.String key,
                                    java.lang.String value)

Set a header on the HTTPRequest.

Parameters:

key - the key for the header.

value - the value in the header.

Returns:

the current HTTPRequestBuilder object.

removeHeader

public HTTPRequestBuilder removeHeader(java.lang.String key)

Removes a header on the HTTPRequest.

Parameters:

key - the key for the header to remove.

Returns:

the current HTTPRequestBuilder object.

replaceHTTPHeaders

public HTTPRequestBuilder replaceHTTPHeaders(HTTPHeaders hh)

Replaces all the HTTPHeaders for this HTTPRequestBuilder with the ones provided.

Parameters:

hh - the HTTPHeaders object to set.

Returns:

the current HTTPRequestBuilder object.

setRequestMethod

public HTTPRequestBuilder setRequestMethod(HTTPRequestMethod rm)

Sets the HTTPRequestMethod for this request. This uses the standard http request methods enum.

Parameters:

rm - the http request method to set this request too.

Returns:

the current HTTPRequestBuilder object.

buildHTTPAddress

public HTTPAddress buildHTTPAddress()

Builds an HTTPAddress object from the set host/port name.

Returns:

a new HTTPAddress object with host/port/ssl arguments set.

buildClientHTTPRequest

public ClientHTTPRequest buildClientHTTPRequest()

buildHTTPRequest

public HTTPRequest buildHTTPRequest()

Builds an Immutable HTTPRequest object that can be used to send a request.

Returns:

an Immutable HTTPRequest object