org.qas.api.http

Class AbstractHttpRequest<T>

java.lang.Object

org.qas.api.http.AbstractHttpRequest<T>

All Implemented Interfaces:

HttpRequest<T>

Direct Known Subclasses:

HttpUrlConnectionRequest

public abstract class AbstractHttpRequest<T>
extends java.lang.Object
implements HttpRequest<T>

AbstractHttpRequest

Since:

1.0

Field Summary

Fields

Modifier and Type	Field and Description
protected Request	request

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractHttpRequest(Request request)

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	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()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.qas.api.http.HttpRequest

getContentLength, getContentType, getUnderlying, withContent, withHeader, withHeaders, withHttpMethod, withParameter, withParameters, withResourcePath, withTimeOffset

Field Detail

request

protected final Request request

Constructor Detail

AbstractHttpRequest

protected AbstractHttpRequest(Request request)

Method Detail

getHttpMethod

public HttpMethod getHttpMethod()

Specified by:

getHttpMethod in interface HttpRequest<T>

Returns:

the HTTP method to use when sending this request.

setHttpMethod

public void setHttpMethod(HttpMethod httpMethod)

Description copied from interface: HttpRequest

Sets the HTTP method to use when sending this request.

Specified by:

setHttpMethod in interface HttpRequest<T>

Parameters:

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

getContent

public java.io.InputStream getContent()

Specified by:

getContent in interface HttpRequest<T>

Returns:

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

setContent

public void setContent(java.io.InputStream content)

Description copied from interface: HttpRequest

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 HttpRequest<T>

Parameters:

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

getTimeOffset

public int getTimeOffset()

Specified by:

getTimeOffset in interface HttpRequest<T>

Returns:

optional value for time offset for this request.

setTimeOffset

public void setTimeOffset(int timeOffset)

Description copied from interface: HttpRequest

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 HttpRequest<T>

Parameters:

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

getResourcePath

public java.lang.String getResourcePath()

Specified by:

getResourcePath in interface HttpRequest<T>

Returns:

the path to the resource being requested.

setResourcePath

public void setResourcePath(java.lang.String resourcePath)

Description copied from interface: HttpRequest

Sets the path to the resource being requested.

Specified by:

setResourcePath in interface HttpRequest<T>

Parameters:

resourcePath - the path to the resource being requested.

getServiceName

public java.lang.String getServiceName()

Specified by:

getServiceName in interface HttpRequest<T>

Returns:

the name of the service this request is for.

getEndpoint

public java.net.URI getEndpoint()

Specified by:

getEndpoint in interface HttpRequest<T>

Returns:

the service endpoint to which this request should be sent.

getHeaders

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

Specified by:

getHeaders in interface HttpRequest<T>

Returns:

A map of all headers include in this request.

setHeader

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

Description copied from interface: HttpRequest

Adds the specified header to this request.

Specified by:

setHeader in interface HttpRequest<T>

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: HttpRequest

Sets all headers, clearing any existing ones.

Specified by:

setHeaders in interface HttpRequest<T>

Parameters:

headers - the given map of headers to set.

getParameters

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

Specified by:

getParameters in interface HttpRequest<T>

Returns:

A map of all parameters in this request.

setParameters

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

Description copied from interface: HttpRequest

Sets all parameters, clearing any existing values.

Specified by:

setParameters in interface HttpRequest<T>

Parameters:

parameters - the map of parameters to set.

addParameter

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

Description copied from interface: HttpRequest

Adds the specified request parameter to this request.

Specified by:

addParameter in interface HttpRequest<T>

Parameters:

name - the name of the request parameter.

value - the value of the request parameter.

getOriginalRequest

public ApiServiceRequest getOriginalRequest()

Description copied from interface: HttpRequest

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

Specified by:

getOriginalRequest in interface HttpRequest<T>

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