org.qas.api.support

Class RequestSupport

java.lang.Object

org.qas.api.support.RequestSupport

All Implemented Interfaces:

Request

public class RequestSupport
extends java.lang.Object
implements Request

RequestSupport

Since:

1.0

Constructor Summary

Constructors

Constructor and Description
RequestSupport(ApiServiceRequest originalRequest, java.lang.String serviceName) Creates the RequestSupport object from the given service name.

Method Summary

Modifier and Type	Method and Description
void	addParameter(java.lang.String name, java.lang.String value) Adds the specified request parameter to this request.
java.io.InputStream	getContent()
java.net.URI	getEndpoint()
java.util.Map<java.lang.String,java.lang.String>	getHeaders()
HttpMethod	getHttpMethod()
ApiServiceRequest	getOriginalRequest() Returns the original, user facing request object which this basic request object is representing.
java.util.Map<java.lang.String,java.lang.String>	getParameters()
java.lang.String	getResourcePath()
java.lang.String	getServiceName()
int	getTimeOffset()
void	setContent(java.io.InputStream content) Sets the optional stream containing the payload data to include for this request.
void	setEndpoint(java.net.URI endpoint) Sets the service endpoint to which this request should be sent.
void	setHeader(java.lang.String name, java.lang.String value) Adds the specified header to this request.
void	setHeaders(java.util.Map<java.lang.String,java.lang.String> headers) Sets all headers, clearing any existing ones.
void	setHttpMethod(HttpMethod httpMethod) Sets the HTTP method to use when sending this request.
void	setParameters(java.util.Map<java.lang.String,java.lang.String> parameters) Sets all parameters, clearing any existing values.
void	setResourcePath(java.lang.String resourcePath) Sets the path to the resource being requested.
void	setTimeOffset(int timeOffset) Sets the optional value for time offset for this request.
java.lang.String	toString()
Request	withContent(java.io.InputStream content) Sets the optional stream containing the payload data to include for this request.
Request	withEndpoint(java.net.URI endpoint) Sets the service endpoint to which this request should be sent, and returns the updated Request object.
Request	withHeader(java.lang.String name, java.lang.String value) Adds the specified header to this request and returns the updated Request object.
Request	withHeaders(java.util.Map<java.lang.String,java.lang.String> headers) Sets all headers, clearing any existing ones and returns the updated Request object.
Request	withHttpMethod(HttpMethod httpMethod) Sets the HTTP method to use when sending this request and returns the updated Request object.
Request	withParameter(java.lang.String name, java.lang.String value) Adds the specified request parameter to this request and returns the updated Request object.
Request	withParameters(java.util.Map<java.lang.String,java.lang.String> parameters) Sets all parameters, clearing any existing values and return the updated Request object.
Request	withResourcePath(java.lang.String resourcePath) Sets the path to the resource being requested and returns the updated Request object.
Request	withTimeOffset(int timeOffset) Sets the optional value for time offset for this request.

Methods inherited from class java.lang.Object

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

Constructor Detail

RequestSupport

public RequestSupport(ApiServiceRequest originalRequest,
                      java.lang.String serviceName)

Creates the RequestSupport object from the given service name.

Parameters:

serviceName - the given service name.

Method Detail

getServiceName

public java.lang.String getServiceName()

Specified by:

getServiceName in interface Request

Returns:

the name of the service this request is for.

getResourcePath

public java.lang.String getResourcePath()

Specified by:

getResourcePath in interface Request

Returns:

the path to the resource being requested.

setResourcePath

public void setResourcePath(java.lang.String resourcePath)

Description copied from interface: Request

Sets the path to the resource being requested.

Specified by:

setResourcePath in interface Request

Parameters:

resourcePath - the path to the resource being requested.

withResourcePath

public Request withResourcePath(java.lang.String resourcePath)

Description copied from interface: Request

Sets the path to the resource being requested and returns the updated Request object.

Specified by:

withResourcePath in interface Request

Parameters:

resourcePath - the path to the resource being requested.

Returns:

the updated Request object with a new resource path.

getHttpMethod

public HttpMethod getHttpMethod()

Specified by:

getHttpMethod in interface Request

Returns:

the HTTP method to use when sending this request.

setHttpMethod

public void setHttpMethod(HttpMethod httpMethod)

Description copied from interface: Request

Sets the HTTP method to use when sending this request.

Specified by:

setHttpMethod in interface Request

Parameters:

httpMethod - the HTTP method to use when sending this request.

withHttpMethod

public Request withHttpMethod(HttpMethod httpMethod)

Description copied from interface: Request

Sets the HTTP method to use when sending this request and returns the updated Request object.

Specified by:

withHttpMethod in interface Request

Parameters:

httpMethod - the HTTP method to use when sending this request.

Returns:

the updated Request object with a new http method.

setEndpoint

public void setEndpoint(java.net.URI endpoint)

Description copied from interface: Request

Sets the service endpoint to which this request should be sent.

Specified by:

setEndpoint in interface Request

Parameters:

endpoint - The service endpoint to which this request should be sent.

getEndpoint

