DefaultRequest (AWS SDK for Java

JavaScript is disabled on your browser.

AWS SDK for Java 1.x API Reference - 1.12.793

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

com.amazonaws

Class DefaultRequest<T>

java.lang.Object
- com.amazonaws.DefaultRequest<T>

All Implemented Interfaces:

HandlerContextAware, ImmutableRequest<T>, Request<T>, SignableRequest<T>
```
@NotThreadSafe
public class DefaultRequest<T>
extends 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, String serviceName)` Constructs a new DefaultRequest with the specified service name and the original, user facing request object.
`DefaultRequest (String serviceName)` Constructs a new DefaultRequest with the specified service name and no specified original, user facing request object.

Method Summary

All Methods
Modifier and Type	Method and Description
`<X> void`	`addHandlerContext (HandlerContextKey<X> key, X value)` Adds a context to that is visible to all `RequestHandler2`s.
`void`	`addHeader (String name, String value)` Sets the specified header for this request.
`void`	`addParameter (String name, String value)` Adds the specified request parameter to this request.
`void`	`addParameters (String name, List<String> values)` Adds the specified request parameter and list of values to this request.
`AWSRequestMetrics`	`getAWSRequestMetrics ()` Returns the request metrics.
`InputStream`	`getContent ()` Returns the optional stream containing the payload data to include for this request.
`InputStream`	`getContentUnwrapped ()` Returns the optional raw stream containing the payload data to include for this request, with all progress stream wrappers.
`URI`	`getEndpoint ()` Returns the service endpoint (ex: "https://ec2.amazonaws.com") to which this request should be sent.
`<X> X`	`getHandlerContext (HandlerContextKey<X> key)` Return the context for the given key if present; else return null.
`Map<String,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.
`Object`	`getOriginalRequestObject ()` Returns the original, user facing request object which this internal request object is representing.
`Map<String,List<String>>`	`getParameters ()` Returns a map of all parameters in this request.
`ReadLimitInfo`	`getReadLimitInfo ()` Returns the read limit info about the original request.
`String`	`getResourcePath ()` Returns the path to the resource being requested.
`String`	`getServiceName ()`
`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 (InputStream content)` Sets the optional stream containing the payload data to include for this request.
`void`	`setEndpoint (URI endpoint)` Sets the service endpoint (ex: "https://ec2.amazonaws.com") to which this request should be sent.
`void`	`setHeaders (Map<String,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 (Map<String,List<String>> parameters)` Sets all parameters, clearing any existing values.
`void`	`setResourcePath (String resourcePath)` Sets the path to the resource being requested.
`void`	`setTimeOffset (int timeOffset)` Sets the optional value for time offset for this request.
`String`	`toString ()`
`Request<T>`	`withParameter (String name, 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.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DefaultRequest
```
public DefaultRequest(AmazonWebServiceRequest originalRequest,
 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(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(String name,
 String value)
```
    Description copied from interface: SignableRequest
    
    Sets the specified header for this request.
    
    Specified by:
    
    addHeader in interface SignableRequest<T>
    
    Parameters:
    
    name - The name of the header to set.
    
    value - The header's value.
    
    See Also:
    
    SignableRequest.addHeader(java.lang.String, java.lang.String)
  - getHeaders
```
public Map<String,String> getHeaders()
```
    Description copied from interface: ImmutableRequest
    
    Returns a map of all the headers included in this request.
    
    Specified by:
    
    getHeaders in interface ImmutableRequest<T>
    
    Returns:
    
    A map of all the headers included in this request.
    
    See Also:
    
    ImmutableRequest.getHeaders()
  - setResourcePath
```
public void setResourcePath(String resourcePath)
```
    Description copied from interface: Request
    
    Sets the path to the resource being requested.
    
    Specified by:
    
    setResourcePath in interface Request<T>
    
    Parameters:
    
    resourcePath - The path to the resource being requested.
    
    See Also:
    
    Request.setResourcePath(java.lang.String)
  - getResourcePath
```
public String getResourcePath()
```
    Description copied from interface: ImmutableRequest
    
    Returns the path to the resource being requested.
    
    Specified by:
    
    getResourcePath in interface ImmutableRequest<T>
    
    Returns:
    
    The path to the resource being requested.
    
    See Also:
    
    ImmutableRequest.getResourcePath()
  - addParameter
```
public void addParameter(String name,
 String value)
```
    Description copied from interface: SignableRequest
    
    Adds the specified request parameter to this request.
    
    Specified by:
    
    addParameter in interface SignableRequest<T>
    
    Parameters:
    
    name - The name of the request parameter.
    
    value - The value of the request parameter.
    
    See Also:
    
    SignableRequest.addParameter(java.lang.String, java.lang.String)
  - addParameters
```
public void addParameters(String name,
 List<String> values)
```
    Description copied from interface: Request
    
    Adds the specified request parameter and list of values to this request.
    
    Specified by:
    
    addParameters in interface Request<T>
    
    Parameters:
    
    name - The name of the request parameter.
    
    values - The value of the request parameter.
    
    See Also:
    
    Request.addParameters(java.lang.String, java.util.List)
  - getParameters
```
public Map<String,List<String>> getParameters()
```
    Description copied from interface: ImmutableRequest
    
    Returns a map of all parameters in this request.
    
    Specified by:
    
    getParameters in interface ImmutableRequest<T>
    
    Returns:
    
    A map of all parameters in this request.
    
    See Also:
    
    ImmutableRequest.getParameters()
  - withParameter
```
public Request<T> withParameter(String name,
 String value)
```
    Description copied from interface: Request
    
    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.
    
    See Also:
    
    Request.withParameter(java.lang.String, java.lang.String)
  - getHttpMethod
```
public HttpMethodName getHttpMethod()
```
    Description copied from interface: ImmutableRequest
    
    Returns the HTTP method (GET, POST, etc) to use when sending this request.
    
    Specified by:
    
    getHttpMethod in interface ImmutableRequest<T>
    
    Returns:
    
    The HTTP method to use when sending this request.
    
    See Also:
    
    ImmutableRequest.getHttpMethod()
  - setHttpMethod
```
public void setHttpMethod(HttpMethodName httpMethod)
```
    Description copied from interface: Request
    
    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.
    
    See Also:
    
    Request.setHttpMethod(com.amazonaws.http.HttpMethodName)
  - setEndpoint
```
public void setEndpoint(URI endpoint)
```
    Description copied from interface: Request
    
    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.
    
    See Also:
    
    Request.setEndpoint(java.net.URI)
  - getEndpoint
```
public URI getEndpoint()
```
    Description copied from interface: ImmutableRequest
    
    Returns the service endpoint (ex: "https://ec2.amazonaws.com") to which this request should be sent.
    
    Specified by:
    
    getEndpoint in interface ImmutableRequest<T>
    
    Returns:
    
    The service endpoint to which this request should be sent.
    
    See Also:
    
    ImmutableRequest.getEndpoint()
  - getServiceName
```
public String getServiceName()
```
    Specified by:
    
    getServiceName in interface Request<T>
    
    Returns:
    
    The name of the Amazon service this request is for. This is used as the service name set in request metrics and service exceptions. This is NOT the same as the service name returned by AmazonWebServiceClient.getServiceName() which is used for signing purpose.
    
    See Also:
    
    Request.getServiceName()
  - getContent
```
public InputStream getContent()
```
    Description copied from interface: ImmutableRequest
    
    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 ImmutableRequest<T>
    
    Returns:
    
    The optional stream containing the payload data to include for this request.
    
    See Also:
    
    ImmutableRequest.getContent()
  - setContent
```
public void setContent(InputStream content)
```
    Description copied from interface: SignableRequest
    
    Sets the optional stream containing the payload data to include for this request. This is used, for example, for S3 chunk encoding.
    
    Specified by:
    
    setContent in interface SignableRequest<T>
    
    Parameters:
    
    content - The optional stream containing the payload data to include for this request.
    
    See Also:
    
    SignableRequest.setContent(java.io.InputStream)
  - setHeaders
```
public void setHeaders(Map<String,String> headers)
```
    Description copied from interface: Request
    
    Sets all headers, clearing any existing ones.
    
    Specified by:
    
    setHeaders in interface Request<T>
    
    See Also:
    
    Request.setHeaders(java.util.Map)
  - setParameters
```
public void setParameters(Map<String,List<String>> parameters)
```
    Description copied from interface: Request
    
    Sets all parameters, clearing any existing values. Note that List values within the parameters Map must use an implementation that supports null values.
    
    Specified by:
    
    setParameters in interface Request<T>
    
    See Also:
    
    Request.setParameters(java.util.Map)
  - getTimeOffset
```
public int getTimeOffset()
```
    Description copied from interface: ImmutableRequest
    
    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 ImmutableRequest<T>
    
    Returns:
    
    The optional value for time offset (in seconds) for this request.
    
    See Also:
    
    ImmutableRequest.getTimeOffset()
  - setTimeOffset
```
public void setTimeOffset(int timeOffset)
```
    Description copied from interface: Request
    
    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.
    
    See Also:
    
    Request.setTimeOffset(int)
  - withTimeOffset
```
public Request<T> withTimeOffset(int timeOffset)
```
    Description copied from interface: Request
    
    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>
    
    Returns:
    
    The updated request object.
    
    See Also:
    
    Request.setTimeOffset(int)
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getAWSRequestMetrics
```
public AWSRequestMetrics getAWSRequestMetrics()
```
    Description copied from interface: Request
    
    Returns the request metrics.
    
    Specified by:
    
    getAWSRequestMetrics in interface Request<T>
  - setAWSRequestMetrics
```
public void setAWSRequestMetrics(AWSRequestMetrics metrics)
```
    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>
  - addHandlerContext
```
public <X> void addHandlerContext(HandlerContextKey<X> key,
 X value)
```
    Description copied from interface: HandlerContextAware
    
    Adds a context to that is visible to all RequestHandler2s. Note that, context added here will available only for the scope of the request execution and will not be marshalled over the wire.
    
    Specified by:
    
    addHandlerContext in interface HandlerContextAware
    
    Parameters:
    
    key - the key for the property being set in the request.
    
    value - the value for the property being set in the request.
  - getHandlerContext
```
public <X> X getHandlerContext(HandlerContextKey<X> key)
```
    Description copied from interface: HandlerContextAware
    
    Return the context for the given key if present; else return null.
    
    Specified by:
    
    getHandlerContext in interface HandlerContextAware
    
    Parameters:
    
    key - the key for the context
    
    Returns:
    
    the context if present else null.
  - getContentUnwrapped
```
public InputStream getContentUnwrapped()
```
    Description copied from interface: ImmutableRequest
    
    Returns the optional raw stream containing the payload data to include for this request, with all progress stream wrappers. Not all requests contain payload data.
    
    Specified by:
    
    getContentUnwrapped in interface ImmutableRequest<T>
    
    Returns:
    
    The optional raw stream containing the payload data to include for this request, with all progress stream wrappers removed.
  - getReadLimitInfo
```
public ReadLimitInfo getReadLimitInfo()
```
    Description copied from interface: ImmutableRequest
    
    Returns the read limit info about the original request.
    
    Specified by:
    
    getReadLimitInfo in interface ImmutableRequest<T>
  - getOriginalRequestObject
```
public Object getOriginalRequestObject()
```
    Description copied from interface: ImmutableRequest
    
    Returns the original, user facing request object which this internal request object is representing.
    
    Specified by:
    
    getOriginalRequestObject in interface ImmutableRequest<T>
    
    Returns:
    
    an instance of request as an Object.

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

AWS SDK for Java 1.x API Reference - 1.12.793

Class DefaultRequest<T>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DefaultRequest

DefaultRequest

Method Detail

getOriginalRequest

addHeader

getHeaders

setResourcePath

getResourcePath

addParameter

addParameters

getParameters

withParameter

getHttpMethod

setHttpMethod

setEndpoint

getEndpoint

getServiceName

getContent

setContent

setHeaders

setParameters

getTimeOffset

setTimeOffset

withTimeOffset

toString

getAWSRequestMetrics

setAWSRequestMetrics

addHandlerContext

getHandlerContext

getContentUnwrapped

getReadLimitInfo

getOriginalRequestObject