Package com.adaptris.aws2.s3

Class S3GetOperation

java.lang.Object

com.adaptris.aws2.s3.S3OperationImpl

com.adaptris.aws2.s3.ObjectOperationImpl

com.adaptris.aws2.s3.TransferOperation

com.adaptris.aws2.s3.S3GetOperation

All Implemented Interfaces:

S3Operation, ComponentLifecycleExtension

public class S3GetOperation
extends TransferOperation

Get an object from S3 and store the contents of the object either in the message payload or metadata.

Since:

4.3.0

In the adapter configuration file this class is aliased as amazon-s3-get which is the preferred alternative to the fully qualified classname when building your configuration.

Field Summary

Fields inherited from class com.adaptris.aws2.s3.S3OperationImpl

log

Constructor Summary

Constructors

Constructor	Description
S3GetOperation()

Method Summary

Modifier and Type	Method	Description
void	execute(ClientWrapper wrapper, AdaptrisMessage msg)
DataOutputParameter<InputStreamWithEncoding>	getResponseBody()	Where to write the contents of the get operation.
void	setResponseBody(DataOutputParameter<InputStreamWithEncoding> responseBody)	Where to write the contents of the get operation.

Methods inherited from class com.adaptris.aws2.s3.TransferOperation

filterMetadata, filterUserMetadata, getUserMetadataFilter, setUserMetadataFilter, withUserMetadataFilter

Methods inherited from class com.adaptris.aws2.s3.ObjectOperationImpl

getObjectName, prepare, s3ObjectKey, setObjectName, withObjectName

Methods inherited from class com.adaptris.aws2.s3.S3OperationImpl

getBucket, s3Bucket, setBucket, withBucket

Methods inherited from class java.lang.Object

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

Constructor Details

S3GetOperation

public S3GetOperation()

Method Details

execute

public void execute(ClientWrapper wrapper,
 AdaptrisMessage msg)
             throws Exception

Throws:

Exception

getResponseBody

public DataOutputParameter<InputStreamWithEncoding> getResponseBody()

Where to write the contents of the get operation.

If not explicitly specified then defaults to the payload via PayloadStreamOutputParameter.

setResponseBody

public void setResponseBody(DataOutputParameter<InputStreamWithEncoding> responseBody)

Where to write the contents of the get operation.

If not explicitly specified then defaults to the payload via PayloadStreamOutputParameter.