Package com.amazonaws
Interface SignableRequest<T>
-
- Type Parameters:
T
- The type of original, user facing request represented by this request.
- All Known Subinterfaces:
Request<T>
- All Known Implementing Classes:
DefaultRequest
public interface SignableRequest<T>
Represents a sign-able 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
All Methods Instance Methods Abstract Methods Modifier and Type Method Description 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.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.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.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.int
getTimeOffset()
Returns the optional value for time offset for this request.void
setContent(InputStream content)
Sets the optional stream containing the payload data to include for this request.
-
-
-
Method Detail
-
addHeader
void addHeader(String name, String value)
Sets the specified header for this request.- Parameters:
name
- The name of the header to set.value
- The header's value.
-
getHeaders
Map<String,String> getHeaders()
Returns a map of all the headers included in this request.- Returns:
- A map of all the headers included in this request.
-
getResourcePath
String getResourcePath()
Returns the path to the resource being requested.- Returns:
- The path to the resource being requested.
-
addParameter
void addParameter(String name, 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.
-
getParameters
Map<String,List<String>> getParameters()
Returns a map of all parameters in this request.- Returns:
- A map of all parameters in this request.
-
getEndpoint
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.
-
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.
-
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.
-
getContent
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.
-
getContentUnwrapped
InputStream getContentUnwrapped()
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.- Returns:
- The optional raw stream containing the payload data to include for this request, with all progress stream wrappers removed.
-
getReadLimitInfo
ReadLimitInfo getReadLimitInfo()
Returns the read limit info about the original request.
-
getOriginalRequestObject
Object getOriginalRequestObject()
Returns the original, user facing request object which this internal request object is representing.- Returns:
- an instance of request as an
Object
.
-
setContent
void setContent(InputStream content)
Sets the optional stream containing the payload data to include for this request. This is used, for example, for S3 chunk encoding.- Parameters:
content
- The optional stream containing the payload data to include for this request.
-
-