Package com.adaptris.aws2.s3

Class TagOperation

java.lang.Object

com.adaptris.aws2.s3.S3OperationImpl

com.adaptris.aws2.s3.ObjectOperationImpl

com.adaptris.aws2.s3.TagOperation

All Implemented Interfaces:

S3Operation, ComponentLifecycleExtension

Direct Known Subclasses:

GetTagOperation

@ComponentProfile(summary="Tag an object in S3",
                  since="4.3.0")
public class TagOperation
extends ObjectOperationImpl

Add tags to an object from S3 to another object

Uses S3Client.putObjectTagging(PutObjectTaggingRequest).

Since:

4.3.0

In the adapter configuration file this class is aliased as amazon-s3-copy 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
TagOperation()

Method Summary

Modifier and Type	Method	Description
void	execute(ClientWrapper wrapper, AdaptrisMessage msg)
protected List<software.amazon.awssdk.services.s3.model.Tag>	filterTagMetadata(AdaptrisMessage msg)
MetadataFilter	getTagMetadataFilter()
void	setTagMetadataFilter(MetadataFilter mf)	Filter metadata and set them as tags for the s3 object.
protected MetadataFilter	tagMetadataFilter()
<T extends TagOperation> T	withTagMetadataFilter(MetadataFilter mf)

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

TagOperation

public TagOperation()

Method Details

execute

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

Throws:

Exception

getTagMetadataFilter

public MetadataFilter getTagMetadataFilter()

setTagMetadataFilter

public void setTagMetadataFilter(MetadataFilter mf)

Filter metadata and set them as tags for the s3 object.

Parameters:

mf - the metadata filter; if not specified defaults to RemoveAllMetadataFilter.

withTagMetadataFilter

public <T extends TagOperation> T withTagMetadataFilter(MetadataFilter mf)

tagMetadataFilter

protected MetadataFilter tagMetadataFilter()

filterTagMetadata

protected List<software.amazon.awssdk.services.s3.model.Tag> filterTagMetadata(AdaptrisMessage msg)