com.adaptris.aws.s3

Class ListOperation

java.lang.Object

com.adaptris.aws.s3.S3OperationImpl

com.adaptris.aws.s3.ListOperation

All Implemented Interfaces:

S3Operation, ComponentLifecycleExtension

@ComponentProfile(summary="List of files based on S3 key",
                  since="3.9.1")
public class ListOperation
extends S3OperationImpl

List of files based on S3 key.

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

Field Summary

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

log

Constructor Summary

Constructors

Constructor and Description
ListOperation()

Method Summary

Modifier and Type	Method and Description
void	execute(ClientWrapper wrapper, AdaptrisMessage msg)
RemoteBlobFilter	getFilter() Specify any additional filtering you wish to perform on the list.
java.lang.Integer	getMaxKeys() Specify max number of keys to be returned per page when paging through results.
BlobListRenderer	getOutputStyle() Specify the output style.
java.lang.Boolean	getPageResults() Deprecated. since 3.10.2 due to interface changes; paging results is not explicitly configurable and will be ignored.
java.lang.String	getPrefix() Specific the prefix for use with the List operation.
void	prepare()
void	setFilter(RemoteBlobFilter filter) Specify any additional filtering you wish to perform on the list.
void	setMaxKeys(java.lang.Integer maxKeys) Specify max number of keys to be returned per page when paging through results.
void	setOutputStyle(BlobListRenderer outputStyle) Specify the output style.
void	setPageResults(java.lang.Boolean pageResults) Deprecated. since 3.10.2 due to interface changes; paging results is not explicitly configurable and will be ignored.
void	setPrefix(java.lang.String prefix) Specific the prefix for use with the List operation.
ListOperation	withFilter(RemoteBlobFilter filter)
ListOperation	withMaxKeys(java.lang.Integer maxKeys)
ListOperation	withOutputStyle(BlobListRenderer render)
ListOperation	withPrefix(java.lang.String prefix)

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

getBucket, getBucketName, getKey, mustHaveEither, resolve, s3Bucket, setBucket, setBucketName, setKey, withBucket, withBucketName, withKey

Methods inherited from class java.lang.Object

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

Constructor Detail

ListOperation

public ListOperation()

Method Detail

prepare

public void prepare()
             throws CoreException

Specified by:

prepare in interface ComponentLifecycleExtension

Overrides:

prepare in class S3OperationImpl

Throws:

CoreException

execute

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

Throws:

java.lang.Exception

withOutputStyle

public ListOperation withOutputStyle(BlobListRenderer render)

withFilter

public ListOperation withFilter(RemoteBlobFilter filter)

withMaxKeys

public ListOperation withMaxKeys(java.lang.Integer maxKeys)

withPrefix

public ListOperation withPrefix(java.lang.String prefix)

getPrefix

public java.lang.String getPrefix()

Specific the prefix for use with the List operation.

setPrefix

public void setPrefix(java.lang.String prefix)

Specific the prefix for use with the List operation.

getFilter

public RemoteBlobFilter getFilter()

Specify any additional filtering you wish to perform on the list.

setFilter

public void setFilter(RemoteBlobFilter filter)

Specify any additional filtering you wish to perform on the list.

getOutputStyle

public BlobListRenderer getOutputStyle()

Specify the output style.

If left as null, then only the names of the files will be emitted. You may require additional optional components to utilise other rendering styles.

setOutputStyle

public void setOutputStyle(BlobListRenderer outputStyle)

Specify the output style.

If left as null, then only the names of the files will be emitted. You may require additional optional components to utilise other rendering styles.

getPageResults

@Deprecated
public java.lang.Boolean getPageResults()

Deprecated. since 3.10.2 due to interface changes; paging results is not explicitly configurable and will be ignored.

Specify whether to page over results.

If set to true will return all results, as oppose to the first n, where n is max-keys (AWS default: 1000). Default is false for backwards compatibility reasons.

setPageResults

@Deprecated
public void setPageResults(java.lang.Boolean pageResults)

Deprecated. since 3.10.2 due to interface changes; paging results is not explicitly configurable and will be ignored.

Specify whether to page over results.

If set to true will return all results, as oppose to the first n, where n is max-keys (AWS default: 1000). Default is false for backwards compatibility reasons.

getMaxKeys

public java.lang.Integer getMaxKeys()

Specify max number of keys to be returned per page when paging through results.

setMaxKeys

public void setMaxKeys(java.lang.Integer maxKeys)

Specify max number of keys to be returned per page when paging through results.