Java tutorial
/* * 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; import com.amazonaws.AmazonWebServiceClient; import com.amazonaws.ClientConfiguration; import com.amazonaws.Protocol; import com.amazonaws.auth.AWSCredentials; import com.amazonaws.auth.AnonymousAWSCredentials; import com.amazonaws.auth.BasicAWSCredentials; import com.amazonaws.auth.PropertiesCredentials; import com.amazonaws.http.conn.ssl.SdkTLSSocketFactory; import com.amazonaws.regions.Region; import com.amazonaws.regions.Regions; import java.io.File; import java.io.IOException; import java.util.ArrayList; import java.util.Arrays; import java.util.Collection; import java.util.Collections; import java.util.HashSet; import java.util.List; import java.util.Set; import java.util.concurrent.TimeUnit; import javax.net.ssl.SSLContext; import org.apache.commons.lang3.StringUtils; import org.apache.http.conn.ssl.DefaultHostnameVerifier; import org.apache.nifi.annotation.lifecycle.OnScheduled; import org.apache.nifi.annotation.lifecycle.OnShutdown; import org.apache.nifi.components.AllowableValue; import org.apache.nifi.components.PropertyDescriptor; import org.apache.nifi.components.ValidationContext; import org.apache.nifi.components.ValidationResult; import org.apache.nifi.processor.AbstractProcessor; import org.apache.nifi.processor.ProcessContext; import org.apache.nifi.processor.Relationship; import org.apache.nifi.processor.exception.ProcessException; import org.apache.nifi.processor.util.StandardValidators; import org.apache.nifi.processors.aws.credentials.provider.factory.CredentialPropertyDescriptors; import org.apache.nifi.ssl.SSLContextService; /** * Abstract base class for aws processors. This class uses aws credentials for creating aws clients * * @deprecated use {@link AbstractAWSCredentialsProviderProcessor} instead which uses credentials providers or creating aws clients * @see AbstractAWSCredentialsProviderProcessor * */ @Deprecated public abstract class AbstractAWSProcessor<ClientType extends AmazonWebServiceClient> extends AbstractProcessor { public static final Relationship REL_SUCCESS = new Relationship.Builder().name("success") .description("FlowFiles are routed to success relationship").build(); public static final Relationship REL_FAILURE = new Relationship.Builder().name("failure") .description("FlowFiles are routed to failure relationship").build(); public static final Set<Relationship> relationships = Collections .unmodifiableSet(new HashSet<>(Arrays.asList(REL_SUCCESS, REL_FAILURE))); public static final PropertyDescriptor CREDENTIALS_FILE = CredentialPropertyDescriptors.CREDENTIALS_FILE; public static final PropertyDescriptor ACCESS_KEY = CredentialPropertyDescriptors.ACCESS_KEY; public static final PropertyDescriptor SECRET_KEY = CredentialPropertyDescriptors.SECRET_KEY; public static final PropertyDescriptor PROXY_HOST = new PropertyDescriptor.Builder().name("Proxy Host") .description("Proxy host name or IP").expressionLanguageSupported(true).required(false) .addValidator(StandardValidators.NON_EMPTY_VALIDATOR).build(); public static final PropertyDescriptor PROXY_HOST_PORT = new PropertyDescriptor.Builder() .name("Proxy Host Port").description("Proxy host port").expressionLanguageSupported(true) .required(false).addValidator(StandardValidators.PORT_VALIDATOR).build(); public static final PropertyDescriptor REGION = new PropertyDescriptor.Builder().name("Region").required(true) .allowableValues(getAvailableRegions()) .defaultValue(createAllowableValue(Regions.DEFAULT_REGION).getValue()).build(); public static final PropertyDescriptor TIMEOUT = new PropertyDescriptor.Builder().name("Communications Timeout") .required(true).addValidator(StandardValidators.TIME_PERIOD_VALIDATOR).defaultValue("30 secs").build(); public static final PropertyDescriptor SSL_CONTEXT_SERVICE = new PropertyDescriptor.Builder() .name("SSL Context Service") .description( "Specifies an optional SSL Context Service that, if provided, will be used to create connections") .required(false).identifiesControllerService(SSLContextService.class).build(); public static final PropertyDescriptor ENDPOINT_OVERRIDE = new PropertyDescriptor.Builder() .name("Endpoint Override URL") .description("Endpoint URL to use instead of the AWS default including scheme, host, port, and path. " + "The AWS libraries select an endpoint URL based on the AWS region, but this property overrides " + "the selected endpoint URL, allowing use with other S3-compatible endpoints.") .expressionLanguageSupported(true).required(false).addValidator(StandardValidators.URL_VALIDATOR) .build(); protected volatile ClientType client; protected volatile Region region; // If protocol is changed to be a property, ensure other uses are also changed protected static final Protocol DEFAULT_PROTOCOL = Protocol.HTTPS; protected static final String DEFAULT_USER_AGENT = "NiFi"; private static AllowableValue createAllowableValue(final Regions regions) { return new AllowableValue(regions.getName(), regions.getName(), regions.getName()); } private static AllowableValue[] getAvailableRegions() { final List<AllowableValue> values = new ArrayList<>(); for (final Regions regions : Regions.values()) { values.add(createAllowableValue(regions)); } return values.toArray(new AllowableValue[values.size()]); } @Override public Set<Relationship> getRelationships() { return relationships; } @Override protected Collection<ValidationResult> customValidate(final ValidationContext validationContext) { final List<ValidationResult> problems = new ArrayList<>(super.customValidate(validationContext)); final boolean accessKeySet = validationContext.getProperty(ACCESS_KEY).isSet(); final boolean secretKeySet = validationContext.getProperty(SECRET_KEY).isSet(); if ((accessKeySet && !secretKeySet) || (secretKeySet && !accessKeySet)) { problems.add(new ValidationResult.Builder().input("Access Key").valid(false) .explanation("If setting Secret Key or Access Key, must set both").build()); } final boolean credentialsFileSet = validationContext.getProperty(CREDENTIALS_FILE).isSet(); if ((secretKeySet || accessKeySet) && credentialsFileSet) { problems.add(new ValidationResult.Builder().input("Access Key").valid(false) .explanation("Cannot set both Credentials File and Secret Key/Access Key").build()); } final boolean proxyHostSet = validationContext.getProperty(PROXY_HOST).isSet(); final boolean proxyHostPortSet = validationContext.getProperty(PROXY_HOST_PORT).isSet(); if (((!proxyHostSet) && proxyHostPortSet) || (proxyHostSet && (!proxyHostPortSet))) { problems.add(new ValidationResult.Builder().input("Proxy Host Port").valid(false) .explanation("Both proxy host and port must be set").build()); } return problems; } protected ClientConfiguration createConfiguration(final ProcessContext context) { final ClientConfiguration config = new ClientConfiguration(); config.setMaxConnections(context.getMaxConcurrentTasks()); config.setMaxErrorRetry(0); config.setUserAgent(DEFAULT_USER_AGENT); // If this is changed to be a property, ensure other uses are also changed config.setProtocol(DEFAULT_PROTOCOL); final int commsTimeout = context.getProperty(TIMEOUT).asTimePeriod(TimeUnit.MILLISECONDS).intValue(); config.setConnectionTimeout(commsTimeout); config.setSocketTimeout(commsTimeout); final SSLContextService sslContextService = context.getProperty(SSL_CONTEXT_SERVICE) .asControllerService(SSLContextService.class); if (sslContextService != null) { final SSLContext sslContext = sslContextService.createSSLContext(SSLContextService.ClientAuth.NONE); // NIFI-3788: Changed hostnameVerifier from null to DHV (BrowserCompatibleHostnameVerifier is deprecated) SdkTLSSocketFactory sdkTLSSocketFactory = new SdkTLSSocketFactory(sslContext, new DefaultHostnameVerifier()); config.getApacheHttpClientConfig().setSslSocketFactory(sdkTLSSocketFactory); } if (context.getProperty(PROXY_HOST).isSet()) { String proxyHost = context.getProperty(PROXY_HOST).evaluateAttributeExpressions().getValue(); config.setProxyHost(proxyHost); Integer proxyPort = context.getProperty(PROXY_HOST_PORT).evaluateAttributeExpressions().asInteger(); config.setProxyPort(proxyPort); } return config; } @OnScheduled public void onScheduled(final ProcessContext context) { final ClientType awsClient = createClient(context, getCredentials(context), createConfiguration(context)); this.client = awsClient; initializeRegionAndEndpoint(context); } protected void initializeRegionAndEndpoint(ProcessContext context) { // if the processor supports REGION, get the configured region. if (getSupportedPropertyDescriptors().contains(REGION)) { final String region = context.getProperty(REGION).getValue(); if (region != null) { this.region = Region.getRegion(Regions.fromName(region)); client.setRegion(this.region); } else { this.region = null; } } // if the endpoint override has been configured, set the endpoint. // (per Amazon docs this should only be configured at client creation) if (getSupportedPropertyDescriptors().contains(ENDPOINT_OVERRIDE)) { final String urlstr = StringUtils .trimToEmpty(context.getProperty(ENDPOINT_OVERRIDE).evaluateAttributeExpressions().getValue()); if (!urlstr.isEmpty()) { getLogger().info("Overriding endpoint with {}", new Object[] { urlstr }); this.client.setEndpoint(urlstr); } } } /** * Create client from the arguments * @param context process context * @param credentials static aws credentials * @param config aws client configuration * @return ClientType aws client * * @deprecated use {@link AbstractAWSCredentialsProviderProcessor#createClient(ProcessContext, AWSCredentialsProvider, ClientConfiguration)} */ @Deprecated protected abstract ClientType createClient(final ProcessContext context, final AWSCredentials credentials, final ClientConfiguration config); protected ClientType getClient() { return client; } protected Region getRegion() { return region; } protected AWSCredentials getCredentials(final ProcessContext context) { final String accessKey = context.getProperty(ACCESS_KEY).evaluateAttributeExpressions().getValue(); final String secretKey = context.getProperty(SECRET_KEY).evaluateAttributeExpressions().getValue(); final String credentialsFile = context.getProperty(CREDENTIALS_FILE).getValue(); if (credentialsFile != null) { try { return new PropertiesCredentials(new File(credentialsFile)); } catch (final IOException ioe) { throw new ProcessException("Could not read Credentials File", ioe); } } if (accessKey != null && secretKey != null) { return new BasicAWSCredentials(accessKey, secretKey); } return new AnonymousAWSCredentials(); } @OnShutdown public void onShutdown() { if (getClient() != null) { getClient().shutdown(); } } }