com.amazonaws

Class AmazonWebServiceRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

@NotThreadSafe
public abstract class AmazonWebServiceRequest
extends Object

Base class for all user facing web service requests.

Field Summary

Fields

Modifier and Type	Field and Description
static AmazonWebServiceRequest	NOOP

Constructor Summary

Constructors

Constructor and Description
AmazonWebServiceRequest()

Method Summary

Methods

Modifier and Type	Method and Description
Map<String,String>	copyPrivateRequestParameters() Internal only method for accessing private, internal request parameters.
Map<String,String>	getCustomRequestHeaders() Returns an immutable map of custom header names to header values.
ProgressListener	getGeneralProgressListener() Returns the optional progress listener for receiving updates about the progress of the request.
int	getReadLimit() Convenient method to return the optional read limit for mark-and-reset during retries.
RequestClientOptions	getRequestClientOptions() Gets the options stored with this request object.
AWSCredentials	getRequestCredentials() Returns the optional credentials to use to sign this request, overriding the default credentials set at the client level.
RequestMetricCollector	getRequestMetricCollector() Returns a request level metric collector; or null if not specified.
String	putCustomRequestHeader(String name, String value) Put a new custom header to the map of custom header names to custom header values, and return the previous value if the header has already been set in this map.
void	setGeneralProgressListener(ProgressListener progressListener) Sets the optional progress listener for receiving updates about the progress of the request.
void	setRequestCredentials(AWSCredentials credentials) Sets the optional credentials to use for this request, overriding the default credentials set at the client level.
void	setRequestMetricCollector(RequestMetricCollector requestMetricCollector) Sets a request level request metric collector which takes precedence over the ones at the http client level and AWS SDK level.
<T extends AmazonWebServiceRequest> T	withGeneralProgressListener(ProgressListener progressListener) Sets the optional progress listener for receiving updates about the progress of the request, and returns a reference to this object so that method calls can be chained together.
<T extends AmazonWebServiceRequest> T	withRequestMetricCollector(RequestMetricCollector metricCollector) Specifies a request level metric collector which takes precedence over the ones at the http client level and AWS SDK level.

Methods inherited from class java.lang.Object

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

Field Detail

NOOP

public static final AmazonWebServiceRequest NOOP

Constructor Detail

AmazonWebServiceRequest

public AmazonWebServiceRequest()

Method Detail

setRequestCredentials

public void setRequestCredentials(AWSCredentials credentials)

Sets the optional credentials to use for this request, overriding the default credentials set at the client level.

Parameters:

credentials - The optional AWS security credentials to use for this request, overriding the default credentials set at the client level.

getRequestCredentials

public AWSCredentials getRequestCredentials()

Returns the optional credentials to use to sign this request, overriding the default credentials set at the client level.

Returns:

The optional credentials to use to sign this request, overriding the default credentials set at the client level.

copyPrivateRequestParameters

public Map<String,String> copyPrivateRequestParameters()

Internal only method for accessing private, internal request parameters. Not intended for direct use by callers.

Returns:

private, internal request parameter information.

getRequestClientOptions

public RequestClientOptions getRequestClientOptions()

Gets the options stored with this request object. Intended for internal use only.

getRequestMetricCollector

public RequestMetricCollector getRequestMetricCollector()

Returns a request level metric collector; or null if not specified.

setRequestMetricCollector

public void setRequestMetricCollector(RequestMetricCollector requestMetricCollector)

Sets a request level request metric collector which takes precedence over the ones at the http client level and AWS SDK level.

withRequestMetricCollector

public <T extends AmazonWebServiceRequest> T withRequestMetricCollector(RequestMetricCollector metricCollector)

Specifies a request level metric collector which takes precedence over the ones at the http client level and AWS SDK level.

setGeneralProgressListener

public void setGeneralProgressListener(ProgressListener progressListener)

Sets the optional progress listener for receiving updates about the progress of the request.

Parameters:

progressListener - The new progress listener.

getGeneralProgressListener

public ProgressListener getGeneralProgressListener()

Returns the optional progress listener for receiving updates about the progress of the request.

Returns:

the optional progress listener for receiving updates about the progress of the request.

withGeneralProgressListener

public <T extends AmazonWebServiceRequest> T withGeneralProgressListener(ProgressListener progressListener)

Sets the optional progress listener for receiving updates about the progress of the request, and returns a reference to this object so that method calls can be chained together.

Parameters:

progressListener - The new progress listener.

Returns:

A reference to this updated object so that method calls can be chained together.

getCustomRequestHeaders

public Map<String,String> getCustomRequestHeaders()

Returns an immutable map of custom header names to header values.

Returns:

The immutable map of custom header names to header values.

putCustomRequestHeader

public String putCustomRequestHeader(String name,
                            String value)

Put a new custom header to the map of custom header names to custom header values, and return the previous value if the header has already been set in this map.

NOTE: Custom header values set via this method will overwrite any conflicting values coming from the request parameters.

Parameters:

name - The name of the header to add

value - The value of the header to add

Returns:

the previous value for the name if it was set, null otherwise

getReadLimit

public final int getReadLimit()

Convenient method to return the optional read limit for mark-and-reset during retries.