software.amazon.payloadoffloading

Interface PayloadStore

All Known Implementing Classes:

S3BackedPayloadStore

public interface PayloadStore

An AWS storage service that supports saving high payload sizes.

Method Summary

Modifier and Type	Method and Description
void	deleteOriginalPayload(String payloadPointer) Deletes the original payload using the given payloadPointer.
String	getOriginalPayload(String payloadPointer) Retrieves the original payload using the given payloadPointer.
String	storeOriginalPayload(String payload) Stores payload in a store that has higher payload size limit than that is supported by original payload store.

Method Detail

storeOriginalPayload

String storeOriginalPayload(String payload)

Stores payload in a store that has higher payload size limit than that is supported by original payload store.

Parameters:

payload -

Returns:

a pointer that must be used to retrieve the original payload later.

Throws:

software.amazon.awssdk.core.exception.SdkClientException - If any internal errors are encountered on the client side while attempting to make the request or handle the response. For example if a network connection is not available.

software.amazon.awssdk.services.s3.model.S3Exception - If an error response is returned by actual PayloadStore indicating either a problem with the data in the request, or a server side issue.

getOriginalPayload

String getOriginalPayload(String payloadPointer)

Retrieves the original payload using the given payloadPointer. The pointer must have been obtained using storeOriginalPayload

Parameters:

payloadPointer -

Returns:

original payload

Throws:

software.amazon.awssdk.core.exception.SdkClientException - If any internal errors are encountered on the client side while attempting to make the request or handle the response. For example if payloadPointer is invalid or a network connection is not available.

software.amazon.awssdk.services.s3.model.S3Exception - If an error response is returned by actual PayloadStore indicating a server side issue.

deleteOriginalPayload

void deleteOriginalPayload(String payloadPointer)

Deletes the original payload using the given payloadPointer. The pointer must have been obtained using storeOriginalPayload

Parameters:

payloadPointer -

Throws:

software.amazon.awssdk.core.exception.SdkClientException - If any internal errors are encountered on the client side while attempting to make the request or handle the response to/from PayloadStore. For example, if payloadPointer is invalid or a network connection is not available.

software.amazon.awssdk.services.s3.model.S3Exception - If an error response is returned by actual PayloadStore indicating a server side issue.