com.yahoo.container.jdisc

Class HttpRequest.Builder

java.lang.Object

com.yahoo.container.jdisc.HttpRequest.Builder

Enclosing class:

HttpRequest

public static class HttpRequest.Builder
extends Object

Builder of HTTP requests

Field Summary

Fields

Modifier and Type	Field and Description
(package private) com.yahoo.jdisc.service.CurrentContainer	container
private com.yahoo.jdisc.http.HttpRequest	jdiscRequest
(package private) com.yahoo.jdisc.http.HttpRequest.Method	method
private String	nag
private HttpRequest	parent
(package private) Map<String,String>	properties
(package private) SocketAddress	remoteAddress
(package private) InputStream	requestData
(package private) URI	uri
(package private) com.yahoo.jdisc.http.HttpRequest.Version	version

Constructor Summary

Constructors

Modifier	Constructor and Description
	Builder(HttpRequest request) Instantiate a request builder with defaults from an existing request.
	Builder(com.yahoo.jdisc.http.HttpRequest request) Instantiate a request builder with defaults from an existing request.
private	Builder(HttpRequest parent, com.yahoo.jdisc.http.HttpRequest jdiscRequest)

Method Summary

Modifier and Type	Method and Description
private void	boom(Object ref, String what)
HttpRequest	createClientRequest() Start of API for synchronous HTTP request dispatch.
HttpRequest	createDirectRequest() Create a new HTTP request without creating a new JDisc request.
HttpRequest	createServerRequest() Start of API for synchronous HTTP request dispatch.
private void	ensureJdiscParent()
private void	ensureRequestData()
HttpRequest.Builder	jdiscRequest(com.yahoo.jdisc.http.HttpRequest request) Define the JDisc parent request.
HttpRequest.Builder	method(com.yahoo.jdisc.http.HttpRequest.Method method) Set the HTTP method for the new request.
private void	populateProperties()
HttpRequest.Builder	put(String key, String value) Add a parameter to the request.
HttpRequest.Builder	removeProperty(String parameterName) Removes the parameter from the request properties.
HttpRequest.Builder	requestData(InputStream requestData) Set an inputstream to use for the request.
private void	requireContainer()
private void	requireUri()
private void	setParameters(com.yahoo.jdisc.http.HttpRequest request)
HttpRequest.Builder	uri(URI uri) Set the URI of the server request created.

Methods inherited from class java.lang.Object

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

Field Detail

parent

private final HttpRequest parent

jdiscRequest

private com.yahoo.jdisc.http.HttpRequest jdiscRequest

method

com.yahoo.jdisc.http.HttpRequest.Method method

version

com.yahoo.jdisc.http.HttpRequest.Version version

properties

Map<String,String> properties

requestData

InputStream requestData

uri

URI uri

container

com.yahoo.jdisc.service.CurrentContainer container

nag

private String nag

remoteAddress

SocketAddress remoteAddress

Constructor Detail

Builder

public Builder(HttpRequest request)

Instantiate a request builder with defaults from an existing request. If the request is null, a JDisc request must be set explitly using jdiscRequest(com.yahoo.jdisc.http.HttpRequest) before instantiating any HTTP request.

Parameters:

request - source for defaults and parent JDisc request, may be null

See Also:

HttpRequest.createTestRequest(String, com.yahoo.jdisc.http.HttpRequest.Method)

Builder

public Builder(com.yahoo.jdisc.http.HttpRequest request)

Instantiate a request builder with defaults from an existing request.

Parameters:

request - parent JDisc request

See Also:

HttpRequest.createTestRequest(String, com.yahoo.jdisc.http.HttpRequest.Method)

Builder

private Builder(HttpRequest parent,
                com.yahoo.jdisc.http.HttpRequest jdiscRequest)

Method Detail

boom

private void boom(Object ref,
                  String what)

requireUri

private void requireUri()

requireContainer

private void requireContainer()

ensureJdiscParent

private void ensureJdiscParent()

ensureRequestData

private void ensureRequestData()

populateProperties

private void populateProperties()

put

public HttpRequest.Builder put(String key,
                               String value)

Add a parameter to the request. Multi-value parameters are not supported.

Parameters:

key - parameter name

value - parameter value

Returns:

this Builder instance

removeProperty

public HttpRequest.Builder removeProperty(String parameterName)

Removes the parameter from the request properties. If there is no such parameter, nothing will be done.

method

public HttpRequest.Builder method(com.yahoo.jdisc.http.HttpRequest.Method method)

Set the HTTP method for the new request.

Parameters:

method - the HTTP method to use for the new request

Returns:

this Builder instance

jdiscRequest

public HttpRequest.Builder jdiscRequest(com.yahoo.jdisc.http.HttpRequest request)

Define the JDisc parent request.

Parameters:

request - a valid JDisc request for the current container

Returns:

this Builder instance

requestData

public HttpRequest.Builder requestData(InputStream requestData)

Set an inputstream to use for the request. If not set, the data from the original HttpRequest is used.

Parameters:

requestData - data to be consumed, e.g. POST data

Returns:

this Builder instance

uri

public HttpRequest.Builder uri(URI uri)

Set the URI of the server request created.

Parameters:

uri - a valid URI for a server request

Returns:

this Builder instance

createDirectRequest

public HttpRequest createDirectRequest()

Create a new HTTP request without creating a new JDisc request. This is for scenarios where another HTTP request handler is invoked directly without dispatching through JDisc. The parent JDisc request for the original HttpRequest will be passed on the new HttpRequest instance's JDisc request, but no properties will be propagated into the original JDisc request.

Returns:

a new HttpRequest instance reflecting the given request data and parameters

createClientRequest

public HttpRequest createClientRequest()

Start of API for synchronous HTTP request dispatch. Not yet ready for use.

Returns:

a new client request

createServerRequest

public HttpRequest createServerRequest()

Start of API for synchronous HTTP request dispatch. Not yet ready for use.

Returns:

a new server request

setParameters

private void setParameters(com.yahoo.jdisc.http.HttpRequest request)