org.qas.api.http.basic

Class HttpUrlConnectionRequest

java.lang.Object

org.qas.api.http.AbstractHttpRequest<java.net.HttpURLConnection>

org.qas.api.http.basic.HttpUrlConnectionRequest

All Implemented Interfaces:

HttpRequest<java.net.HttpURLConnection>

public final class HttpUrlConnectionRequest
extends AbstractHttpRequest<java.net.HttpURLConnection>
implements HttpRequest<java.net.HttpURLConnection>

HttpUrlConnectionRequest

Since:

1.0

Field Summary

Fields inherited from class org.qas.api.http.AbstractHttpRequest

request

Constructor Summary

Constructors

Constructor and Description
HttpUrlConnectionRequest(Request request, java.net.HttpURLConnection connection) Constructs HttpUrlConnectionRequest associated with the specified request and connection.

Method Summary

Modifier and Type	Method and Description
int	getContentLength()
java.lang.String	getContentType()
java.net.HttpURLConnection	getUnderlying()
HttpUrlConnectionRequest	withContent(java.io.InputStream content) Sets the optional stream containing the payload data to include for this request.
HttpUrlConnectionRequest	withHeader(java.lang.String name, java.lang.String value) Adds the specified header to this request and returns the updated HttpRequest object.
HttpUrlConnectionRequest	withHeaders(java.util.Map<java.lang.String,java.lang.String> headers) Sets all headers, clearing any existing ones and returns the updated HttpRequest object.
HttpUrlConnectionRequest	withHttpMethod(HttpMethod httpMethod) Sets the HTTP method to use when sending this request and returns the updated HttpRequest object.
HttpUrlConnectionRequest	withParameter(java.lang.String name, java.lang.String value) Adds the specified request parameter to this request and returns the updated HttpRequest object.
HttpUrlConnectionRequest	withParameters(java.util.Map<java.lang.String,java.lang.String> parameters) Sets all parameters, clearing any existing values and return the updated HttpRequest object.
HttpUrlConnectionRequest	withResourcePath(java.lang.String resourcePath) Sets the path to the resource being requested and returns the updated HttpRequest object.
HttpUrlConnectionRequest	withTimeOffset(int timeOffset) Sets the optional value for time offset for this request.

Methods inherited from class org.qas.api.http.AbstractHttpRequest

addParameter, getContent, getEndpoint, getHeaders, getHttpMethod, getOriginalRequest, getParameters, getResourcePath, getServiceName, getTimeOffset, setContent, setHeader, setHeaders, setHttpMethod, setParameters, setResourcePath, setTimeOffset, 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

addParameter, getContent, getEndpoint, getHeaders, getHttpMethod, getOriginalRequest, getParameters, getResourcePath, getServiceName, getTimeOffset, setContent, setHeader, setHeaders, setHttpMethod, setParameters, setResourcePath, setTimeOffset

Constructor Detail

HttpUrlConnectionRequest

public HttpUrlConnectionRequest(Request request,
                                java.net.HttpURLConnection connection)

Constructs HttpUrlConnectionRequest associated with the specified request and connection.

Parameters:

request - the associated request that generated this request.

connection - the associated connection that generated this request.

Method Detail

getUnderlying

public java.net.HttpURLConnection getUnderlying()

Specified by:

getUnderlying in interface HttpRequest<java.net.HttpURLConnection>

Returns:

HTTP request underlying object.

withHttpMethod

public HttpUrlConnectionRequest withHttpMethod(HttpMethod httpMethod)

Description copied from interface: HttpRequest

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

Specified by:

withHttpMethod in interface HttpRequest<java.net.HttpURLConnection>

Parameters:

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

Returns:

the updated HttpRequest object with a new http method.

withContent

public HttpUrlConnectionRequest withContent(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 and returns the updated HttpRequest object.

Specified by:

withContent in interface HttpRequest<java.net.HttpURLConnection>

Parameters:

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

Returns:

the updated HttpRequest object with a new content.

getContentLength

public int getContentLength()

Specified by:

getContentLength in interface HttpRequest<java.net.HttpURLConnection>

Returns:

HTTP request content length.

withTimeOffset

public HttpUrlConnectionRequest withTimeOffset(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 and returns the updated HttpRequest object.

Specified by:

withTimeOffset in interface HttpRequest<java.net.HttpURLConnection>

Parameters:

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

Returns:

the updated HttpRequest object with a new time offset.

getContentType

public java.lang.String getContentType()

Specified by:

getContentType in interface HttpRequest<java.net.HttpURLConnection>

Returns:

HTTP request content type.

withResourcePath

public HttpUrlConnectionRequest withResourcePath(java.lang.String resourcePath)

Description copied from interface: HttpRequest

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

Specified by:

withResourcePath in interface HttpRequest<java.net.HttpURLConnection>

Parameters:

resourcePath - the path to the resource being requested.

Returns:

the updated HttpRequest object with a new resource path.

withHeader

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

Description copied from interface: HttpRequest

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

Specified by:

withHeader in interface HttpRequest<java.net.HttpURLConnection>

Parameters:

name - the name of the header to add.

value - the header's value.

Returns:

the updated HttpRequest object with a new header.

withHeaders

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

Description copied from interface: HttpRequest

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

Specified by:

withHeaders in interface HttpRequest<java.net.HttpURLConnection>

Parameters:

headers - the given map of headers to set.

Returns:

the updated HttpRequest object with a new headers.

withParameter

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

Description copied from interface: HttpRequest

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

Specified by:

withParameter in interface HttpRequest<java.net.HttpURLConnection>

Parameters:

name - the name of the request parameter.

value - the value of the request parameter.

Returns:

the updated HttpRequest object with a new parameter.

withParameters

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

Description copied from interface: HttpRequest

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

Specified by:

withParameters in interface HttpRequest<java.net.HttpURLConnection>

Parameters:

parameters - the map of parameters to set.

Returns:

the updated HttpRequest object with new map of parameters.