public java.net.URI getEndpoint()

Specified by:

getEndpoint in interface Request

Returns:

the service endpoint to which this request should be sent.

withEndpoint

public Request withEndpoint(java.net.URI endpoint)

Description copied from interface: Request

Sets the service endpoint to which this request should be sent, and returns the updated Request object.

Specified by:

withEndpoint in interface Request

Parameters:

endpoint - the service endpoint to which this request should be sent.

Returns:

the updated Request object with a new endpoint.

setTimeOffset

public void setTimeOffset(int timeOffset)

Description copied from interface: Request

Sets the optional value for time offset for this request. This will be used by the signer to adjust for potential clock skew. Value is in seconds, positive values imply the current clock is "fast", negative values imply clock is slow.

Specified by:

setTimeOffset in interface Request

Parameters:

timeOffset - The optional value for time offset for this request.

getTimeOffset

public int getTimeOffset()

Specified by:

getTimeOffset in interface Request

Returns:

optional value for time offset for this request.

withTimeOffset

public Request withTimeOffset(int timeOffset)

Description copied from interface: Request

Sets the optional value for time offset for this request. This will be used by the signer to adjust for potential clock skew. Value is in seconds, positive values imply the current clock is "fast", negative values imply clock is slow and returns the updated Request object.

Specified by:

withTimeOffset in interface Request

Parameters:

timeOffset - The optional value for time offset for this request.

Returns:

the updated Request object with a new time offset.

setContent

public void setContent(java.io.InputStream content)

Description copied from interface: Request

Sets the optional stream containing the payload data to include for this request. Not all requests will contain payload data.

Specified by:

setContent in interface Request

Parameters:

content - the optional stream containing the payload data to include for request.

getContent

public java.io.InputStream getContent()

Specified by:

getContent in interface Request

Returns:

The optional stream containing the payload data to include for this request.

withContent

public Request withContent(java.io.InputStream content)

Description copied from interface: Request

Sets the optional stream containing the payload data to include for this request. Not all requests will contain payload data and returns the updated Request object.

Specified by:

withContent in interface Request

Parameters:

content - the optional stream containing the payload data to include for request.

Returns:

the updated Request object with a new content.

setHeader

public void setHeader(java.lang.String name,
                      java.lang.String value)

Description copied from interface: Request

Adds the specified header to this request.

Specified by:

setHeader in interface Request

Parameters:

name - the name of the header to add.

value - the header's value.

setHeaders

public void setHeaders(java.util.Map<java.lang.String,java.lang.String> headers)

Description copied from interface: Request

Sets all headers, clearing any existing ones.

Specified by:

setHeaders in interface Request

Parameters:

headers - the given map of headers to set.

withHeader

public Request withHeader(java.lang.String name,
                          java.lang.String value)

Description copied from interface: Request

Adds the specified header to this request and returns the updated Request object.

Specified by:

withHeader in interface Request

Parameters:

name - the name of the header to add.

value - the header's value.

Returns:

the updated Request object with a new header.

withHeaders

public Request withHeaders(java.util.Map<java.lang.String,java.lang.String> headers)

Description copied from interface: Request

Sets all headers, clearing any existing ones and returns the updated Request object.

Specified by:

withHeaders in interface Request

Parameters:

headers - the given map of headers to set.

Returns:

the updated Request object with a new headers.

getHeaders

public java.util.Map<java.lang.String,java.lang.String> getHeaders()

Specified by:

getHeaders in interface Request

Returns:

A map of all headers include in this request.

addParameter

public void addParameter(java.lang.String name,
                         java.lang.String value)

Description copied from interface: Request

Adds the specified request parameter to this request.

Specified by:

addParameter in interface Request

Parameters:

name - the name of the request parameter.

value - the value of the request parameter.

withParameter

public Request withParameter(java.lang.String name,
                             java.lang.String value)

Description copied from interface: Request

Adds the specified request parameter to this request and returns the updated Request object.

Specified by:

withParameter in interface Request

Parameters:

name - the name of the request parameter.

value - the value of the request parameter.

Returns:

the updated Request object with a new parameter.

setParameters

public void setParameters(java.util.Map<java.lang.String,java.lang.String> parameters)

Description copied from interface: Request

Sets all parameters, clearing any existing values.

Specified by:

setParameters in interface Request

Parameters:

parameters - the map of parameters to set.

withParameters

public Request withParameters(java.util.Map<java.lang.String,java.lang.String> parameters)

Description copied from interface: Request

Sets all parameters, clearing any existing values and return the updated Request object.

Specified by:

withParameters in interface Request

Parameters:

parameters - the map of parameters to set.

Returns:

the updated Request object with new map of parameters.

getParameters

public java.util.Map<java.lang.String,java.lang.String> getParameters()

Specified by:

getParameters in interface Request

Returns:

A map of all parameters in this request.

getOriginalRequest

public ApiServiceRequest getOriginalRequest()

Description copied from interface: Request

Returns the original, user facing request object which this basic request object is representing.

Specified by:

getOriginalRequest in interface Request

Returns:

the original, user facing request object which this basic request object is representing.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object