nifi-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From danbress <...@git.apache.org>
Subject [GitHub] nifi pull request: [NIFI-774] Create a DeleteS3Object Processor
Date Thu, 06 Aug 2015 13:09:48 GMT
Github user danbress commented on a diff in the pull request:

    https://github.com/apache/nifi/pull/72#discussion_r36411360
  
    --- Diff: nifi/nifi-nar-bundles/nifi-aws-bundle/nifi-aws-processors/src/main/java/org/apache/nifi/processors/aws/s3/DeleteS3Object.java
---
    @@ -0,0 +1,109 @@
    +/*
    + * Licensed to the Apache Software Foundation (ASF) under one or more
    + * contributor license agreements.  See the NOTICE file distributed with
    + * this work for additional information regarding copyright ownership.
    + * The ASF licenses this file to You under the Apache License, Version 2.0
    + * (the "License"); you may not use this file except in compliance with
    + * the License.  You may obtain a copy of the License at
    + *
    + *     http://www.apache.org/licenses/LICENSE-2.0
    + *
    + * Unless required by applicable law or agreed to in writing, software
    + * distributed under the License is distributed on an "AS IS" BASIS,
    + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    + * See the License for the specific language governing permissions and
    + * limitations under the License.
    + */
    +package org.apache.nifi.processors.aws.s3;
    +
    +import java.util.Arrays;
    +import java.util.Collections;
    +import java.util.List;
    +import java.util.concurrent.TimeUnit;
    +
    +import com.amazonaws.AmazonServiceException;
    +import com.amazonaws.services.s3.AmazonS3;
    +import com.amazonaws.services.s3.model.DeleteObjectRequest;
    +import com.amazonaws.services.s3.model.DeleteVersionRequest;
    +import org.apache.nifi.annotation.behavior.SupportsBatching;
    +import org.apache.nifi.annotation.documentation.CapabilityDescription;
    +import org.apache.nifi.annotation.documentation.SeeAlso;
    +import org.apache.nifi.annotation.documentation.Tags;
    +import org.apache.nifi.components.PropertyDescriptor;
    +import org.apache.nifi.flowfile.FlowFile;
    +import org.apache.nifi.processor.ProcessContext;
    +import org.apache.nifi.processor.ProcessSession;
    +import org.apache.nifi.processor.util.StandardValidators;
    +
    +@SupportsBatching
    +@SeeAlso({PutS3Object.class})
    +@Tags({"Amazon", "S3", "AWS", "Archive", "Delete"})
    +@CapabilityDescription("Deletes FlowFiles on an Amazon S3 Bucket. " +
    +        "And the FlowFiles are checked if exists or not before deleting.")
    +public class DeleteS3Object extends AbstractS3Processor {
    +
    +    public static final PropertyDescriptor VERSION_ID = new PropertyDescriptor.Builder()
    +            .name("Version")
    +            .description("The Version of the Object to delete")
    +            .addValidator(StandardValidators.NON_EMPTY_VALIDATOR)
    +            .expressionLanguageSupported(true)
    +            .required(false)
    +            .build();
    +
    +    public static final List<PropertyDescriptor> properties = Collections.unmodifiableList(
    +            Arrays.asList(KEY, BUCKET, ACCESS_KEY, SECRET_KEY, CREDENTAILS_FILE, REGION,
TIMEOUT,
    +                    FULL_CONTROL_USER_LIST, READ_USER_LIST, WRITE_USER_LIST, READ_ACL_LIST,
WRITE_ACL_LIST, OWNER));
    +
    +    @Override
    +    protected List<PropertyDescriptor> getSupportedPropertyDescriptors() {
    +        return properties;
    +    }
    +
    +    @Override
    +    protected PropertyDescriptor getSupportedDynamicPropertyDescriptor(final String propertyDescriptorName)
{
    +        return new PropertyDescriptor.Builder()
    +                .name(propertyDescriptorName)
    +                .addValidator(StandardValidators.NON_EMPTY_VALIDATOR)
    +                .expressionLanguageSupported(true)
    +                .dynamic(true)
    +                .build();
    +    }
    +
    +    public void onTrigger(final ProcessContext context, final ProcessSession session)
{
    +        FlowFile flowFile = session.get();
    +        if (flowFile == null) {
    +            return;
    +        }
    +
    +        final long startNanos = System.nanoTime();
    +
    +        final String bucket = context.getProperty(BUCKET).evaluateAttributeExpressions(flowFile).getValue();
    +        final String key = context.getProperty(KEY).evaluateAttributeExpressions(flowFile).getValue();
    +        final String versionId = context.getProperty(VERSION_ID).evaluateAttributeExpressions(flowFile).getValue();
    +
    +        final AmazonS3 s3 = getClient();
    +        try {
    +            // Checks if the key exists or not
    +            // If there is no such a key, then throws a exception
    +            s3.getObjectMetadata(bucket, key);
    +
    +            // Deletes a key on Amazon S3
    +            if (versionId == null) {
    +                final DeleteObjectRequest r = new DeleteObjectRequest(bucket, key);
    +                s3.deleteObject(r);
    +            } else {
    +                final DeleteVersionRequest r = new DeleteVersionRequest(bucket, key,
versionId);
    +                s3.deleteVersion(r);
    +            }
    +        } catch (final AmazonServiceException ase) {
    +            getLogger().error("Failed to delete S3 Object for {}; routing to failure",
new Object[]{flowFile, ase});
    +            session.transfer(flowFile, REL_FAILURE);
    +            return;
    +        }
    +
    +        session.transfer(flowFile, REL_SUCCESS);
    +        final long transferMillis = TimeUnit.NANOSECONDS.toMillis(System.nanoTime() -
startNanos);
    +        getLogger().info("Successfully delete S3 Object for {} in {} millis; routing
to success", new Object[]{flowFile, transferMillis});
    +        session.getProvenanceReporter().receive(flowFile, "https://" + bucket + ".amazonaws.com/"
+ key, transferMillis);
    --- End diff --
    
    Mark,
        I do think a "RemoteInvocation" provenance event would be helpful in general.
    
        In this case however, the processor is actually getting the object from AmazonS3,
and it is writing that data to the FlowFile content and passing that forward.  You don't think
that should emit a Receive event?  To me, this seems similar to what FetchS3Object is doing.


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

Mime
View raw message