com.amazonaws

Class DefaultRequest<T>

java.lang.Object

com.amazonaws.DefaultRequest<T>

Type Parameters:

T - class type.

All Implemented Interfaces:

Request<T>

public class DefaultRequest<T>
extends java.lang.Object
implements Request<T>

Default implementation of the Request interface.

This class is only intended for internal use inside the AWS client libraries. Callers shouldn't ever interact directly with objects of this class.

Constructor Summary

Constructors

Constructor and Description
DefaultRequest(AmazonWebServiceRequest originalRequest, java.lang.String serviceName) Constructs a new DefaultRequest with the specified service name and the original, user facing request object.
DefaultRequest(java.lang.String serviceName) Constructs a new DefaultRequest with the specified service name and no specified original, user facing request object.

Method Summary

Modifier and Type	Method and Description
void	addHeader(java.lang.String name, java.lang.String value) Sets the specified header for this request.
void	addParameter(java.lang.String name, java.lang.String value) Adds the specified request parameter to this request.
AWSRequestMetrics	getAWSRequestMetrics() Deprecated.
java.io.InputStream	getContent() Returns the optional stream containing the payload data to include for this request.
java.lang.String	getEncodedUriResourcePath() Get Encoded Uri Resource Path
java.net.URI	getEndpoint() Returns the service endpoint (ex: "https://ec2.amazonaws.com") to which this request should be sent.
java.util.Map<java.lang.String,java.lang.String>	getHeaders() Returns a map of all the headers included in this request.
java.lang.String	getHostPrefix() Returns the optional prefix to prepend to the request endpoint's host before sending this request.
HttpMethodName	getHttpMethod() Returns the HTTP method (GET, POST, etc) to use when sending this request.
AmazonWebServiceRequest	getOriginalRequest() Returns the original, user facing request object which this internal request object is representing.
java.util.Map<java.lang.String,java.lang.String>	getParameters() Returns a map of all parameters in this request.
java.lang.String	getResourcePath() Returns the path to the resource being requested.
java.lang.String	getServiceName() Returns the name of the Amazon service this request is for.
long	getTimeOffset() Returns the optional value for time offset for this request.
boolean	isStreaming() Flag that indicates that request is streaming request
void	setAWSRequestMetrics(AWSRequestMetrics metrics) Deprecated.
void	setContent(java.io.InputStream content) Sets the optional stream containing the payload data to include for this request.
void	setEncodedResourcePath(java.lang.String encodedUriResourcePath) Set Encoded Uri Resource Path
void	setEndpoint(java.net.URI endpoint) Sets the service endpoint (ex: "https://ec2.amazonaws.com") to which this request should be sent.
void	setHeaders(java.util.Map<java.lang.String,java.lang.String> headers) Sets all headers, clearing any existing ones.
void	setHostPrefix(java.lang.String hostPrefix) Sets the optional prefix to prepend to the request endpoint's host before sending this request.
void	setHttpMethod(HttpMethodName httpMethod) Sets the HTTP method (GET, POST, etc) 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	setStreaming(boolean streaming) Set streaming flag
void	setTimeOffset(int timeOffset) Deprecated.
void	setTimeOffset(long timeOffset) Sets the optional value for time offset for this request.
java.lang.String	toString()
Request<T>	withParameter(java.lang.String name, java.lang.String value) Adds the specified request parameter to this request, and returns the updated request object.
Request<T>	withTimeOffset(int timeOffset) Deprecated.
Request<T>	withTimeOffset(long 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

DefaultRequest

public DefaultRequest(AmazonWebServiceRequest originalRequest,
                      java.lang.String serviceName)

Constructs a new DefaultRequest with the specified service name and the original, user facing request object.

Parameters:

serviceName - The name of the service to which this request is being sent.

originalRequest - The original, user facing, AWS request being represented by this internal request object.

DefaultRequest

public DefaultRequest(java.lang.String serviceName)

Constructs a new DefaultRequest with the specified service name and no specified original, user facing request object.

Parameters:

serviceName - The name of the service to which this request is being sent.

Method Detail

getOriginalRequest

public AmazonWebServiceRequest getOriginalRequest()

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

Specified by:

getOriginalRequest in interface Request<T>

Returns:

The original, user facing request object which this request object is representing.

addHeader

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

Sets the specified header for this request.

Specified by:

addHeader in interface Request<T>

Parameters:

name - The name of the header to set.

value - The header's value.

getHeaders

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

Returns a map of all the headers included in this request.

Specified by:

getHeaders in interface Request<T>

Returns:

A map of all the headers included in this request.

setResourcePath

public void setResourcePath(java.lang.String resourcePath)

Sets the path to the resource being requested.

Specified by:

setResourcePath in interface Request<T>

Parameters:

resourcePath - The path to the resource being requested.

getResourcePath

public java.lang.String getResourcePath()

Returns the path to the resource being requested.

Specified by:

getResourcePath in interface Request<T>

Returns:

The path to the resource being requested.

addParameter

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

Adds the specified request parameter to this request.

Specified by:

addParameter in interface Request<T>

Parameters:

name - The name of the request parameter.

value - The value of the request parameter.

getParameters

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

Returns a map of all parameters in this request.

Specified by:

getParameters in interface Request<T>

Returns:

A map of all parameters in this request.

withParameter

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

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

Specified by:

withParameter in interface Request<T>

Parameters:

name - The name of the request parameter.

value - The value of the request parameter.

Returns:

The updated request object.

getHttpMethod

public HttpMethodName getHttpMethod()

Returns the HTTP method (GET, POST, etc) to use when sending this request.

Specified by:

getHttpMethod in interface Request<T>

Returns:

The HTTP method to use when sending this request.

setHttpMethod

public void setHttpMethod(HttpMethodName httpMethod)

Sets the HTTP method (GET, POST, etc) to use when sending this request.

Specified by:

setHttpMethod in interface Request<T>

Parameters:

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

setEndpoint

public void setEndpoint(java.net.URI endpoint)

Sets the service endpoint (ex: "https://ec2.amazonaws.com") to which this request should be sent.

Specified by:

setEndpoint in interface Request<T>

Parameters:

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

getEndpoint

public java.net.URI getEndpoint()

Returns the service endpoint (ex: "https://ec2.amazonaws.com") to which this request should be sent.

Specified by:

getEndpoint in interface Request<T>

Returns:

The service endpoint to which this request should be sent.

getServiceName

public java.lang.String getServiceName()

Returns the name of the Amazon service this request is for.

Specified by:

getServiceName in interface Request<T>

Returns:

The name of the Amazon service this request is for.

getContent

public java.io.InputStream getContent()

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

Specified by:

getContent in interface Request<T>

Returns:

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

setContent

public void setContent(java.io.InputStream content)

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

Parameters:

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

setHeaders

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

Sets all headers, clearing any existing ones.

Specified by:

setHeaders in interface Request<T>

Parameters:

headers - the headers.

setParameters

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

Sets all parameters, clearing any existing values.

Specified by:

setParameters in interface Request<T>

Parameters:

parameters - the parameters.

getHostPrefix

public java.lang.String getHostPrefix()

Returns the optional prefix to prepend to the request endpoint's host before sending this request.

Specified by:

getHostPrefix in interface Request<T>

Returns:

the optional prefix to prepend to the request endpoint host before sending this request.

setHostPrefix

public void setHostPrefix(java.lang.String hostPrefix)

Sets the optional prefix to prepend to the request endpoint's host before sending this request.

Specified by:

setHostPrefix in interface Request<T>

Parameters:

hostPrefix - The optional prefix to prepend to the request endpoint host.

getTimeOffset

public long getTimeOffset()

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

getTimeOffset in interface Request<T>

Returns:

The optional value for time offset (in seconds) for this request.

setTimeOffset

@Deprecated
public void setTimeOffset(int timeOffset)

Deprecated.

This is deprecated, use Request.setTimeOffset(long) instead.

Specified by:

setTimeOffset in interface Request<T>

Parameters:

timeOffset - The optional value for time offset (in seconds) for this request.

setTimeOffset

public void setTimeOffset(long timeOffset)

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

Parameters:

timeOffset - The optional value for time offset (in seconds) for this request.

withTimeOffset

@Deprecated
public Request<T> withTimeOffset(int timeOffset)

Deprecated.

This is deprecated, use Request.withTimeOffset(long) instead.

Specified by:

withTimeOffset in interface Request<T>

Parameters:

timeOffset - the time offset for the request.

Returns:

The updated request object.

withTimeOffset

public Request<T> withTimeOffset(long timeOffset)

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:

withTimeOffset in interface Request<T>

Parameters:

timeOffset - the time offset for the request.

Returns:

The updated request object.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getAWSRequestMetrics

@Deprecated
public AWSRequestMetrics getAWSRequestMetrics()

Deprecated.

Specified by:

getAWSRequestMetrics in interface Request<T>

Returns:

the request metrics.

setAWSRequestMetrics

@Deprecated
public void setAWSRequestMetrics(AWSRequestMetrics metrics)

Deprecated.

Description copied from interface: Request

Bind the request metrics to the request. Note metrics can be captured before the request is created.

Specified by:

setAWSRequestMetrics in interface Request<T>

Parameters:

metrics - the request metrics.

isStreaming

public boolean isStreaming()

Description copied from interface: Request

Flag that indicates that request is streaming request

Specified by:

isStreaming in interface Request<T>

Returns:

true if request is streaming request.

setStreaming

public void setStreaming(boolean streaming)

Description copied from interface: Request

Set streaming flag

Specified by:

setStreaming in interface Request<T>

Parameters:

streaming - the streaming flag.

getEncodedUriResourcePath

public java.lang.String getEncodedUriResourcePath()

Description copied from interface: Request

Get Encoded Uri Resource Path

Specified by:

getEncodedUriResourcePath in interface Request<T>

setEncodedResourcePath

public void setEncodedResourcePath(java.lang.String encodedUriResourcePath)

Description copied from interface: Request

Set Encoded Uri Resource Path

Specified by:

setEncodedResourcePath in interface Request<T>

Parameters:

encodedUriResourcePath - encoded uri resource path