Package com.adaptris.aws2.s3

Class ListOperation

java.lang.Object
com.adaptris.aws2.s3.S3OperationImpl
com.adaptris.aws2.s3.ListOperation
All Implemented Interfaces:
S3Operation, ComponentLifecycleExtension
@ComponentProfile(summary="List of files based on S3 key", since="4.3.0") public class ListOperation extends S3OperationImpl
List of files based on S3 key.
Since:
4.3.0

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.

  • Constructor Details

    • ListOperation

      public ListOperation()

  • Method Details

    • 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 Exception
      Throws:
      Exception

    • withOutputStyle

      public ListOperation withOutputStyle(BlobListRenderer render)

    • withFilter

      public ListOperation withFilter(RemoteBlobFilter filter)

    • withMaxKeys

      public ListOperation withMaxKeys(Integer maxKeys)

    • withPrefix

      public ListOperation withPrefix(String prefix)

    • getPrefix

      public String getPrefix()
      Specific the prefix for use with the List operation.

    • setPrefix

      public void setPrefix(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.

    • getMaxKeys

      public Integer getMaxKeys()
      Specify max number of keys to be returned per page when paging through results.

    • setMaxKeys

      public void setMaxKeys(Integer maxKeys)
      Specify max number of keys to be returned per page when paging through results.