com.github.davidmoten.aws.lw.client

Class Request

java.lang.Object

com.github.davidmoten.aws.lw.client.Request

public final class Request
extends Object

Method Summary

Modifier and Type	Method and Description
Request	attribute(String name, String value)
Request	attributePrefix(String attributePrefix)
Request	connectTimeout(long duration, TimeUnit unit)
void	execute()
boolean	exists() Returns true if and only if status code is 2xx.
Request	header(String name, String value)
Request	metadata(String key, String value) Adds the header x-amz-meta-KEY:value.
Request	method(HttpMethod method)
String	presignedUrl(long expiryDuration, TimeUnit unit)
Request	query(String name)
Request	query(String name, String value)
Request	readTimeout(long duration, TimeUnit unit)
Request	region(String region)
Request	requestBody(byte[] requestBody)
Request	requestBody(String requestBody)
Response	response() Opens a connection and makes the request.
byte[]	responseAsBytes()
String	responseAsUtf8()
XmlElement	responseAsXml()
Response	responseExpectStatusCode(int expectedStatusCode) Opens a connection and makes the request.
ResponseInputStream	responseInputStream() Opens a connection and makes the request.
Request	retryBackoffFactor(double factor)
Request	retryInitialInterval(long duration, TimeUnit unit)
Request	retryJitter(double jitter) Sets the level of randomness applied to the next retry interval.
Request	retryMaxAttempts(int maxAttempts)
Request	retryMaxInterval(long duration, TimeUnit unit)
Request	signPayload(boolean signPayload)
Request	unsignedPayload()

Methods inherited from class java.lang.Object

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

Method Detail

method

public Request method(HttpMethod method)

query

public Request query(String name,
                     String value)

query

public Request query(String name)

attributePrefix

public Request attributePrefix(String attributePrefix)

attribute

public Request attribute(String name,
                         String value)

header

public Request header(String name,
                      String value)

signPayload

public Request signPayload(boolean signPayload)

unsignedPayload

public Request unsignedPayload()

metadata

public Request metadata(String key,
                        String value)

Adds the header x-amz-meta-KEY:value. KEY is obtained from key by converting to lower-case (headers are case-insensitive) and only retaining alphabetical and digit characters.

Parameters:

key - metadata key

value - metadata value

Returns:

request builder

requestBody

public Request requestBody(byte[] requestBody)

requestBody

public Request requestBody(String requestBody)

region

public Request region(String region)

connectTimeout

public Request connectTimeout(long duration,
                              TimeUnit unit)

readTimeout

public Request readTimeout(long duration,
                           TimeUnit unit)

retryInitialInterval

public Request retryInitialInterval(long duration,
                                    TimeUnit unit)

retryMaxAttempts

public Request retryMaxAttempts(int maxAttempts)

retryJitter

public Request retryJitter(double jitter)

Sets the level of randomness applied to the next retry interval. The next calculated retry interval is multiplied by (1 - jitter * Math.random()). A value of zero means no jitter, 1 means max jitter.

Parameters:

jitter - level of randomness applied to the retry interval

Returns:

this

retryBackoffFactor

public Request retryBackoffFactor(double factor)

retryMaxInterval

public Request retryMaxInterval(long duration,
                                TimeUnit unit)

responseInputStream

public ResponseInputStream responseInputStream()

Opens a connection and makes the request. This method returns all the response information including headers, status code, request body as an InputStream. If an error status code is encountered (outside 200-299) then an exception is not thrown (unlike the other methods .response*). The caller must close the InputStream when finished with it.

Returns:

all response information, the caller must close the InputStream when finished with it

response

public Response response()

Opens a connection and makes the request. This method returns all the response information including headers, status code, request body as a byte array. If an error status code is encountered (outside 200-299) then an exception is not thrown (unlike the other methods .response*).

Returns:

all response information

responseExpectStatusCode

public Response responseExpectStatusCode(int expectedStatusCode)

Opens a connection and makes the request. This method returns all the response information including headers, status code, request body as a byte array. If the expected status code is not encountered then a ServiceException is thrown.

Returns:

all response information

Throws:

ServiceException

responseAsBytes

public byte[] responseAsBytes()

exists

public boolean exists()

Returns true if and only if status code is 2xx. Returns false if status code is 404 (NOT_FOUND) and throws a ServiceException otherwise.

Returns:

true if status code 2xx, false if 404 otherwise throws ServiceException

Throws:

ServiceException - if status code other than 2xx or 404

execute

public void execute()

responseAsUtf8

public String responseAsUtf8()

responseAsXml

public XmlElement responseAsXml()

presignedUrl

public String presignedUrl(long expiryDuration,
                           TimeUnit unit)