http://git-wip-us.apache.org/repos/asf/nifi/blob/897c7029/nifi-nar-bundles/nifi-gcp-bundle/nifi-gcp-processors/src/main/java/org/apache/nifi/processors/gcp/storage/DeleteGCSObject.java ---------------------------------------------------------------------- diff --git a/nifi-nar-bundles/nifi-gcp-bundle/nifi-gcp-processors/src/main/java/org/apache/nifi/processors/gcp/storage/DeleteGCSObject.java b/nifi-nar-bundles/nifi-gcp-bundle/nifi-gcp-processors/src/main/java/org/apache/nifi/processors/gcp/storage/DeleteGCSObject.java new file mode 100644 index 0000000..80bb9c0 --- /dev/null +++ b/nifi-nar-bundles/nifi-gcp-bundle/nifi-gcp-processors/src/main/java/org/apache/nifi/processors/gcp/storage/DeleteGCSObject.java @@ -0,0 +1,125 @@ +/* + * 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.gcp.storage; + +import com.google.cloud.storage.BlobId; +import com.google.cloud.storage.Storage; +import com.google.common.collect.ImmutableList; +import org.apache.nifi.annotation.behavior.InputRequirement; +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.exception.ProcessException; +import org.apache.nifi.processor.util.StandardValidators; + +import java.util.List; +import java.util.concurrent.TimeUnit; + +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.BUCKET_ATTR; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.BUCKET_DESC; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.KEY_DESC; + + +@SupportsBatching +@Tags({"google cloud", "gcs", "google", "storage", "delete"}) +@CapabilityDescription("Deletes objects from a Google Cloud Bucket. " + + "If attempting to delete a file that does not exist, FlowFile is routed to success.") +@SeeAlso({PutGCSObject.class, FetchGCSObject.class, ListGCSBucket.class}) +@InputRequirement(InputRequirement.Requirement.INPUT_REQUIRED) +public class DeleteGCSObject extends AbstractGCSProcessor { + public static final PropertyDescriptor BUCKET = new PropertyDescriptor + .Builder().name("gcs-bucket") + .displayName("Bucket") + .description(BUCKET_DESC) + .required(true) + .defaultValue("${" + BUCKET_ATTR + "}") + .expressionLanguageSupported(true) + .addValidator(StandardValidators.NON_EMPTY_VALIDATOR) + .build(); + + public static final PropertyDescriptor KEY = new PropertyDescriptor + .Builder().name("gcs-key") + .displayName("Key") + .description(KEY_DESC) + .required(true) + .defaultValue("${filename}") + .expressionLanguageSupported(true) + .addValidator(StandardValidators.NON_EMPTY_VALIDATOR) + .build(); + + public static final PropertyDescriptor GENERATION = new PropertyDescriptor.Builder() + .name("gcs-generation") + .displayName("Generation") + .description("The generation of the object to be deleted. If null, will use latest version of the object.") + .addValidator(StandardValidators.POSITIVE_LONG_VALIDATOR) + .expressionLanguageSupported(true) + .required(false) + .build(); + + @Override + public List<PropertyDescriptor> getSupportedPropertyDescriptors() { + return ImmutableList.<PropertyDescriptor>builder() + .addAll(super.getSupportedPropertyDescriptors()) + .add(BUCKET) + .add(KEY) + .add(GENERATION) + .build(); + } + + @Override + public void onTrigger(ProcessContext context, ProcessSession session) throws ProcessException { + 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 Long generation = context.getProperty(GENERATION) + .evaluateAttributeExpressions(flowFile) + .asLong(); + + + final Storage storage = getCloudService(); + + // Deletes a key on Google Cloud + try { + storage.delete(BlobId.of(bucket, key, generation)); + } catch (Exception e) { + getLogger().error(e.getMessage(), e); + flowFile = session.penalize(flowFile); + session.transfer(flowFile, REL_FAILURE); + return; + } + + session.transfer(flowFile, REL_SUCCESS); + final long millis = TimeUnit.NANOSECONDS.toMillis(System.nanoTime() - startNanos); + getLogger().info("Successfully deleted GCS Object for {} in {} millis; routing to success", new Object[]{flowFile, millis}); + } +}
http://git-wip-us.apache.org/repos/asf/nifi/blob/897c7029/nifi-nar-bundles/nifi-gcp-bundle/nifi-gcp-processors/src/main/java/org/apache/nifi/processors/gcp/storage/FetchGCSObject.java ---------------------------------------------------------------------- diff --git a/nifi-nar-bundles/nifi-gcp-bundle/nifi-gcp-processors/src/main/java/org/apache/nifi/processors/gcp/storage/FetchGCSObject.java b/nifi-nar-bundles/nifi-gcp-bundle/nifi-gcp-processors/src/main/java/org/apache/nifi/processors/gcp/storage/FetchGCSObject.java new file mode 100644 index 0000000..a65158a --- /dev/null +++ b/nifi-nar-bundles/nifi-gcp-bundle/nifi-gcp-processors/src/main/java/org/apache/nifi/processors/gcp/storage/FetchGCSObject.java @@ -0,0 +1,346 @@ +/* + * 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.gcp.storage; + +import com.google.cloud.ReadChannel; +import com.google.cloud.storage.Acl; +import com.google.cloud.storage.Blob; +import com.google.cloud.storage.BlobId; +import com.google.cloud.storage.BlobInfo; +import com.google.cloud.storage.Storage; +import com.google.cloud.storage.StorageException; +import com.google.common.collect.ImmutableList; +import org.apache.nifi.annotation.behavior.InputRequirement; +import org.apache.nifi.annotation.behavior.WritesAttribute; +import org.apache.nifi.annotation.behavior.WritesAttributes; +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.flowfile.attributes.CoreAttributes; +import org.apache.nifi.processor.ProcessContext; +import org.apache.nifi.processor.ProcessSession; +import org.apache.nifi.processor.exception.ProcessException; +import org.apache.nifi.processor.util.StandardValidators; + +import java.nio.channels.Channels; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import java.util.concurrent.TimeUnit; + +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.BUCKET_ATTR; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.BUCKET_DESC; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.CACHE_CONTROL_ATTR; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.CACHE_CONTROL_DESC; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.COMPONENT_COUNT_ATTR; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.COMPONENT_COUNT_DESC; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.CONTENT_DISPOSITION_ATTR; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.CONTENT_DISPOSITION_DESC; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.CONTENT_ENCODING_ATTR; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.CONTENT_ENCODING_DESC; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.CONTENT_LANGUAGE_ATTR; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.CONTENT_LANGUAGE_DESC; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.CRC32C_ATTR; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.CRC32C_DESC; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.CREATE_TIME_ATTR; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.CREATE_TIME_DESC; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.ENCRYPTION_ALGORITHM_ATTR; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.ENCRYPTION_ALGORITHM_DESC; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.ENCRYPTION_SHA256_ATTR; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.ENCRYPTION_SHA256_DESC; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.ETAG_ATTR; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.ETAG_DESC; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.GENERATED_ID_ATTR; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.GENERATED_ID_DESC; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.GENERATION_ATTR; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.GENERATION_DESC; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.KEY_ATTR; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.KEY_DESC; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.MD5_ATTR; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.MD5_DESC; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.MEDIA_LINK_ATTR; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.MEDIA_LINK_DESC; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.METAGENERATION_ATTR; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.METAGENERATION_DESC; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.OWNER_ATTR; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.OWNER_DESC; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.OWNER_TYPE_ATTR; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.OWNER_TYPE_DESC; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.SIZE_ATTR; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.SIZE_DESC; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.UPDATE_TIME_ATTR; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.UPDATE_TIME_DESC; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.URI_ATTR; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.URI_DESC; + +@InputRequirement(InputRequirement.Requirement.INPUT_REQUIRED) +@Tags({"google cloud", "google", "storage", "gcs", "fetch"}) +@CapabilityDescription("Fetches a file from a Google Cloud Bucket. Designed to be used in tandem with ListGCSBucket.") +@SeeAlso({ListGCSBucket.class, PutGCSObject.class, DeleteGCSObject.class}) +@WritesAttributes({ + @WritesAttribute(attribute = "filename", description = "The name of the file, parsed if possible from the " + + "Content-Disposition response header"), + @WritesAttribute(attribute = BUCKET_ATTR, description = BUCKET_DESC), + @WritesAttribute(attribute = KEY_ATTR, description = KEY_DESC), + @WritesAttribute(attribute = SIZE_ATTR, description = SIZE_DESC), + @WritesAttribute(attribute = CACHE_CONTROL_ATTR, description = CACHE_CONTROL_DESC), + @WritesAttribute(attribute = COMPONENT_COUNT_ATTR, description = COMPONENT_COUNT_DESC), + @WritesAttribute(attribute = CONTENT_DISPOSITION_ATTR, description = CONTENT_DISPOSITION_DESC), + @WritesAttribute(attribute = CONTENT_ENCODING_ATTR, description = CONTENT_ENCODING_DESC), + @WritesAttribute(attribute = CONTENT_LANGUAGE_ATTR, description = CONTENT_LANGUAGE_DESC), + @WritesAttribute(attribute = "mime.type", description = "The MIME/Content-Type of the object"), + @WritesAttribute(attribute = CRC32C_ATTR, description = CRC32C_DESC), + @WritesAttribute(attribute = CREATE_TIME_ATTR, description = CREATE_TIME_DESC), + @WritesAttribute(attribute = UPDATE_TIME_ATTR, description = UPDATE_TIME_DESC), + @WritesAttribute(attribute = ENCRYPTION_ALGORITHM_ATTR, description = ENCRYPTION_ALGORITHM_DESC), + @WritesAttribute(attribute = ENCRYPTION_SHA256_ATTR, description = ENCRYPTION_SHA256_DESC), + @WritesAttribute(attribute = ETAG_ATTR, description = ETAG_DESC), + @WritesAttribute(attribute = GENERATED_ID_ATTR, description = GENERATED_ID_DESC), + @WritesAttribute(attribute = GENERATION_ATTR, description = GENERATION_DESC), + @WritesAttribute(attribute = MD5_ATTR, description = MD5_DESC), + @WritesAttribute(attribute = MEDIA_LINK_ATTR, description = MEDIA_LINK_DESC), + @WritesAttribute(attribute = METAGENERATION_ATTR, description = METAGENERATION_DESC), + @WritesAttribute(attribute = OWNER_ATTR, description = OWNER_DESC), + @WritesAttribute(attribute = OWNER_TYPE_ATTR, description = OWNER_TYPE_DESC), + @WritesAttribute(attribute = URI_ATTR, description = URI_DESC) +}) +public class FetchGCSObject extends AbstractGCSProcessor { + public static final PropertyDescriptor BUCKET = new PropertyDescriptor + .Builder().name("gcs-bucket") + .displayName("Bucket") + .description(BUCKET_DESC) + .required(true) + .defaultValue("${" + BUCKET_ATTR + "}") + .expressionLanguageSupported(true) + .addValidator(StandardValidators.NON_EMPTY_VALIDATOR) + .build(); + + public static final PropertyDescriptor KEY = new PropertyDescriptor + .Builder().name("gcs-key") + .displayName("Key") + .description(KEY_DESC) + .required(true) + .defaultValue("${" + CoreAttributes.FILENAME.key() + "}") + .expressionLanguageSupported(true) + .addValidator(StandardValidators.NON_EMPTY_VALIDATOR) + .build(); + + public static final PropertyDescriptor GENERATION = new PropertyDescriptor.Builder() + .name("gcs-generation") + .displayName("Object Generation") + .description("The generation of the Object to download. If null, will download latest generation.") + .expressionLanguageSupported(true) + .addValidator(StandardValidators.POSITIVE_LONG_VALIDATOR) + .required(false) + .build(); + + public static final PropertyDescriptor ENCRYPTION_KEY = new PropertyDescriptor.Builder() + .name("gcs-server-side-encryption-key") + .displayName("Server Side Encryption Key") + .description("An AES256 Key (encoded in base64) which the object has been encrypted in.") + .required(false) + .expressionLanguageSupported(true) + .addValidator(StandardValidators.NON_EMPTY_VALIDATOR) + .sensitive(true) + .build(); + + @Override + public List<PropertyDescriptor> getSupportedPropertyDescriptors() { + return ImmutableList.<PropertyDescriptor>builder() + .addAll(super.getSupportedPropertyDescriptors()) + .add(BUCKET) + .add(KEY) + .add(GENERATION) + .add(ENCRYPTION_KEY) + .build(); + } + + + + @Override + public void onTrigger(ProcessContext context, ProcessSession session) throws ProcessException { + FlowFile flowFile = session.get(); + if (flowFile == null) { + return; + } + + final long startNanos = System.nanoTime(); + + String bucketName = context.getProperty(BUCKET) + .evaluateAttributeExpressions(flowFile) + .getValue(); + String key = context.getProperty(KEY) + .evaluateAttributeExpressions(flowFile) + .getValue(); + Long generation = context.getProperty(GENERATION) + .evaluateAttributeExpressions(flowFile) + .asLong(); + String encryptionKey = context.getProperty(ENCRYPTION_KEY) + .evaluateAttributeExpressions(flowFile) + .getValue(); + + final Storage storage = getCloudService(); + final Map<String, String> attributes = new HashMap<>(); + final BlobId blobId = BlobId.of(bucketName, key, generation); + + try { + final List<Storage.BlobSourceOption> blobSourceOptions = new ArrayList<>(2); + + if (encryptionKey != null) { + blobSourceOptions.add(Storage.BlobSourceOption.decryptionKey(encryptionKey)); + } + + if (generation != null) { + blobSourceOptions.add(Storage.BlobSourceOption.generationMatch()); + } + + final Blob blob = storage.get(blobId); + + if (blob == null) { + throw new StorageException(404, "Blob " + blobId + " not found"); + } + + final ReadChannel reader = storage.reader(blobId, blobSourceOptions.toArray(new Storage.BlobSourceOption[blobSourceOptions.size()])); + + flowFile = session.importFrom(Channels.newInputStream(reader), flowFile); + + attributes.put(BUCKET_ATTR, blob.getBucket()); + attributes.put(KEY_ATTR, blob.getName()); + + if (blob.getSize() != null) { + attributes.put(SIZE_ATTR, String.valueOf(blob.getSize())); + } + + if (blob.getCacheControl() != null) { + attributes.put(CACHE_CONTROL_ATTR, blob.getCacheControl()); + } + + if (blob.getComponentCount() != null) { + attributes.put(COMPONENT_COUNT_ATTR, String.valueOf(blob.getComponentCount())); + } + + if (blob.getContentEncoding() != null) { + attributes.put(CONTENT_ENCODING_ATTR, blob.getContentEncoding()); + } + + if (blob.getContentLanguage() != null) { + attributes.put(CONTENT_LANGUAGE_ATTR, blob.getContentLanguage()); + } + + if (blob.getContentType() != null) { + attributes.put(CoreAttributes.MIME_TYPE.key(), blob.getContentType()); + } + + if (blob.getCrc32c() != null) { + attributes.put(CRC32C_ATTR, blob.getCrc32c()); + } + + if (blob.getCustomerEncryption() != null) { + final BlobInfo.CustomerEncryption encryption = blob.getCustomerEncryption(); + + attributes.put(ENCRYPTION_ALGORITHM_ATTR, encryption.getEncryptionAlgorithm()); + attributes.put(ENCRYPTION_SHA256_ATTR, encryption.getKeySha256()); + } + + if (blob.getEtag() != null) { + attributes.put(ETAG_ATTR, blob.getEtag()); + } + + if (blob.getGeneratedId() != null) { + attributes.put(GENERATED_ID_ATTR, blob.getGeneratedId()); + } + + if (blob.getGeneration() != null) { + attributes.put(GENERATION_ATTR, String.valueOf(blob.getGeneration())); + } + + if (blob.getMd5() != null) { + attributes.put(MD5_ATTR, blob.getMd5()); + } + + if (blob.getMediaLink() != null) { + attributes.put(MEDIA_LINK_ATTR, blob.getMediaLink()); + } + + if (blob.getMetageneration() != null) { + attributes.put(METAGENERATION_ATTR, String.valueOf(blob.getMetageneration())); + } + + if (blob.getOwner() != null) { + final Acl.Entity entity = blob.getOwner(); + + if (entity instanceof Acl.User) { + attributes.put(OWNER_ATTR, ((Acl.User) entity).getEmail()); + attributes.put(OWNER_TYPE_ATTR, "user"); + } else if (entity instanceof Acl.Group) { + attributes.put(OWNER_ATTR, ((Acl.Group) entity).getEmail()); + attributes.put(OWNER_TYPE_ATTR, "group"); + } else if (entity instanceof Acl.Domain) { + attributes.put(OWNER_ATTR, ((Acl.Domain) entity).getDomain()); + attributes.put(OWNER_TYPE_ATTR, "domain"); + } else if (entity instanceof Acl.Project) { + attributes.put(OWNER_ATTR, ((Acl.Project) entity).getProjectId()); + attributes.put(OWNER_TYPE_ATTR, "project"); + } + } + + if (blob.getSelfLink() != null) { + attributes.put(URI_ATTR, blob.getSelfLink()); + } + + if (blob.getContentDisposition() != null) { + attributes.put(CONTENT_DISPOSITION_ATTR, blob.getContentDisposition()); + + final Util.ParsedContentDisposition parsedContentDisposition = Util.parseContentDisposition(blob.getContentDisposition()); + + if (parsedContentDisposition != null) { + attributes.put(CoreAttributes.FILENAME.key(), parsedContentDisposition.getFileName()); + } + } + + if (blob.getCreateTime() != null) { + attributes.put(CREATE_TIME_ATTR, String.valueOf(blob.getCreateTime())); + } + + if (blob.getUpdateTime() != null) { + attributes.put(UPDATE_TIME_ATTR, String.valueOf(blob.getUpdateTime())); + } + + } catch (StorageException e) { + getLogger().error(e.getMessage(), e); + flowFile = session.penalize(flowFile); + session.transfer(flowFile, REL_FAILURE); + return; + } + + if (!attributes.isEmpty()) { + flowFile = session.putAllAttributes(flowFile, attributes); + } + session.transfer(flowFile, REL_SUCCESS); + + final long millis = TimeUnit.NANOSECONDS.toMillis(System.nanoTime() - startNanos); + getLogger().info("Successfully retrieved GCS Object for {} in {} millis; routing to success", new Object[]{flowFile, millis}); + session.getProvenanceReporter().fetch( + flowFile, + "https://"; + bucketName + ".storage.googleapis.com/" + key, + millis); + } +} http://git-wip-us.apache.org/repos/asf/nifi/blob/897c7029/nifi-nar-bundles/nifi-gcp-bundle/nifi-gcp-processors/src/main/java/org/apache/nifi/processors/gcp/storage/ListGCSBucket.java ---------------------------------------------------------------------- diff --git a/nifi-nar-bundles/nifi-gcp-bundle/nifi-gcp-processors/src/main/java/org/apache/nifi/processors/gcp/storage/ListGCSBucket.java b/nifi-nar-bundles/nifi-gcp-bundle/nifi-gcp-processors/src/main/java/org/apache/nifi/processors/gcp/storage/ListGCSBucket.java new file mode 100644 index 0000000..8998953 --- /dev/null +++ b/nifi-nar-bundles/nifi-gcp-bundle/nifi-gcp-processors/src/main/java/org/apache/nifi/processors/gcp/storage/ListGCSBucket.java @@ -0,0 +1,409 @@ +/* + * 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.gcp.storage; + +import com.google.cloud.Page; +import com.google.cloud.storage.Acl; +import com.google.cloud.storage.Blob; +import com.google.cloud.storage.BlobInfo; +import com.google.cloud.storage.Storage; +import com.google.common.collect.ImmutableList; +import org.apache.nifi.annotation.behavior.Stateful; +import org.apache.nifi.annotation.behavior.WritesAttribute; +import org.apache.nifi.annotation.behavior.WritesAttributes; +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.components.state.Scope; +import org.apache.nifi.components.state.StateMap; +import org.apache.nifi.flowfile.FlowFile; +import org.apache.nifi.flowfile.attributes.CoreAttributes; +import org.apache.nifi.processor.ProcessContext; +import org.apache.nifi.processor.ProcessSession; +import org.apache.nifi.processor.Relationship; +import org.apache.nifi.processor.exception.ProcessException; +import org.apache.nifi.processor.util.StandardValidators; + +import java.io.IOException; +import java.util.ArrayList; +import java.util.Collections; +import java.util.HashMap; +import java.util.HashSet; +import java.util.List; +import java.util.Map; +import java.util.Set; +import java.util.concurrent.TimeUnit; +import java.util.stream.Collectors; + +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.BUCKET_ATTR; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.BUCKET_DESC; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.CACHE_CONTROL_ATTR; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.CACHE_CONTROL_DESC; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.COMPONENT_COUNT_ATTR; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.COMPONENT_COUNT_DESC; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.CONTENT_DISPOSITION_ATTR; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.CONTENT_DISPOSITION_DESC; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.CONTENT_ENCODING_ATTR; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.CONTENT_ENCODING_DESC; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.CONTENT_LANGUAGE_ATTR; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.CONTENT_LANGUAGE_DESC; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.CRC32C_ATTR; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.CRC32C_DESC; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.CREATE_TIME_ATTR; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.CREATE_TIME_DESC; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.ENCRYPTION_ALGORITHM_ATTR; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.ENCRYPTION_ALGORITHM_DESC; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.ENCRYPTION_SHA256_ATTR; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.ENCRYPTION_SHA256_DESC; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.ETAG_ATTR; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.ETAG_DESC; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.GENERATED_ID_ATTR; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.GENERATED_ID_DESC; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.GENERATION_ATTR; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.GENERATION_DESC; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.KEY_ATTR; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.KEY_DESC; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.MD5_ATTR; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.MD5_DESC; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.MEDIA_LINK_ATTR; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.MEDIA_LINK_DESC; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.METAGENERATION_ATTR; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.METAGENERATION_DESC; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.OWNER_ATTR; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.OWNER_DESC; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.OWNER_TYPE_ATTR; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.OWNER_TYPE_DESC; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.SIZE_ATTR; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.SIZE_DESC; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.UPDATE_TIME_ATTR; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.UPDATE_TIME_DESC; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.URI_ATTR; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.URI_DESC; + +/** + * List objects in a google cloud storage bucket by object name pattern. + */ +@Tags({"google cloud", "google", "storage", "gcs", "list"}) +@CapabilityDescription("Retrieves a listing of objects from an GCS bucket. For each object that is listed, creates a FlowFile that represents " + + "the object so that it can be fetched in conjunction with FetchGCSObject. This Processor is designed to run on Primary Node only " + + "in a cluster. If the primary node changes, the new Primary Node will pick up where the previous node left off without duplicating " + + "all of the data.") +@Stateful(scopes = Scope.CLUSTER, description = "After performing a listing of keys, the timestamp of the newest key is stored, " + + "along with the keys that share that same timestamp. This allows the Processor to list only keys that have been added or modified after " + + "this date the next time that the Processor is run. State is stored across the cluster so that this Processor can be run on Primary Node only and if a new Primary " + + "Node is selected, the new node can pick up where the previous node left off, without duplicating the data.") +@SeeAlso({PutGCSObject.class, DeleteGCSObject.class, FetchGCSObject.class}) +@WritesAttributes({ + @WritesAttribute(attribute = "filename", description = "The name of the file"), + @WritesAttribute(attribute = BUCKET_ATTR, description = BUCKET_DESC), + @WritesAttribute(attribute = KEY_ATTR, description = KEY_DESC), + @WritesAttribute(attribute = SIZE_ATTR, description = SIZE_DESC), + @WritesAttribute(attribute = CACHE_CONTROL_ATTR, description = CACHE_CONTROL_DESC), + @WritesAttribute(attribute = COMPONENT_COUNT_ATTR, description = COMPONENT_COUNT_DESC), + @WritesAttribute(attribute = CONTENT_DISPOSITION_ATTR, description = CONTENT_DISPOSITION_DESC), + @WritesAttribute(attribute = CONTENT_ENCODING_ATTR, description = CONTENT_ENCODING_DESC), + @WritesAttribute(attribute = CONTENT_LANGUAGE_ATTR, description = CONTENT_LANGUAGE_DESC), + @WritesAttribute(attribute = "mime.type", description = "The MIME/Content-Type of the object"), + @WritesAttribute(attribute = CRC32C_ATTR, description = CRC32C_DESC), + @WritesAttribute(attribute = CREATE_TIME_ATTR, description = CREATE_TIME_DESC), + @WritesAttribute(attribute = UPDATE_TIME_ATTR, description = UPDATE_TIME_DESC), + @WritesAttribute(attribute = ENCRYPTION_ALGORITHM_ATTR, description = ENCRYPTION_ALGORITHM_DESC), + @WritesAttribute(attribute = ENCRYPTION_SHA256_ATTR, description = ENCRYPTION_SHA256_DESC), + @WritesAttribute(attribute = ETAG_ATTR, description = ETAG_DESC), + @WritesAttribute(attribute = GENERATED_ID_ATTR, description = GENERATED_ID_DESC), + @WritesAttribute(attribute = GENERATION_ATTR, description = GENERATION_DESC), + @WritesAttribute(attribute = MD5_ATTR, description = MD5_DESC), + @WritesAttribute(attribute = MEDIA_LINK_ATTR, description = MEDIA_LINK_DESC), + @WritesAttribute(attribute = METAGENERATION_ATTR, description = METAGENERATION_DESC), + @WritesAttribute(attribute = OWNER_ATTR, description = OWNER_DESC), + @WritesAttribute(attribute = OWNER_TYPE_ATTR, description = OWNER_TYPE_DESC), + @WritesAttribute(attribute = URI_ATTR, description = URI_DESC) +}) +public class ListGCSBucket extends AbstractGCSProcessor { + public static final PropertyDescriptor BUCKET = new PropertyDescriptor + .Builder().name("gcs-bucket") + .displayName("Bucket") + .description(BUCKET_DESC) + .required(true) + .expressionLanguageSupported(false) + .addValidator(StandardValidators.NON_EMPTY_VALIDATOR) + .build(); + + public static final PropertyDescriptor PREFIX = new PropertyDescriptor.Builder() + .name("gcs-prefix") + .displayName("Prefix") + .description("The prefix used to filter the object list. In most cases, it should end with a forward slash ('/').") + .required(false) + .addValidator(StandardValidators.NON_EMPTY_VALIDATOR) + .build(); + + public static final PropertyDescriptor USE_GENERATIONS = new PropertyDescriptor.Builder() + .name("gcs-use-generations") + .displayName("Use Generations") + .expressionLanguageSupported(false) + .required(true) + .addValidator(StandardValidators.BOOLEAN_VALIDATOR) + .allowableValues("true", "false") + .defaultValue("false") + .description("Specifies whether to use GCS Generations, if applicable. If false, only the latest version of each object will be returned.") + .build(); + + @Override + public List<PropertyDescriptor> getSupportedPropertyDescriptors() { + return ImmutableList.<PropertyDescriptor>builder() + .addAll(super.getSupportedPropertyDescriptors()) + .add(BUCKET) + .add(PREFIX) + .add(USE_GENERATIONS) + .build(); + } + + public static final Set<Relationship> relationships = Collections.unmodifiableSet( + new HashSet<>(Collections.singletonList(REL_SUCCESS))); + @Override + public Set<Relationship> getRelationships() { + return relationships; + } + + // State tracking + public static final String CURRENT_TIMESTAMP = "currentTimestamp"; + public static final String CURRENT_KEY_PREFIX = "key-"; + protected long currentTimestamp = 0L; + protected Set<String> currentKeys; + + + private Set<String> extractKeys(final StateMap stateMap) { + return stateMap.toMap().entrySet().parallelStream() + .filter(x -> x.getKey().startsWith(CURRENT_KEY_PREFIX)) + .map(Map.Entry::getValue) + .collect(Collectors.toSet()); + } + + void restoreState(final ProcessContext context) throws IOException { + final StateMap stateMap = context.getStateManager().getState(Scope.CLUSTER); + if (stateMap.getVersion() == -1L || stateMap.get(CURRENT_TIMESTAMP) == null || stateMap.get(CURRENT_KEY_PREFIX+"0") == null) { + currentTimestamp = 0L; + currentKeys = new HashSet<>(); + } else { + currentTimestamp = Long.parseLong(stateMap.get(CURRENT_TIMESTAMP)); + currentKeys = extractKeys(stateMap); + } + } + + void persistState(final ProcessContext context) { + Map<String, String> state = new HashMap<>(); + state.put(CURRENT_TIMESTAMP, String.valueOf(currentTimestamp)); + int i = 0; + for (String key : currentKeys) { + state.put(CURRENT_KEY_PREFIX+i, key); + i++; + } + try { + context.getStateManager().setState(state, Scope.CLUSTER); + } catch (IOException ioe) { + getLogger().error("Failed to save cluster-wide state. If NiFi is restarted, data duplication may occur", ioe); + } + } + + @Override + public void onTrigger(ProcessContext context, ProcessSession session) throws ProcessException { + try { + restoreState(context); + } catch (IOException e) { + getLogger().error("Failed to restore processor state; yielding", e); + context.yield(); + return; + } + + final long startNanos = System.nanoTime(); + + final String bucket = context.getProperty(BUCKET).getValue(); + + final String prefix = context.getProperty(PREFIX).getValue(); + + final boolean useGenerations = context.getProperty(USE_GENERATIONS).asBoolean(); + + List<Storage.BlobListOption> listOptions = new ArrayList<>(); + if (prefix != null) { + listOptions.add(Storage.BlobListOption.prefix(prefix)); + } + + if (useGenerations) { + listOptions.add(Storage.BlobListOption.versions(true)); + } + + final Storage storage = getCloudService(); + int listCount = 0; + long maxTimestamp = 0L; + + + Page<Blob> blobPages = storage.list(bucket, listOptions.toArray(new Storage.BlobListOption[listOptions.size()])); + do { + for (Blob blob : blobPages.getValues()) { + long lastModified = blob.getUpdateTime(); + if (lastModified < currentTimestamp + || lastModified == currentTimestamp && currentKeys.contains(blob.getName())) { + continue; + } + + // Create attributes + final Map<String, String> attributes = new HashMap<>(); + + attributes.put(BUCKET_ATTR, blob.getBucket()); + attributes.put(KEY_ATTR, blob.getName()); + + if (blob.getSize() != null) { + attributes.put(SIZE_ATTR, String.valueOf(blob.getSize())); + } + + if (blob.getCacheControl() != null) { + attributes.put(CACHE_CONTROL_ATTR, blob.getCacheControl()); + } + + if (blob.getComponentCount() != null) { + attributes.put(COMPONENT_COUNT_ATTR, String.valueOf(blob.getComponentCount())); + } + + if (blob.getContentDisposition() != null) { + attributes.put(CONTENT_DISPOSITION_ATTR, blob.getContentDisposition()); + } + + if (blob.getContentEncoding() != null) { + attributes.put(CONTENT_ENCODING_ATTR, blob.getContentEncoding()); + } + + if (blob.getContentLanguage() != null) { + attributes.put(CONTENT_LANGUAGE_ATTR, blob.getContentLanguage()); + } + + if (blob.getContentType() != null) { + attributes.put(CoreAttributes.MIME_TYPE.key(), blob.getContentType()); + } + + if (blob.getCrc32c() != null) { + attributes.put(CRC32C_ATTR, blob.getCrc32c()); + } + + if (blob.getCustomerEncryption() != null) { + final BlobInfo.CustomerEncryption encryption = blob.getCustomerEncryption(); + + attributes.put(ENCRYPTION_ALGORITHM_ATTR, encryption.getEncryptionAlgorithm()); + attributes.put(ENCRYPTION_SHA256_ATTR, encryption.getKeySha256()); + } + + if (blob.getEtag() != null) { + attributes.put(ETAG_ATTR, blob.getEtag()); + } + + if (blob.getGeneratedId() != null) { + attributes.put(GENERATED_ID_ATTR, blob.getGeneratedId()); + } + + if (blob.getGeneration() != null) { + attributes.put(GENERATION_ATTR, String.valueOf(blob.getGeneration())); + } + + if (blob.getMd5() != null) { + attributes.put(MD5_ATTR, blob.getMd5()); + } + + if (blob.getMediaLink() != null) { + attributes.put(MEDIA_LINK_ATTR, blob.getMediaLink()); + } + + if (blob.getMetageneration() != null) { + attributes.put(METAGENERATION_ATTR, String.valueOf(blob.getMetageneration())); + } + + if (blob.getOwner() != null) { + final Acl.Entity entity = blob.getOwner(); + + if (entity instanceof Acl.User) { + attributes.put(OWNER_ATTR, ((Acl.User) entity).getEmail()); + attributes.put(OWNER_TYPE_ATTR, "user"); + } else if (entity instanceof Acl.Group) { + attributes.put(OWNER_ATTR, ((Acl.Group) entity).getEmail()); + attributes.put(OWNER_TYPE_ATTR, "group"); + } else if (entity instanceof Acl.Domain) { + attributes.put(OWNER_ATTR, ((Acl.Domain) entity).getDomain()); + attributes.put(OWNER_TYPE_ATTR, "domain"); + } else if (entity instanceof Acl.Project) { + attributes.put(OWNER_ATTR, ((Acl.Project) entity).getProjectId()); + attributes.put(OWNER_TYPE_ATTR, "project"); + } + } + + if (blob.getSelfLink() != null) { + attributes.put(URI_ATTR, blob.getSelfLink()); + } + + attributes.put(CoreAttributes.FILENAME.key(), blob.getName()); + + if (blob.getCreateTime() != null) { + attributes.put(CREATE_TIME_ATTR, String.valueOf(blob.getCreateTime())); + } + + if (blob.getUpdateTime() != null) { + attributes.put(UPDATE_TIME_ATTR, String.valueOf(blob.getUpdateTime())); + } + + // Create the flowfile + FlowFile flowFile = session.create(); + flowFile = session.putAllAttributes(flowFile, attributes); + session.transfer(flowFile, REL_SUCCESS); + + // Update state + if (lastModified > maxTimestamp) { + maxTimestamp = lastModified; + currentKeys.clear(); + } + if (lastModified == maxTimestamp) { + currentKeys.add(blob.getName()); + } + listCount++; + } + + blobPages = blobPages.getNextPage(); + commit(context, session, listCount); + listCount = 0; + } while (blobPages != null); + + currentTimestamp = maxTimestamp; + + final long listMillis = TimeUnit.NANOSECONDS.toMillis(System.nanoTime() - startNanos); + getLogger().info("Successfully listed GCS bucket {} in {} millis", new Object[]{bucket, listMillis}); + + if (!commit(context, session, listCount)) { + if (currentTimestamp > 0) { + persistState(context); + } + getLogger().debug("No new objects in GCS bucket {} to list. Yielding.", new Object[]{bucket}); + context.yield(); + } + } + + private boolean commit(final ProcessContext context, final ProcessSession session, int listCount) { + boolean willCommit = listCount > 0; + if (willCommit) { + getLogger().info("Successfully listed {} new files from GCS; routing to success", new Object[] {listCount}); + session.commit(); + persistState(context); + } + return willCommit; + } +} http://git-wip-us.apache.org/repos/asf/nifi/blob/897c7029/nifi-nar-bundles/nifi-gcp-bundle/nifi-gcp-processors/src/main/java/org/apache/nifi/processors/gcp/storage/PutGCSObject.java ---------------------------------------------------------------------- diff --git a/nifi-nar-bundles/nifi-gcp-bundle/nifi-gcp-processors/src/main/java/org/apache/nifi/processors/gcp/storage/PutGCSObject.java b/nifi-nar-bundles/nifi-gcp-bundle/nifi-gcp-processors/src/main/java/org/apache/nifi/processors/gcp/storage/PutGCSObject.java new file mode 100644 index 0000000..2b77b1b --- /dev/null +++ b/nifi-nar-bundles/nifi-gcp-bundle/nifi-gcp-processors/src/main/java/org/apache/nifi/processors/gcp/storage/PutGCSObject.java @@ -0,0 +1,538 @@ +/* + * 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.gcp.storage; + +import com.google.cloud.storage.Acl; +import com.google.cloud.storage.Blob; +import com.google.cloud.storage.BlobId; +import com.google.cloud.storage.BlobInfo; +import com.google.cloud.storage.Storage; +import com.google.cloud.storage.StorageException; +import com.google.common.collect.ImmutableList; +import org.apache.nifi.annotation.behavior.DynamicProperty; +import org.apache.nifi.annotation.behavior.InputRequirement; +import org.apache.nifi.annotation.behavior.ReadsAttribute; +import org.apache.nifi.annotation.behavior.ReadsAttributes; +import org.apache.nifi.annotation.behavior.WritesAttribute; +import org.apache.nifi.annotation.behavior.WritesAttributes; +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.AllowableValue; +import org.apache.nifi.components.PropertyDescriptor; +import org.apache.nifi.flowfile.FlowFile; +import org.apache.nifi.flowfile.attributes.CoreAttributes; +import org.apache.nifi.processor.ProcessContext; +import org.apache.nifi.processor.ProcessSession; +import org.apache.nifi.processor.exception.ProcessException; +import org.apache.nifi.processor.io.InputStreamCallback; +import org.apache.nifi.processor.util.StandardValidators; + +import java.io.BufferedInputStream; +import java.io.IOException; +import java.io.InputStream; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import java.util.concurrent.TimeUnit; + +import static com.google.cloud.storage.Storage.PredefinedAcl.ALL_AUTHENTICATED_USERS; +import static com.google.cloud.storage.Storage.PredefinedAcl.AUTHENTICATED_READ; +import static com.google.cloud.storage.Storage.PredefinedAcl.BUCKET_OWNER_FULL_CONTROL; +import static com.google.cloud.storage.Storage.PredefinedAcl.BUCKET_OWNER_READ; +import static com.google.cloud.storage.Storage.PredefinedAcl.PRIVATE; +import static com.google.cloud.storage.Storage.PredefinedAcl.PROJECT_PRIVATE; +import static com.google.cloud.storage.Storage.PredefinedAcl.PUBLIC_READ; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.BUCKET_ATTR; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.BUCKET_DESC; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.CACHE_CONTROL_ATTR; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.CACHE_CONTROL_DESC; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.COMPONENT_COUNT_ATTR; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.COMPONENT_COUNT_DESC; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.CONTENT_DISPOSITION_ATTR; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.CONTENT_DISPOSITION_DESC; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.CONTENT_ENCODING_ATTR; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.CONTENT_ENCODING_DESC; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.CONTENT_LANGUAGE_ATTR; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.CONTENT_LANGUAGE_DESC; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.CRC32C_ATTR; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.CRC32C_DESC; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.CREATE_TIME_ATTR; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.CREATE_TIME_DESC; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.ENCRYPTION_ALGORITHM_ATTR; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.ENCRYPTION_ALGORITHM_DESC; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.ENCRYPTION_SHA256_ATTR; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.ENCRYPTION_SHA256_DESC; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.ETAG_ATTR; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.ETAG_DESC; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.GENERATED_ID_ATTR; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.GENERATED_ID_DESC; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.GENERATION_ATTR; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.GENERATION_DESC; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.KEY_ATTR; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.KEY_DESC; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.MD5_ATTR; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.MD5_DESC; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.MEDIA_LINK_ATTR; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.MEDIA_LINK_DESC; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.METAGENERATION_ATTR; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.METAGENERATION_DESC; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.OWNER_ATTR; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.OWNER_DESC; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.OWNER_TYPE_ATTR; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.OWNER_TYPE_DESC; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.SIZE_ATTR; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.SIZE_DESC; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.UPDATE_TIME_ATTR; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.UPDATE_TIME_DESC; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.URI_ATTR; +import static org.apache.nifi.processors.gcp.storage.StorageAttributes.URI_DESC; + + +@InputRequirement(InputRequirement.Requirement.INPUT_REQUIRED) +@Tags({"google", "google cloud", "gcs", "archive", "put"}) +@CapabilityDescription("Puts flow files to a Google Cloud Bucket.") +@SeeAlso({FetchGCSObject.class, DeleteGCSObject.class, ListGCSBucket.class}) +@DynamicProperty(name = "The name of a User-Defined Metadata field to add to the GCS Object", + value = "The value of a User-Defined Metadata field to add to the GCS Object", + description = "Allows user-defined metadata to be added to the GCS object as key/value pairs", + supportsExpressionLanguage = true) +@ReadsAttributes({ + @ReadsAttribute(attribute = "filename", description = "Uses the FlowFile's filename as the filename for the " + + "GCS object"), + @ReadsAttribute(attribute = "mime.type", description = "Uses the FlowFile's MIME type as the content-type for " + + "the GCS object") +}) +@WritesAttributes({ + @WritesAttribute(attribute = BUCKET_ATTR, description = BUCKET_DESC), + @WritesAttribute(attribute = KEY_ATTR, description = KEY_DESC), + @WritesAttribute(attribute = SIZE_ATTR, description = SIZE_DESC), + @WritesAttribute(attribute = CACHE_CONTROL_ATTR, description = CACHE_CONTROL_DESC), + @WritesAttribute(attribute = COMPONENT_COUNT_ATTR, description = COMPONENT_COUNT_DESC), + @WritesAttribute(attribute = CONTENT_DISPOSITION_ATTR, description = CONTENT_DISPOSITION_DESC), + @WritesAttribute(attribute = CONTENT_ENCODING_ATTR, description = CONTENT_ENCODING_DESC), + @WritesAttribute(attribute = CONTENT_LANGUAGE_ATTR, description = CONTENT_LANGUAGE_DESC), + @WritesAttribute(attribute = "mime.type", description = "The MIME/Content-Type of the object"), + @WritesAttribute(attribute = CRC32C_ATTR, description = CRC32C_DESC), + @WritesAttribute(attribute = CREATE_TIME_ATTR, description = CREATE_TIME_DESC), + @WritesAttribute(attribute = UPDATE_TIME_ATTR, description = UPDATE_TIME_DESC), + @WritesAttribute(attribute = ENCRYPTION_ALGORITHM_ATTR, description = ENCRYPTION_ALGORITHM_DESC), + @WritesAttribute(attribute = ENCRYPTION_SHA256_ATTR, description = ENCRYPTION_SHA256_DESC), + @WritesAttribute(attribute = ETAG_ATTR, description = ETAG_DESC), + @WritesAttribute(attribute = GENERATED_ID_ATTR, description = GENERATED_ID_DESC), + @WritesAttribute(attribute = GENERATION_ATTR, description = GENERATION_DESC), + @WritesAttribute(attribute = MD5_ATTR, description = MD5_DESC), + @WritesAttribute(attribute = MEDIA_LINK_ATTR, description = MEDIA_LINK_DESC), + @WritesAttribute(attribute = METAGENERATION_ATTR, description = METAGENERATION_DESC), + @WritesAttribute(attribute = OWNER_ATTR, description = OWNER_DESC), + @WritesAttribute(attribute = OWNER_TYPE_ATTR, description = OWNER_TYPE_DESC), + @WritesAttribute(attribute = URI_ATTR, description = URI_DESC) +}) +public class PutGCSObject extends AbstractGCSProcessor { + public static final PropertyDescriptor BUCKET = new PropertyDescriptor + .Builder().name("gcs-bucket") + .displayName("Bucket") + .description(BUCKET_DESC) + .required(true) + .defaultValue("${" + BUCKET_ATTR + "}") + .expressionLanguageSupported(true) + .addValidator(StandardValidators.NON_EMPTY_VALIDATOR) + .build(); + + public static final PropertyDescriptor KEY = new PropertyDescriptor + .Builder().name("gcs-key") + .displayName("Key") + .description(KEY_DESC) + .required(true) + .defaultValue("${filename}") + .expressionLanguageSupported(true) + .addValidator(StandardValidators.NON_EMPTY_VALIDATOR) + .build(); + + public static final PropertyDescriptor CONTENT_TYPE = new PropertyDescriptor + .Builder().name("gcs-content-type") + .displayName("Content Type") + .description("Content Type for the file, i.e. text/plain") + .defaultValue("${mime.type}") + .required(false) + .expressionLanguageSupported(true) + .addValidator(StandardValidators.NON_EMPTY_VALIDATOR) + .build(); + + public static final PropertyDescriptor MD5 = new PropertyDescriptor + .Builder().name("gcs-object-md5") + .displayName("MD5 Hash") + .description("MD5 Hash (encoded in Base64) of the file for server-side validation.") + .required(false) + .expressionLanguageSupported(true) + .addValidator(StandardValidators.NON_EMPTY_VALIDATOR) + .build(); + + + public static final PropertyDescriptor CRC32C = new PropertyDescriptor + .Builder().name("gcs-object-crc32c") + .displayName("CRC32C Checksum") + .description("CRC32C Checksum (encoded in Base64, big-Endian order) of the file for server-side validation.") + .required(false) + .expressionLanguageSupported(true) + .addValidator(StandardValidators.NON_EMPTY_VALIDATOR) + .build(); + + public static final AllowableValue ACL_ALL_AUTHENTICATED_USERS = new AllowableValue( + ALL_AUTHENTICATED_USERS.name(), "All Authenticated Users", "Gives the bucket or object owner OWNER " + + "permission, and gives all authenticated Google account holders READER and WRITER permissions. " + + "All other permissions are removed." + ); + + public static final AllowableValue ACL_AUTHENTICATED_READ = new AllowableValue( + AUTHENTICATED_READ.name(), "Authenticated Read", "Gives the bucket or object owner OWNER permission, " + + "and gives all authenticated Google account holders READER permission. All other permissions are removed." + ); + + public static final AllowableValue ACL_BUCKET_OWNER_FULL_CONTROL = new AllowableValue( + BUCKET_OWNER_FULL_CONTROL.name(), "Bucket Owner Full Control", "Gives the object and bucket owners OWNER " + + "permission. All other permissions are removed." + ); + + public static final AllowableValue ACL_BUCKET_OWNER_READ = new AllowableValue( + BUCKET_OWNER_READ.name(), "Bucket Owner Read Only", "Gives the object owner OWNER permission, and gives " + + "the bucket owner READER permission. All other permissions are removed." + ); + + public static final AllowableValue ACL_PRIVATE = new AllowableValue( + PRIVATE.name(), "Private", "Gives the bucket or object owner OWNER permission for a bucket or object, " + + "and removes all other access permissions." + ); + + public static final AllowableValue ACL_PROJECT_PRIVATE = new AllowableValue( + PROJECT_PRIVATE.name(), "Project Private", "Gives permission to the project team based on their roles. " + + "Anyone who is part of the team has READER permission. Project owners and project editors have OWNER " + + "permission. This is the default ACL for newly created buckets. This is also the default ACL for newly " + + "created objects unless the default object ACL for that bucket has been changed." + ); + + public static final AllowableValue ACL_PUBLIC_READ = new AllowableValue( + PUBLIC_READ.name(), "Public Read Only", "Gives the bucket or object owner OWNER permission, and gives all " + + "users, both authenticated and anonymous, READER permission. When you apply this to an object, anyone on " + + "the Internet can read the object without authenticating." + ); + + public static final PropertyDescriptor ACL = new PropertyDescriptor.Builder() + .name("gcs-object-acl") + .displayName("Object ACL") + .description("Access Control to be attached to the object uploaded. Not providing this will revert to bucket defaults.") + .required(false) + .allowableValues( + ACL_ALL_AUTHENTICATED_USERS, + ACL_AUTHENTICATED_READ, + ACL_BUCKET_OWNER_FULL_CONTROL, + ACL_BUCKET_OWNER_READ, + ACL_PRIVATE, + ACL_PROJECT_PRIVATE, + ACL_PUBLIC_READ) + .build(); + + public static final PropertyDescriptor ENCRYPTION_KEY = new PropertyDescriptor.Builder() + .name("gcs-server-side-encryption-key") + .displayName("Server Side Encryption Key") + .description("An AES256 Encryption Key (encoded in base64) for server-side encryption of the object.") + .required(false) + .expressionLanguageSupported(true) + .addValidator(StandardValidators.NON_EMPTY_VALIDATOR) + .sensitive(true) + .build(); + + + public static final PropertyDescriptor OVERWRITE = new PropertyDescriptor.Builder() + .name("gcs-overwrite-object") + .displayName("Overwrite Object") + .description("If false, the upload to GCS will succeed only if the object does not exist.") + .required(true) + .addValidator(StandardValidators.BOOLEAN_VALIDATOR) + .allowableValues("true", "false") + .defaultValue("true") + .build(); + + public static final AllowableValue CD_INLINE = new AllowableValue( + "inline", "Inline", "Indicates that the object should be loaded and rendered within the browser." + ); + + public static final AllowableValue CD_ATTACHMENT = new AllowableValue( + "attachment", "Attachment", "Indicates that the object should be saved (using a Save As... dialog) rather " + + "than opened directly within the browser" + ); + + public static final PropertyDescriptor CONTENT_DISPOSITION_TYPE = new PropertyDescriptor.Builder() + .name("gcs-content-disposition-type") + .displayName("Content Disposition Type") + .description("Type of RFC-6266 Content Disposition to be attached to the object") + .required(false) + .addValidator(StandardValidators.NON_EMPTY_VALIDATOR) + .allowableValues(CD_INLINE, CD_ATTACHMENT) + .build(); + + @Override + public List<PropertyDescriptor> getSupportedPropertyDescriptors() { + return ImmutableList.<PropertyDescriptor>builder() + .addAll(super.getSupportedPropertyDescriptors()) + .add(BUCKET) + .add(KEY) + .add(CONTENT_TYPE) + .add(MD5) + .add(CRC32C) + .add(ACL) + .add(ENCRYPTION_KEY) + .add(OVERWRITE) + .add(CONTENT_DISPOSITION_TYPE) + .build(); + } + + @Override + protected PropertyDescriptor getSupportedDynamicPropertyDescriptor(final String propertyDescriptorName) { + return new PropertyDescriptor.Builder() + .name(propertyDescriptorName) + .addValidator(StandardValidators.NON_EMPTY_VALIDATOR) + .expressionLanguageSupported(true) + .dynamic(true) + .build(); + } + + @Override + public void onTrigger(final ProcessContext context, final ProcessSession session) throws ProcessException { + 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 boolean overwrite = context.getProperty(OVERWRITE).asBoolean(); + + final FlowFile ff = flowFile; + final String ffFilename = ff.getAttributes().get(CoreAttributes.FILENAME.key()); + final Map<String, String> attributes = new HashMap<>(); + + try { + final Storage storage = getCloudService(); + session.read(flowFile, new InputStreamCallback() { + @Override + public void process(InputStream rawIn) throws IOException { + try (final InputStream in = new BufferedInputStream(rawIn)) { + final BlobId id = BlobId.of(bucket, key); + final BlobInfo.Builder blobInfoBuilder = BlobInfo.newBuilder(id); + final List<Storage.BlobWriteOption> blobWriteOptions = new ArrayList<>(); + + if (!overwrite) { + blobWriteOptions.add(Storage.BlobWriteOption.doesNotExist()); + } + + final String contentDispositionType = context.getProperty(CONTENT_DISPOSITION_TYPE).getValue(); + if (contentDispositionType != null) { + blobInfoBuilder.setContentDisposition(contentDispositionType + "; filename=" + ffFilename); + } + + final String contentType = context.getProperty(CONTENT_TYPE) + .evaluateAttributeExpressions(ff).getValue(); + if (contentType != null) { + blobInfoBuilder.setContentType(contentType); + } + + final String md5 = context.getProperty(MD5) + .evaluateAttributeExpressions(ff).getValue(); + if (md5 != null) { + blobInfoBuilder.setMd5(md5); + blobWriteOptions.add(Storage.BlobWriteOption.md5Match()); + } + + final String crc32c = context.getProperty(CRC32C) + .evaluateAttributeExpressions(ff).getValue(); + if (crc32c != null) { + blobInfoBuilder.setCrc32c(crc32c); + blobWriteOptions.add(Storage.BlobWriteOption.crc32cMatch()); + } + + final String acl = context.getProperty(ACL).getValue(); + if (acl != null) { + blobWriteOptions.add(Storage.BlobWriteOption.predefinedAcl( + Storage.PredefinedAcl.valueOf(acl) + )); + } + + final String encryptionKey = context.getProperty(ENCRYPTION_KEY) + .evaluateAttributeExpressions(ff).getValue(); + if (encryptionKey != null) { + blobWriteOptions.add(Storage.BlobWriteOption.encryptionKey(encryptionKey)); + } + + final HashMap<String, String> userMetadata = new HashMap<>(); + for (final Map.Entry<PropertyDescriptor, String> entry : context.getProperties().entrySet()) { + if (entry.getKey().isDynamic()) { + final String value = context.getProperty( + entry.getKey()).evaluateAttributeExpressions(ff).getValue(); + userMetadata.put(entry.getKey().getName(), value); + } + } + + if (!userMetadata.isEmpty()) { + blobInfoBuilder.setMetadata(userMetadata); + } + + try { + + final Blob blob = storage.create(blobInfoBuilder.build(), + in, + blobWriteOptions.toArray(new Storage.BlobWriteOption[blobWriteOptions.size()]) + ); + + // Create attributes + attributes.put(BUCKET_ATTR, blob.getBucket()); + attributes.put(KEY_ATTR, blob.getName()); + + + if (blob.getSize() != null) { + attributes.put(SIZE_ATTR, String.valueOf(blob.getSize())); + } + + if (blob.getCacheControl() != null) { + attributes.put(CACHE_CONTROL_ATTR, blob.getCacheControl()); + } + + if (blob.getComponentCount() != null) { + attributes.put(COMPONENT_COUNT_ATTR, String.valueOf(blob.getComponentCount())); + } + + if (blob.getContentDisposition() != null) { + attributes.put(CONTENT_DISPOSITION_ATTR, blob.getContentDisposition()); + final Util.ParsedContentDisposition parsed = Util.parseContentDisposition(blob.getContentDisposition()); + + if (parsed != null) { + attributes.put(CoreAttributes.FILENAME.key(), parsed.getFileName()); + } + } + + if (blob.getContentEncoding() != null) { + attributes.put(CONTENT_ENCODING_ATTR, blob.getContentEncoding()); + } + + if (blob.getContentLanguage() != null) { + attributes.put(CONTENT_LANGUAGE_ATTR, blob.getContentLanguage()); + } + + if (blob.getContentType() != null) { + attributes.put(CoreAttributes.MIME_TYPE.key(), blob.getContentType()); + } + + if (blob.getCrc32c() != null) { + attributes.put(CRC32C_ATTR, blob.getCrc32c()); + } + + if (blob.getCustomerEncryption() != null) { + final BlobInfo.CustomerEncryption encryption = blob.getCustomerEncryption(); + + attributes.put(ENCRYPTION_ALGORITHM_ATTR, encryption.getEncryptionAlgorithm()); + attributes.put(ENCRYPTION_SHA256_ATTR, encryption.getKeySha256()); + } + + if (blob.getEtag() != null) { + attributes.put(ETAG_ATTR, blob.getEtag()); + } + + if (blob.getGeneratedId() != null) { + attributes.put(GENERATED_ID_ATTR, blob.getGeneratedId()); + } + + if (blob.getGeneration() != null) { + attributes.put(GENERATION_ATTR, String.valueOf(blob.getGeneration())); + } + + if (blob.getMd5() != null) { + attributes.put(MD5_ATTR, blob.getMd5()); + } + + if (blob.getMediaLink() != null) { + attributes.put(MEDIA_LINK_ATTR, blob.getMediaLink()); + } + + if (blob.getMetageneration() != null) { + attributes.put(METAGENERATION_ATTR, String.valueOf(blob.getMetageneration())); + } + + if (blob.getOwner() != null) { + final Acl.Entity entity = blob.getOwner(); + + if (entity instanceof Acl.User) { + attributes.put(OWNER_ATTR, ((Acl.User) entity).getEmail()); + attributes.put(OWNER_TYPE_ATTR, "user"); + } else if (entity instanceof Acl.Group) { + attributes.put(OWNER_ATTR, ((Acl.Group) entity).getEmail()); + attributes.put(OWNER_TYPE_ATTR, "group"); + } else if (entity instanceof Acl.Domain) { + attributes.put(OWNER_ATTR, ((Acl.Domain) entity).getDomain()); + attributes.put(OWNER_TYPE_ATTR, "domain"); + } else if (entity instanceof Acl.Project) { + attributes.put(OWNER_ATTR, ((Acl.Project) entity).getProjectId()); + attributes.put(OWNER_TYPE_ATTR, "project"); + } + } + + if (blob.getSelfLink() != null) { + attributes.put(URI_ATTR, blob.getSelfLink()); + } + + if (blob.getCreateTime() != null) { + attributes.put(CREATE_TIME_ATTR, String.valueOf(blob.getCreateTime())); + } + + if (blob.getUpdateTime() != null) { + attributes.put(UPDATE_TIME_ATTR, String.valueOf(blob.getUpdateTime())); + } + } catch (StorageException e) { + getLogger().error("Failure completing upload flowfile={} bucket={} key={} reason={}", + new Object[]{ffFilename, bucket, key, e.getMessage()}, e); + throw (e); + } + + + } + } + }); + + if (!attributes.isEmpty()) { + flowFile = session.putAllAttributes(flowFile, attributes); + } + session.transfer(flowFile, REL_SUCCESS); + final long millis = TimeUnit.NANOSECONDS.toMillis(System.nanoTime() - startNanos); + final String url = "https://"; + bucket + ".storage.googleapis.com/" + key; + + session.getProvenanceReporter().send(flowFile, url, millis); + getLogger().info("Successfully put {} to Google Cloud Storage in {} milliseconds", + new Object[]{ff, millis}); + + } catch (final ProcessException | StorageException e) { + getLogger().error("Failed to put {} to Google Cloud Storage due to {}", new Object[]{flowFile, e.getMessage()}, e); + flowFile = session.penalize(flowFile); + session.transfer(flowFile, REL_FAILURE); + } + } +} http://git-wip-us.apache.org/repos/asf/nifi/blob/897c7029/nifi-nar-bundles/nifi-gcp-bundle/nifi-gcp-processors/src/main/java/org/apache/nifi/processors/gcp/storage/StorageAttributes.java ---------------------------------------------------------------------- diff --git a/nifi-nar-bundles/nifi-gcp-bundle/nifi-gcp-processors/src/main/java/org/apache/nifi/processors/gcp/storage/StorageAttributes.java b/nifi-nar-bundles/nifi-gcp-bundle/nifi-gcp-processors/src/main/java/org/apache/nifi/processors/gcp/storage/StorageAttributes.java new file mode 100644 index 0000000..46ef207 --- /dev/null +++ b/nifi-nar-bundles/nifi-gcp-bundle/nifi-gcp-processors/src/main/java/org/apache/nifi/processors/gcp/storage/StorageAttributes.java @@ -0,0 +1,95 @@ +/* + * 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.gcp.storage; + + +/** + * Common attributes being written and accessed through Google Cloud Storage. + */ +public class StorageAttributes { + private StorageAttributes() {} + + public static final String BUCKET_ATTR = "gcs.bucket"; + public static final String BUCKET_DESC = "Bucket of the object."; + + public static final String KEY_ATTR = "gcs.key"; + public static final String KEY_DESC = "Name of the object."; + + public static final String SIZE_ATTR = "gcs.size"; + public static final String SIZE_DESC = "Size of the object."; + + public static final String CACHE_CONTROL_ATTR = "gcs.cache.control"; + public static final String CACHE_CONTROL_DESC = "Data cache control of the object."; + + public static final String COMPONENT_COUNT_ATTR = "gcs.component.count"; + public static final String COMPONENT_COUNT_DESC = "The number of components which make up the object."; + + public static final String CONTENT_DISPOSITION_ATTR = "gcs.content.disposition"; + public static final String CONTENT_DISPOSITION_DESC = "The data content disposition of the object."; + + public static final String CONTENT_ENCODING_ATTR = "gcs.content.encoding"; + public static final String CONTENT_ENCODING_DESC = "The content encoding of the object."; + + public static final String CONTENT_LANGUAGE_ATTR = "gcs.content.language"; + public static final String CONTENT_LANGUAGE_DESC = "The content language of the object."; + + public static final String CRC32C_ATTR = "gcs.crc32c"; + public static final String CRC32C_DESC = "The CRC32C checksum of object's data, encoded in base64 in " + + "big-endian order."; + + public static final String CREATE_TIME_ATTR = "gcs.create.time"; + public static final String CREATE_TIME_DESC = "The creation time of the object (milliseconds)"; + + public static final String DELETE_TIME_ATTR = "gcs.delete.time"; + public static final String DELETE_TIME_DESC = "The deletion time of the object (milliseconds)"; + + public static final String UPDATE_TIME_ATTR = "gcs.update.time"; + public static final String UPDATE_TIME_DESC = "The last modification time of the object (milliseconds)"; + + public static final String ENCRYPTION_ALGORITHM_ATTR = "gcs.encryption.algorithm"; + public static final String ENCRYPTION_ALGORITHM_DESC = "The algorithm used to encrypt the object."; + + public static final String ENCRYPTION_SHA256_ATTR = "gcs.encryption.sha256"; + public static final String ENCRYPTION_SHA256_DESC = "The SHA256 hash of the key used to encrypt the object"; + + public static final String ETAG_ATTR = "gcs.etag"; + public static final String ETAG_DESC = "The HTTP 1.1 Entity tag for the object."; + + public static final String GENERATED_ID_ATTR = "gcs.generated.id"; + public static final String GENERATED_ID_DESC = "The service-generated for the object"; + + public static final String GENERATION_ATTR = "gcs.generation"; + public static final String GENERATION_DESC = "The data generation of the object."; + + public static final String MD5_ATTR = "gcs.md5"; + public static final String MD5_DESC = "The MD5 hash of the object's data encoded in base64."; + + public static final String MEDIA_LINK_ATTR = "gcs.media.link"; + public static final String MEDIA_LINK_DESC = "The media download link to the object."; + + public static final String METAGENERATION_ATTR = "gcs.metageneration"; + public static final String METAGENERATION_DESC = "The metageneration of the object."; + + public static final String OWNER_ATTR = "gcs.owner"; + public static final String OWNER_DESC = "The owner (uploader) of the object."; + + public static final String OWNER_TYPE_ATTR = "gcs.owner.type"; + public static final String OWNER_TYPE_DESC = "The ACL entity type of the uploader of the object."; + + public static final String URI_ATTR = "gcs.uri"; + public static final String URI_DESC = "The URI of the object as a string."; +} http://git-wip-us.apache.org/repos/asf/nifi/blob/897c7029/nifi-nar-bundles/nifi-gcp-bundle/nifi-gcp-processors/src/main/java/org/apache/nifi/processors/gcp/storage/Util.java ---------------------------------------------------------------------- diff --git a/nifi-nar-bundles/nifi-gcp-bundle/nifi-gcp-processors/src/main/java/org/apache/nifi/processors/gcp/storage/Util.java b/nifi-nar-bundles/nifi-gcp-bundle/nifi-gcp-processors/src/main/java/org/apache/nifi/processors/gcp/storage/Util.java new file mode 100644 index 0000000..b84a560 --- /dev/null +++ b/nifi-nar-bundles/nifi-gcp-bundle/nifi-gcp-processors/src/main/java/org/apache/nifi/processors/gcp/storage/Util.java @@ -0,0 +1,61 @@ +/* + * 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.gcp.storage; + +import java.util.regex.Matcher; +import java.util.regex.Pattern; + +/** + * Utility class(es) for Storage functionality. + */ +class Util { + + private static final Pattern CONTENT_DISPOSITION_PATTERN = + Pattern.compile("^(.+);\\s*filename\\s*=\\s*\"([^\"]*)\""); + /** + * Parses the filename from a <a href="https://www.w3.org/Protocols/rfc2616/rfc2616-sec19.html#sec19.5.1";>Content-Disposition</a> + * header. + * @param contentDisposition The Content-Disposition header to be parsed + * @return the parsed content disposition. + */ + public static ParsedContentDisposition parseContentDisposition(String contentDisposition) { + Matcher m = CONTENT_DISPOSITION_PATTERN.matcher(contentDisposition); + if (m.find() && m.groupCount() == 2) { + return new ParsedContentDisposition(m.group(1), m.group(2)); + } + return null; + } + + public static class ParsedContentDisposition { + private final String contentDispositionType; + private final String fileName; + + private ParsedContentDisposition(String contentDispositionType, String fileName) { + this.contentDispositionType = contentDispositionType; + this.fileName = fileName; + } + + + public String getFileName() { + return this.fileName; + } + + public String getContentDispositionType() { + return this.contentDispositionType; + } + } +} http://git-wip-us.apache.org/repos/asf/nifi/blob/897c7029/nifi-nar-bundles/nifi-gcp-bundle/nifi-gcp-processors/src/main/resources/META-INF/services/org.apache.nifi.controller.ControllerService ---------------------------------------------------------------------- diff --git a/nifi-nar-bundles/nifi-gcp-bundle/nifi-gcp-processors/src/main/resources/META-INF/services/org.apache.nifi.controller.ControllerService b/nifi-nar-bundles/nifi-gcp-bundle/nifi-gcp-processors/src/main/resources/META-INF/services/org.apache.nifi.controller.ControllerService new file mode 100644 index 0000000..ee70d2f --- /dev/null +++ b/nifi-nar-bundles/nifi-gcp-bundle/nifi-gcp-processors/src/main/resources/META-INF/services/org.apache.nifi.controller.ControllerService @@ -0,0 +1,15 @@ +# 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. +org.apache.nifi.processors.gcp.credentials.service.GCPCredentialsControllerService \ No newline at end of file http://git-wip-us.apache.org/repos/asf/nifi/blob/897c7029/nifi-nar-bundles/nifi-gcp-bundle/nifi-gcp-processors/src/main/resources/META-INF/services/org.apache.nifi.processor.Processor ---------------------------------------------------------------------- diff --git a/nifi-nar-bundles/nifi-gcp-bundle/nifi-gcp-processors/src/main/resources/META-INF/services/org.apache.nifi.processor.Processor b/nifi-nar-bundles/nifi-gcp-bundle/nifi-gcp-processors/src/main/resources/META-INF/services/org.apache.nifi.processor.Processor new file mode 100644 index 0000000..b5d5df7 --- /dev/null +++ b/nifi-nar-bundles/nifi-gcp-bundle/nifi-gcp-processors/src/main/resources/META-INF/services/org.apache.nifi.processor.Processor @@ -0,0 +1,18 @@ +# 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. +org.apache.nifi.processors.gcp.storage.PutGCSObject +org.apache.nifi.processors.gcp.storage.FetchGCSObject +org.apache.nifi.processors.gcp.storage.DeleteGCSObject +org.apache.nifi.processors.gcp.storage.ListGCSBucket \ No newline at end of file
