com.amazonaws

Interface Request<T>

Type Parameters:

T - The type of original, user facing request represented by this request.

All Known Implementing Classes:

DefaultRequest

public interface Request<T>

Represents a request being sent to an Amazon Web Service, including the parameters being sent as part of the request, the endpoint to which the request should be sent, etc.

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

Method Summary

Methods

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() Returns the request metrics.
java.io.InputStream	getContent() Returns the optional stream containing the payload data to include for this request.
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.
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.
int	getTimeOffset() Returns the optional value for time offset for this request.
void	setAWSRequestMetrics(AWSRequestMetrics metrics) Bind the request metrics to the request.
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 (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	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 path) Sets the path to the resource being requested.
void	setTimeOffset(int timeOffset) Sets the optional value for time offset for this request.
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) Sets the optional value for time offset for this request.

Method Detail

addHeader

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

Sets the specified header for this request.

Parameters:

name - The name of the header to set.

value - The header's value.

getHeaders

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

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

Returns:

A map of all the headers included in this request.

setHeaders

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

Sets all headers, clearing any existing ones.

setResourcePath

void setResourcePath(java.lang.String path)

Sets the path to the resource being requested.

Parameters:

path - The path to the resource being requested.

getResourcePath

java.lang.String getResourcePath()

Returns the path to the resource being requested.

Returns:

The path to the resource being requested.

addParameter

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

Adds the specified request parameter to this request.

Parameters:

name - The name of the request parameter.

value - The value of the request parameter.

withParameter

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.

Parameters:

name - The name of the request parameter.

value - The value of the request parameter.

Returns:

The updated request object.

getParameters

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

Returns a map of all parameters in this request.

Returns:

A map of all parameters in this request.

setParameters

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

Sets all parameters, clearing any existing values.

getEndpoint

java.net.URI getEndpoint()

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

Returns:

The service endpoint to which this request should be sent.

setEndpoint

void setEndpoint(java.net.URI endpoint)

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

Parameters:

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

getHttpMethod

HttpMethodName getHttpMethod()

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

Returns:

The HTTP method to use when sending this request.

setHttpMethod

void setHttpMethod(HttpMethodName httpMethod)

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

Parameters:

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

getContent

java.io.InputStream getContent()

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

Returns:

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

setContent

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.

Parameters:

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

getServiceName

java.lang.String getServiceName()

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

Returns:

The name of the Amazon service this request is for.

getOriginalRequest

AmazonWebServiceRequest getOriginalRequest()

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

Returns:

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

getTimeOffset

int 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.

Returns:

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

setTimeOffset

void setTimeOffset(int 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.

Parameters:

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

withTimeOffset

Request<T> withTimeOffset(int 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.

Returns:

The updated request object.

getAWSRequestMetrics

AWSRequestMetrics getAWSRequestMetrics()

Returns the request metrics.

setAWSRequestMetrics

void setAWSRequestMetrics(AWSRequestMetrics metrics)

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

Throws:

java.lang.IllegalStateException - if the binding has already occurred