exceptionfactory commented on code in PR #7677: URL: https://github.com/apache/nifi/pull/7677#discussion_r1323111761
########## nifi-nar-bundles/nifi-graph-bundle/nifi-other-graph-services/src/main/java/org/apache/nifi/graph/TinkerpopClientService.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.graph; + +import org.apache.commons.codec.digest.DigestUtils; +import org.apache.nifi.annotation.behavior.RequiresInstanceClassLoading; +import org.apache.nifi.annotation.documentation.CapabilityDescription; +import org.apache.nifi.annotation.documentation.Tags; +import org.apache.nifi.annotation.lifecycle.OnDisabled; +import org.apache.nifi.annotation.lifecycle.OnEnabled; +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.components.Validator; +import org.apache.nifi.components.resource.ResourceCardinality; +import org.apache.nifi.components.resource.ResourceType; +import org.apache.nifi.controller.AbstractControllerService; +import org.apache.nifi.controller.ConfigurationContext; +import org.apache.nifi.expression.ExpressionLanguageScope; +import org.apache.nifi.graph.gremlin.SimpleEntry; +import org.apache.nifi.processor.exception.ProcessException; +import org.apache.nifi.processor.util.StandardValidators; +import org.apache.nifi.reporting.InitializationException; +import org.apache.nifi.ssl.SSLContextService; +import org.apache.nifi.util.StringUtils; +import org.apache.tinkerpop.gremlin.driver.Client; +import org.apache.tinkerpop.gremlin.driver.Cluster; +import org.apache.tinkerpop.gremlin.driver.Result; +import org.apache.tinkerpop.gremlin.driver.remote.DriverRemoteConnection; +import org.apache.tinkerpop.gremlin.process.traversal.AnonymousTraversalSource; +import org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.GraphTraversalSource; + +import javax.script.Bindings; +import javax.script.Compilable; +import javax.script.CompiledScript; +import javax.script.ScriptEngine; +import javax.script.ScriptEngineManager; +import javax.script.ScriptException; +import java.io.File; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.Collection; +import java.util.Collections; +import java.util.HashMap; +import java.util.Iterator; +import java.util.List; +import java.util.Map; +import java.util.concurrent.ConcurrentHashMap; +import java.util.stream.Collectors; + + +@Tags({"graph", "gremlin"}) +@CapabilityDescription("This service interacts with a tinkerpop-compliant graph service, providing both script submission and bytecode submission capabilities. " + + "Script submission is the default, with the script command being sent to the gremlin server as text. This should only be used for simple interactions with a tinkerpop-compliant server. " + + "Bytecode submission, when providing a jar with the serialization dependencies, offers much richer way of interacting with the server, and should be used when doing complex manipulations" + + " of the underlying data.") +@RequiresInstanceClassLoading +public class TinkerpopClientService extends AbstractControllerService implements GraphClientService { + public static final String NOT_SUPPORTED = "NOT_SUPPORTED"; + private static final AllowableValue BYTECODE_SUBMISSION = new AllowableValue("bytecode-submission", "ByteCode Submission", + "Scripts directly interact with the server via the NiFi JVM" + ); + + private static final AllowableValue SCRIPT_SUBMISSION = new AllowableValue("script-submission", "Script Submission", + "Script is sent to the gremlin server as a submittion" + ); + + private static final AllowableValue YAML_SETTINGS = new AllowableValue("yaml-settings", "Yaml Settings", + "Connection to the gremlin server will be specified via a yaml file (more flexible)"); + + private static final AllowableValue SERVICE_SETTINGS = new AllowableValue("service-settings", "Service-Defined Settings", + "Connection to the gremlin server will be specified via values on this controller (more simple)"); + + public static final PropertyDescriptor SUBMISSION_TYPE = new PropertyDescriptor.Builder() + .name("submission-type") + .displayName("Script Submission Type") + .description("A selection that allows for either script submission or as bytecode submission") + .allowableValues(SCRIPT_SUBMISSION, BYTECODE_SUBMISSION) + .defaultValue("script-submission") + .required(true) + .build(); + + public static final PropertyDescriptor CONNECTION_SETTINGS = new PropertyDescriptor.Builder() + .name("connection-settings") + .displayName("Settings Specification") + .description("Selecting \"Service-Defined Settings\" connects using the setting on this service. Selecting \"Yaml Settings\" uses the specified yaml file for connection settings. ") + .allowableValues(SERVICE_SETTINGS, YAML_SETTINGS) + .defaultValue("service-settings") + .required(true) + .build(); + + public static final PropertyDescriptor CONTACT_POINTS = new PropertyDescriptor.Builder() + .name("tinkerpop-contact-points") + .displayName("Contact Points") + .description("A comma-separated list of hostnames or IP addresses where an OpenCypher-enabled server can be found.") + .required(true) + .addValidator(StandardValidators.NON_EMPTY_EL_VALIDATOR) + .expressionLanguageSupported(ExpressionLanguageScope.VARIABLE_REGISTRY) + .dependsOn(CONNECTION_SETTINGS, SERVICE_SETTINGS) + .build(); + + public static final PropertyDescriptor PORT = new PropertyDescriptor.Builder() + .name("tinkerpop-port") + .displayName("Port") + .description("The port where Gremlin Server is running on each host listed as a contact point.") + .required(true) + .defaultValue("8182") + .addValidator(StandardValidators.POSITIVE_INTEGER_VALIDATOR) + .expressionLanguageSupported(ExpressionLanguageScope.VARIABLE_REGISTRY) + .dependsOn(CONNECTION_SETTINGS, SERVICE_SETTINGS) + .build(); + + public static final PropertyDescriptor PATH = new PropertyDescriptor.Builder() + .name("tinkerpop-path") + .displayName("Path") + .description("The URL path where Gremlin Server is running on each host listed as a contact point.") + .required(true) + .defaultValue("/gremlin") + .addValidator(StandardValidators.NON_EMPTY_EL_VALIDATOR) + .expressionLanguageSupported(ExpressionLanguageScope.VARIABLE_REGISTRY) + .dependsOn(CONNECTION_SETTINGS, SERVICE_SETTINGS) + .build(); + + public static final PropertyDescriptor TRAVERSAL_SOURCE_NAME = new PropertyDescriptor.Builder() + .name("gremlin-traversal-source-name") + .displayName("Traversal Source Name") + .description("An optional property that lets you set the name of the remote traversal instance. " + + "This can be really important when working with databases like JanusGraph that support " + + "multiple backend traversal configurations simultaneously.") + .expressionLanguageSupported(ExpressionLanguageScope.VARIABLE_REGISTRY) + .addValidator(Validator.VALID) + .build(); + + public static final PropertyDescriptor REMOTE_OBJECTS_FILE = new PropertyDescriptor.Builder() + .name("remote-objects-file") + .displayName("Remote Objects File") + .description("The remote-objects file yaml used for connecting to the gremlin server. Only the yaml file or the string can be specified.") + .required(true) + .addValidator(StandardValidators.FILE_EXISTS_VALIDATOR) + .expressionLanguageSupported(ExpressionLanguageScope.VARIABLE_REGISTRY) + .dependsOn(CONNECTION_SETTINGS, YAML_SETTINGS) + .build(); + + public static final PropertyDescriptor USER_NAME = new PropertyDescriptor.Builder() + .name("user-name") + .displayName("Username") + .description("The username used to authenticate with the gremlin server." + + " Note: when using a remote.yaml file, this username (if set) will overload any username set in the yaml file.") + .required(false) + .expressionLanguageSupported(ExpressionLanguageScope.VARIABLE_REGISTRY) + .build(); + + public static final PropertyDescriptor PASSWORD = new PropertyDescriptor.Builder() + .name("password") + .displayName("Password") + .description("The password used to authenticate with the gremlin server." + + " Note: when using a remote.yaml file, this password (if set) will override any password set in the yaml file") + .required(false) + .expressionLanguageSupported(ExpressionLanguageScope.VARIABLE_REGISTRY) Review Comment: Sensitive properties should not support expression language, instead, they can be supplied through Parameter Contexts if necessary. ```suggestion ``` ########## nifi-nar-bundles/nifi-graph-bundle/nifi-other-graph-services/pom.xml: ########## @@ -110,6 +110,28 @@ <artifactId>gremlin-driver</artifactId> <version>${gremlin.version}</version> </dependency> + + <dependency> + <groupId>org.codehaus.groovy</groupId> + <artifactId>groovy</artifactId> + <version>3.0.17</version> + </dependency> + <dependency> + <groupId>org.codehaus.groovy</groupId> + <artifactId>groovy-jsr223</artifactId> + <version>3.0.17</version> + </dependency> + <dependency> + <groupId>org.codehaus.groovy</groupId> + <artifactId>groovy-dateutil</artifactId> + <version>3.0.17</version> + </dependency> + <dependency> + <groupId>commons-codec</groupId> + <artifactId>commons-codec</artifactId> + <version>1.15</version> Review Comment: This version can be removed since it is specified in the parent Maven configuration. ```suggestion ``` ########## nifi-nar-bundles/nifi-graph-bundle/nifi-other-graph-services/pom.xml: ########## @@ -110,6 +110,28 @@ <artifactId>gremlin-driver</artifactId> <version>${gremlin.version}</version> </dependency> + + <dependency> + <groupId>org.codehaus.groovy</groupId> + <artifactId>groovy</artifactId> + <version>3.0.17</version> + </dependency> + <dependency> + <groupId>org.codehaus.groovy</groupId> + <artifactId>groovy-jsr223</artifactId> + <version>3.0.17</version> + </dependency> + <dependency> + <groupId>org.codehaus.groovy</groupId> + <artifactId>groovy-dateutil</artifactId> + <version>3.0.17</version> Review Comment: These version references should use the project property named `nifi.groovy.version`: ```suggestion <version>${nifi.groovy.version}</version> </dependency> <dependency> <groupId>org.codehaus.groovy</groupId> <artifactId>groovy-jsr223</artifactId> <version>${nifi.groovy.version}</version> </dependency> <dependency> <groupId>org.codehaus.groovy</groupId> <artifactId>groovy-dateutil</artifactId> <version>${nifi.groovy.version}</version> ``` ########## nifi-nar-bundles/nifi-graph-bundle/nifi-other-graph-services/src/main/java/org/apache/nifi/graph/TinkerpopClientService.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.graph; + +import org.apache.commons.codec.digest.DigestUtils; +import org.apache.nifi.annotation.behavior.RequiresInstanceClassLoading; +import org.apache.nifi.annotation.documentation.CapabilityDescription; +import org.apache.nifi.annotation.documentation.Tags; +import org.apache.nifi.annotation.lifecycle.OnDisabled; +import org.apache.nifi.annotation.lifecycle.OnEnabled; +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.components.Validator; +import org.apache.nifi.components.resource.ResourceCardinality; +import org.apache.nifi.components.resource.ResourceType; +import org.apache.nifi.controller.AbstractControllerService; +import org.apache.nifi.controller.ConfigurationContext; +import org.apache.nifi.expression.ExpressionLanguageScope; +import org.apache.nifi.graph.gremlin.SimpleEntry; +import org.apache.nifi.processor.exception.ProcessException; +import org.apache.nifi.processor.util.StandardValidators; +import org.apache.nifi.reporting.InitializationException; +import org.apache.nifi.ssl.SSLContextService; +import org.apache.nifi.util.StringUtils; +import org.apache.tinkerpop.gremlin.driver.Client; +import org.apache.tinkerpop.gremlin.driver.Cluster; +import org.apache.tinkerpop.gremlin.driver.Result; +import org.apache.tinkerpop.gremlin.driver.remote.DriverRemoteConnection; +import org.apache.tinkerpop.gremlin.process.traversal.AnonymousTraversalSource; +import org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.GraphTraversalSource; + +import javax.script.Bindings; +import javax.script.Compilable; +import javax.script.CompiledScript; +import javax.script.ScriptEngine; +import javax.script.ScriptEngineManager; +import javax.script.ScriptException; +import java.io.File; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.Collection; +import java.util.Collections; +import java.util.HashMap; +import java.util.Iterator; +import java.util.List; +import java.util.Map; +import java.util.concurrent.ConcurrentHashMap; +import java.util.stream.Collectors; + + +@Tags({"graph", "gremlin"}) +@CapabilityDescription("This service interacts with a tinkerpop-compliant graph service, providing both script submission and bytecode submission capabilities. " + + "Script submission is the default, with the script command being sent to the gremlin server as text. This should only be used for simple interactions with a tinkerpop-compliant server. " + + "Bytecode submission, when providing a jar with the serialization dependencies, offers much richer way of interacting with the server, and should be used when doing complex manipulations" + + " of the underlying data.") +@RequiresInstanceClassLoading +public class TinkerpopClientService extends AbstractControllerService implements GraphClientService { + public static final String NOT_SUPPORTED = "NOT_SUPPORTED"; + private static final AllowableValue BYTECODE_SUBMISSION = new AllowableValue("bytecode-submission", "ByteCode Submission", + "Scripts directly interact with the server via the NiFi JVM" + ); + + private static final AllowableValue SCRIPT_SUBMISSION = new AllowableValue("script-submission", "Script Submission", + "Script is sent to the gremlin server as a submittion" + ); + + private static final AllowableValue YAML_SETTINGS = new AllowableValue("yaml-settings", "Yaml Settings", + "Connection to the gremlin server will be specified via a yaml file (more flexible)"); + + private static final AllowableValue SERVICE_SETTINGS = new AllowableValue("service-settings", "Service-Defined Settings", + "Connection to the gremlin server will be specified via values on this controller (more simple)"); + + public static final PropertyDescriptor SUBMISSION_TYPE = new PropertyDescriptor.Builder() + .name("submission-type") + .displayName("Script Submission Type") + .description("A selection that allows for either script submission or as bytecode submission") + .allowableValues(SCRIPT_SUBMISSION, BYTECODE_SUBMISSION) + .defaultValue("script-submission") + .required(true) + .build(); + + public static final PropertyDescriptor CONNECTION_SETTINGS = new PropertyDescriptor.Builder() + .name("connection-settings") + .displayName("Settings Specification") + .description("Selecting \"Service-Defined Settings\" connects using the setting on this service. Selecting \"Yaml Settings\" uses the specified yaml file for connection settings. ") + .allowableValues(SERVICE_SETTINGS, YAML_SETTINGS) + .defaultValue("service-settings") + .required(true) + .build(); + + public static final PropertyDescriptor CONTACT_POINTS = new PropertyDescriptor.Builder() + .name("tinkerpop-contact-points") + .displayName("Contact Points") + .description("A comma-separated list of hostnames or IP addresses where an OpenCypher-enabled server can be found.") + .required(true) + .addValidator(StandardValidators.NON_EMPTY_EL_VALIDATOR) + .expressionLanguageSupported(ExpressionLanguageScope.VARIABLE_REGISTRY) + .dependsOn(CONNECTION_SETTINGS, SERVICE_SETTINGS) + .build(); + + public static final PropertyDescriptor PORT = new PropertyDescriptor.Builder() + .name("tinkerpop-port") + .displayName("Port") + .description("The port where Gremlin Server is running on each host listed as a contact point.") + .required(true) + .defaultValue("8182") + .addValidator(StandardValidators.POSITIVE_INTEGER_VALIDATOR) + .expressionLanguageSupported(ExpressionLanguageScope.VARIABLE_REGISTRY) + .dependsOn(CONNECTION_SETTINGS, SERVICE_SETTINGS) + .build(); + + public static final PropertyDescriptor PATH = new PropertyDescriptor.Builder() + .name("tinkerpop-path") + .displayName("Path") + .description("The URL path where Gremlin Server is running on each host listed as a contact point.") + .required(true) + .defaultValue("/gremlin") + .addValidator(StandardValidators.NON_EMPTY_EL_VALIDATOR) + .expressionLanguageSupported(ExpressionLanguageScope.VARIABLE_REGISTRY) + .dependsOn(CONNECTION_SETTINGS, SERVICE_SETTINGS) + .build(); + + public static final PropertyDescriptor TRAVERSAL_SOURCE_NAME = new PropertyDescriptor.Builder() + .name("gremlin-traversal-source-name") + .displayName("Traversal Source Name") + .description("An optional property that lets you set the name of the remote traversal instance. " + + "This can be really important when working with databases like JanusGraph that support " + + "multiple backend traversal configurations simultaneously.") + .expressionLanguageSupported(ExpressionLanguageScope.VARIABLE_REGISTRY) + .addValidator(Validator.VALID) + .build(); + + public static final PropertyDescriptor REMOTE_OBJECTS_FILE = new PropertyDescriptor.Builder() + .name("remote-objects-file") + .displayName("Remote Objects File") + .description("The remote-objects file yaml used for connecting to the gremlin server. Only the yaml file or the string can be specified.") + .required(true) + .addValidator(StandardValidators.FILE_EXISTS_VALIDATOR) + .expressionLanguageSupported(ExpressionLanguageScope.VARIABLE_REGISTRY) + .dependsOn(CONNECTION_SETTINGS, YAML_SETTINGS) + .build(); + + public static final PropertyDescriptor USER_NAME = new PropertyDescriptor.Builder() + .name("user-name") + .displayName("Username") + .description("The username used to authenticate with the gremlin server." + + " Note: when using a remote.yaml file, this username (if set) will overload any username set in the yaml file.") + .required(false) + .expressionLanguageSupported(ExpressionLanguageScope.VARIABLE_REGISTRY) + .build(); + + public static final PropertyDescriptor PASSWORD = new PropertyDescriptor.Builder() + .name("password") + .displayName("Password") + .description("The password used to authenticate with the gremlin server." + + " Note: when using a remote.yaml file, this password (if set) will override any password set in the yaml file") + .required(false) + .expressionLanguageSupported(ExpressionLanguageScope.VARIABLE_REGISTRY) + .sensitive(true) + .build(); + + public static final PropertyDescriptor EXTRA_RESOURCE = new PropertyDescriptor.Builder() + .name("extension") + .displayName("Extension JARs") + .description("A comma-separated list of Java JAR files to be loaded. This has no practical effect unless combined " + + "with the Extension Classes property which provides a list of particular classes to use as extensions for the " + + "parsing engine.") + .dependsOn(CONNECTION_SETTINGS, YAML_SETTINGS) + .defaultValue(null) + .identifiesExternalResource(ResourceCardinality.MULTIPLE, ResourceType.FILE, ResourceType.DIRECTORY, ResourceType.URL) + .expressionLanguageSupported(ExpressionLanguageScope.VARIABLE_REGISTRY) + .dynamicallyModifiesClasspath(true) + .build(); + + public static final PropertyDescriptor EXTENSION_CLASSES = new PropertyDescriptor.Builder() + .name("extension-classes") + .displayName("Extension Classes") + .addValidator(Validator.VALID) + .description("A comma-separated list of fully qualified Java class names that correspond to classes to implement. This " + + "is useful for services such as JanusGraph that need specific serialization classes. " + + "This configuration property has no effect unless a value for the Extension JAR field is " + + "also provided.") + .dependsOn(EXTRA_RESOURCE) + .expressionLanguageSupported(ExpressionLanguageScope.VARIABLE_REGISTRY) + .dependsOn(CONNECTION_SETTINGS, YAML_SETTINGS) + .required(false) + .build(); + + public static final PropertyDescriptor SSL_CONTEXT_SERVICE = new PropertyDescriptor.Builder() + .name("tinkerpop-ssl-context-service") + .displayName("SSL Context Service") + .description("The SSL Context Service used to provide client certificate information for TLS/SSL " + + "connections.") + .required(false) + .identifiesControllerService(SSLContextService.class) + .build(); + + public static final List<PropertyDescriptor> DESCRIPTORS = Collections.unmodifiableList(Arrays.asList( + SUBMISSION_TYPE, + CONNECTION_SETTINGS, + REMOTE_OBJECTS_FILE, + EXTRA_RESOURCE, + EXTENSION_CLASSES, + CONTACT_POINTS, + PORT, + PATH, + TRAVERSAL_SOURCE_NAME, + USER_NAME, + PASSWORD, + SSL_CONTEXT_SERVICE + )); + + private ScriptEngineManager MANAGER = new ScriptEngineManager(); + private ScriptEngine engine; + private Map<String, CompiledScript> compiledCode; + protected Cluster cluster; + private String traversalSourceName; + private GraphTraversalSource traversalSource; + private boolean scriptSubmission = true; + boolean usesSSL; + protected String transitUrl; + + @OnEnabled + public void onEnabled(final ConfigurationContext context) throws InitializationException { + loadClasses(context); + compiledCode = new ConcurrentHashMap<>(); + engine = MANAGER.getEngineByName("groovy"); + + if (context.getProperty(TRAVERSAL_SOURCE_NAME).isSet()) { + traversalSourceName = context.getProperty(TRAVERSAL_SOURCE_NAME).evaluateAttributeExpressions() + .getValue(); + } + + scriptSubmission = context.getProperty(SUBMISSION_TYPE).getValue().equals(SCRIPT_SUBMISSION.getValue()); + + cluster = buildCluster(context); + } + + @OnDisabled + public void shutdown() { + try { + compiledCode = null; + engine = null; + if (traversalSource != null) { + traversalSource.close(); + } + } catch (Exception e) { + throw new ProcessException(e); + } finally { + if (cluster != null) { + cluster.close(); + } + cluster = null; + traversalSource = null; + } + } + + @Override + public Map<String, String> executeQuery(String s, Map<String, Object> map, GraphQueryResultCallback graphQueryResultCallback) { + try { + if (scriptSubmission) { + return scriptSubmission(s, map, graphQueryResultCallback); + } else { + return bytecodeSubmission(s, map, graphQueryResultCallback); + } + } catch (Exception ex) { + throw new ProcessException(ex); + } + } + + @Override + public String getTransitUrl() { + return this.transitUrl; + } + + @Override + public List<PropertyDescriptor> getSupportedPropertyDescriptors() { + return DESCRIPTORS; + } + + @Override + public Collection<ValidationResult> customValidate(ValidationContext context) { + Collection<ValidationResult> results = new ArrayList<>(); + boolean jarsIsSet = !StringUtils.isEmpty(context.getProperty(EXTRA_RESOURCE).getValue()); + boolean clzIsSet = !StringUtils.isEmpty(context.getProperty(EXTENSION_CLASSES).getValue()); + + if (jarsIsSet && clzIsSet) { + try { + final ClassLoader loader = this.getClass().getClassLoader(); + String[] classes = context.getProperty(EXTENSION_CLASSES).evaluateAttributeExpressions().getValue().split(",[\\s]*"); + for (String clz : classes) { + Class.forName(clz, true, loader); + } + } catch (Exception ex) { + results.add(new ValidationResult.Builder().subject(EXTENSION_CLASSES.getDisplayName()).valid(false).explanation(ex.toString()).build()); + } + } + + boolean standardConfigIsSet = context.getProperty(CONTACT_POINTS).isSet() + && context.getProperty(PATH).isSet() + && context.getProperty(PORT).isSet(); + boolean fileIsSet = context.getProperty(REMOTE_OBJECTS_FILE).isSet(); + + if (standardConfigIsSet && fileIsSet) { + results.add(new ValidationResult.Builder() + .explanation("Cannot set the configuration file and connection details properties at the same time.") + .valid(false) + .build()); + } + if (!standardConfigIsSet && !fileIsSet) { + results.add(new ValidationResult.Builder() + .explanation("Connection details properties or the configuration file must be set.").valid(false).build()); + } + + if (context.getProperty(USER_NAME).isSet() && !context.getProperty(PASSWORD).isSet()) { + results.add(new ValidationResult.Builder() + .explanation("When specifying a username, the password must also be set").valid(false).build() + ); + } + if (context.getProperty(PASSWORD).isSet() && !context.getProperty(USER_NAME).isSet()) { + results.add(new ValidationResult.Builder() + .explanation("When specifying a password, the password must also be set").valid(false).build() + ); + } + return results; + } + + protected Cluster.Builder setupSSL(ConfigurationContext context, Cluster.Builder builder) { + if (context.getProperty(SSL_CONTEXT_SERVICE).isSet()) { + SSLContextService service = context.getProperty(SSL_CONTEXT_SERVICE).asControllerService(SSLContextService.class); + builder + .enableSsl(true) + .keyStore(service.getKeyStoreFile()) + .keyStorePassword(service.getKeyStorePassword()) + .keyStoreType(service.getKeyStoreType()) + .trustStore(service.getTrustStoreFile()) + .trustStorePassword(service.getTrustStorePassword()); Review Comment: Instead of passing individual properties, the Builder supports an `sslContext()` method that accepts a Netty SslContext. The Netty JdkSslContext wraps the Java SSLContext returned from the `SSLContextService.createContext()` method. ########## nifi-nar-bundles/nifi-graph-bundle/nifi-other-graph-services/src/main/java/org/apache/nifi/graph/TinkerpopClientService.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.graph; + +import org.apache.commons.codec.digest.DigestUtils; +import org.apache.nifi.annotation.behavior.RequiresInstanceClassLoading; +import org.apache.nifi.annotation.documentation.CapabilityDescription; +import org.apache.nifi.annotation.documentation.Tags; +import org.apache.nifi.annotation.lifecycle.OnDisabled; +import org.apache.nifi.annotation.lifecycle.OnEnabled; +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.components.Validator; +import org.apache.nifi.components.resource.ResourceCardinality; +import org.apache.nifi.components.resource.ResourceType; +import org.apache.nifi.controller.AbstractControllerService; +import org.apache.nifi.controller.ConfigurationContext; +import org.apache.nifi.expression.ExpressionLanguageScope; +import org.apache.nifi.graph.gremlin.SimpleEntry; +import org.apache.nifi.processor.exception.ProcessException; +import org.apache.nifi.processor.util.StandardValidators; +import org.apache.nifi.reporting.InitializationException; +import org.apache.nifi.ssl.SSLContextService; +import org.apache.nifi.util.StringUtils; +import org.apache.tinkerpop.gremlin.driver.Client; +import org.apache.tinkerpop.gremlin.driver.Cluster; +import org.apache.tinkerpop.gremlin.driver.Result; +import org.apache.tinkerpop.gremlin.driver.remote.DriverRemoteConnection; +import org.apache.tinkerpop.gremlin.process.traversal.AnonymousTraversalSource; +import org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.GraphTraversalSource; + +import javax.script.Bindings; +import javax.script.Compilable; +import javax.script.CompiledScript; +import javax.script.ScriptEngine; +import javax.script.ScriptEngineManager; +import javax.script.ScriptException; +import java.io.File; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.Collection; +import java.util.Collections; +import java.util.HashMap; +import java.util.Iterator; +import java.util.List; +import java.util.Map; +import java.util.concurrent.ConcurrentHashMap; +import java.util.stream.Collectors; + + +@Tags({"graph", "gremlin"}) +@CapabilityDescription("This service interacts with a tinkerpop-compliant graph service, providing both script submission and bytecode submission capabilities. " + + "Script submission is the default, with the script command being sent to the gremlin server as text. This should only be used for simple interactions with a tinkerpop-compliant server. " + + "Bytecode submission, when providing a jar with the serialization dependencies, offers much richer way of interacting with the server, and should be used when doing complex manipulations" + + " of the underlying data.") +@RequiresInstanceClassLoading +public class TinkerpopClientService extends AbstractControllerService implements GraphClientService { + public static final String NOT_SUPPORTED = "NOT_SUPPORTED"; + private static final AllowableValue BYTECODE_SUBMISSION = new AllowableValue("bytecode-submission", "ByteCode Submission", + "Scripts directly interact with the server via the NiFi JVM" + ); + + private static final AllowableValue SCRIPT_SUBMISSION = new AllowableValue("script-submission", "Script Submission", + "Script is sent to the gremlin server as a submittion" + ); + + private static final AllowableValue YAML_SETTINGS = new AllowableValue("yaml-settings", "Yaml Settings", + "Connection to the gremlin server will be specified via a yaml file (more flexible)"); + + private static final AllowableValue SERVICE_SETTINGS = new AllowableValue("service-settings", "Service-Defined Settings", + "Connection to the gremlin server will be specified via values on this controller (more simple)"); + + public static final PropertyDescriptor SUBMISSION_TYPE = new PropertyDescriptor.Builder() + .name("submission-type") + .displayName("Script Submission Type") + .description("A selection that allows for either script submission or as bytecode submission") + .allowableValues(SCRIPT_SUBMISSION, BYTECODE_SUBMISSION) + .defaultValue("script-submission") + .required(true) + .build(); + + public static final PropertyDescriptor CONNECTION_SETTINGS = new PropertyDescriptor.Builder() + .name("connection-settings") + .displayName("Settings Specification") + .description("Selecting \"Service-Defined Settings\" connects using the setting on this service. Selecting \"Yaml Settings\" uses the specified yaml file for connection settings. ") + .allowableValues(SERVICE_SETTINGS, YAML_SETTINGS) + .defaultValue("service-settings") + .required(true) + .build(); + + public static final PropertyDescriptor CONTACT_POINTS = new PropertyDescriptor.Builder() + .name("tinkerpop-contact-points") + .displayName("Contact Points") + .description("A comma-separated list of hostnames or IP addresses where an OpenCypher-enabled server can be found.") + .required(true) + .addValidator(StandardValidators.NON_EMPTY_EL_VALIDATOR) + .expressionLanguageSupported(ExpressionLanguageScope.VARIABLE_REGISTRY) + .dependsOn(CONNECTION_SETTINGS, SERVICE_SETTINGS) + .build(); + + public static final PropertyDescriptor PORT = new PropertyDescriptor.Builder() + .name("tinkerpop-port") + .displayName("Port") + .description("The port where Gremlin Server is running on each host listed as a contact point.") + .required(true) + .defaultValue("8182") + .addValidator(StandardValidators.POSITIVE_INTEGER_VALIDATOR) + .expressionLanguageSupported(ExpressionLanguageScope.VARIABLE_REGISTRY) + .dependsOn(CONNECTION_SETTINGS, SERVICE_SETTINGS) + .build(); + + public static final PropertyDescriptor PATH = new PropertyDescriptor.Builder() + .name("tinkerpop-path") + .displayName("Path") + .description("The URL path where Gremlin Server is running on each host listed as a contact point.") + .required(true) + .defaultValue("/gremlin") + .addValidator(StandardValidators.NON_EMPTY_EL_VALIDATOR) + .expressionLanguageSupported(ExpressionLanguageScope.VARIABLE_REGISTRY) + .dependsOn(CONNECTION_SETTINGS, SERVICE_SETTINGS) + .build(); + + public static final PropertyDescriptor TRAVERSAL_SOURCE_NAME = new PropertyDescriptor.Builder() + .name("gremlin-traversal-source-name") + .displayName("Traversal Source Name") + .description("An optional property that lets you set the name of the remote traversal instance. " + + "This can be really important when working with databases like JanusGraph that support " + + "multiple backend traversal configurations simultaneously.") + .expressionLanguageSupported(ExpressionLanguageScope.VARIABLE_REGISTRY) + .addValidator(Validator.VALID) + .build(); + + public static final PropertyDescriptor REMOTE_OBJECTS_FILE = new PropertyDescriptor.Builder() + .name("remote-objects-file") + .displayName("Remote Objects File") + .description("The remote-objects file yaml used for connecting to the gremlin server. Only the yaml file or the string can be specified.") + .required(true) + .addValidator(StandardValidators.FILE_EXISTS_VALIDATOR) + .expressionLanguageSupported(ExpressionLanguageScope.VARIABLE_REGISTRY) + .dependsOn(CONNECTION_SETTINGS, YAML_SETTINGS) + .build(); + + public static final PropertyDescriptor USER_NAME = new PropertyDescriptor.Builder() + .name("user-name") + .displayName("Username") + .description("The username used to authenticate with the gremlin server." + + " Note: when using a remote.yaml file, this username (if set) will overload any username set in the yaml file.") + .required(false) + .expressionLanguageSupported(ExpressionLanguageScope.VARIABLE_REGISTRY) + .build(); + + public static final PropertyDescriptor PASSWORD = new PropertyDescriptor.Builder() + .name("password") + .displayName("Password") + .description("The password used to authenticate with the gremlin server." + + " Note: when using a remote.yaml file, this password (if set) will override any password set in the yaml file") + .required(false) + .expressionLanguageSupported(ExpressionLanguageScope.VARIABLE_REGISTRY) + .sensitive(true) + .build(); + + public static final PropertyDescriptor EXTRA_RESOURCE = new PropertyDescriptor.Builder() + .name("extension") + .displayName("Extension JARs") + .description("A comma-separated list of Java JAR files to be loaded. This has no practical effect unless combined " + + "with the Extension Classes property which provides a list of particular classes to use as extensions for the " + + "parsing engine.") + .dependsOn(CONNECTION_SETTINGS, YAML_SETTINGS) + .defaultValue(null) + .identifiesExternalResource(ResourceCardinality.MULTIPLE, ResourceType.FILE, ResourceType.DIRECTORY, ResourceType.URL) + .expressionLanguageSupported(ExpressionLanguageScope.VARIABLE_REGISTRY) + .dynamicallyModifiesClasspath(true) + .build(); + + public static final PropertyDescriptor EXTENSION_CLASSES = new PropertyDescriptor.Builder() + .name("extension-classes") + .displayName("Extension Classes") + .addValidator(Validator.VALID) + .description("A comma-separated list of fully qualified Java class names that correspond to classes to implement. This " + + "is useful for services such as JanusGraph that need specific serialization classes. " + + "This configuration property has no effect unless a value for the Extension JAR field is " + + "also provided.") + .dependsOn(EXTRA_RESOURCE) + .expressionLanguageSupported(ExpressionLanguageScope.VARIABLE_REGISTRY) + .dependsOn(CONNECTION_SETTINGS, YAML_SETTINGS) + .required(false) + .build(); + + public static final PropertyDescriptor SSL_CONTEXT_SERVICE = new PropertyDescriptor.Builder() + .name("tinkerpop-ssl-context-service") Review Comment: Recommend removing the prefix for the property name. ```suggestion .name("ssl-context-service") ``` ########## nifi-nar-bundles/nifi-graph-bundle/nifi-other-graph-services/src/main/java/org/apache/nifi/graph/TinkerpopClientService.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.graph; + +import org.apache.commons.codec.digest.DigestUtils; +import org.apache.nifi.annotation.behavior.RequiresInstanceClassLoading; +import org.apache.nifi.annotation.documentation.CapabilityDescription; +import org.apache.nifi.annotation.documentation.Tags; +import org.apache.nifi.annotation.lifecycle.OnDisabled; +import org.apache.nifi.annotation.lifecycle.OnEnabled; +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.components.Validator; +import org.apache.nifi.components.resource.ResourceCardinality; +import org.apache.nifi.components.resource.ResourceType; +import org.apache.nifi.controller.AbstractControllerService; +import org.apache.nifi.controller.ConfigurationContext; +import org.apache.nifi.expression.ExpressionLanguageScope; +import org.apache.nifi.graph.gremlin.SimpleEntry; +import org.apache.nifi.processor.exception.ProcessException; +import org.apache.nifi.processor.util.StandardValidators; +import org.apache.nifi.reporting.InitializationException; +import org.apache.nifi.ssl.SSLContextService; +import org.apache.nifi.util.StringUtils; +import org.apache.tinkerpop.gremlin.driver.Client; +import org.apache.tinkerpop.gremlin.driver.Cluster; +import org.apache.tinkerpop.gremlin.driver.Result; +import org.apache.tinkerpop.gremlin.driver.remote.DriverRemoteConnection; +import org.apache.tinkerpop.gremlin.process.traversal.AnonymousTraversalSource; +import org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.GraphTraversalSource; + +import javax.script.Bindings; +import javax.script.Compilable; +import javax.script.CompiledScript; +import javax.script.ScriptEngine; +import javax.script.ScriptEngineManager; +import javax.script.ScriptException; +import java.io.File; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.Collection; +import java.util.Collections; +import java.util.HashMap; +import java.util.Iterator; +import java.util.List; +import java.util.Map; +import java.util.concurrent.ConcurrentHashMap; +import java.util.stream.Collectors; + + +@Tags({"graph", "gremlin"}) +@CapabilityDescription("This service interacts with a tinkerpop-compliant graph service, providing both script submission and bytecode submission capabilities. " + + "Script submission is the default, with the script command being sent to the gremlin server as text. This should only be used for simple interactions with a tinkerpop-compliant server. " + + "Bytecode submission, when providing a jar with the serialization dependencies, offers much richer way of interacting with the server, and should be used when doing complex manipulations" + + " of the underlying data.") +@RequiresInstanceClassLoading +public class TinkerpopClientService extends AbstractControllerService implements GraphClientService { + public static final String NOT_SUPPORTED = "NOT_SUPPORTED"; + private static final AllowableValue BYTECODE_SUBMISSION = new AllowableValue("bytecode-submission", "ByteCode Submission", + "Scripts directly interact with the server via the NiFi JVM" + ); + + private static final AllowableValue SCRIPT_SUBMISSION = new AllowableValue("script-submission", "Script Submission", + "Script is sent to the gremlin server as a submittion" + ); + + private static final AllowableValue YAML_SETTINGS = new AllowableValue("yaml-settings", "Yaml Settings", + "Connection to the gremlin server will be specified via a yaml file (more flexible)"); + + private static final AllowableValue SERVICE_SETTINGS = new AllowableValue("service-settings", "Service-Defined Settings", + "Connection to the gremlin server will be specified via values on this controller (more simple)"); + + public static final PropertyDescriptor SUBMISSION_TYPE = new PropertyDescriptor.Builder() + .name("submission-type") + .displayName("Script Submission Type") + .description("A selection that allows for either script submission or as bytecode submission") + .allowableValues(SCRIPT_SUBMISSION, BYTECODE_SUBMISSION) + .defaultValue("script-submission") + .required(true) + .build(); + + public static final PropertyDescriptor CONNECTION_SETTINGS = new PropertyDescriptor.Builder() + .name("connection-settings") + .displayName("Settings Specification") + .description("Selecting \"Service-Defined Settings\" connects using the setting on this service. Selecting \"Yaml Settings\" uses the specified yaml file for connection settings. ") + .allowableValues(SERVICE_SETTINGS, YAML_SETTINGS) + .defaultValue("service-settings") + .required(true) + .build(); + + public static final PropertyDescriptor CONTACT_POINTS = new PropertyDescriptor.Builder() + .name("tinkerpop-contact-points") + .displayName("Contact Points") + .description("A comma-separated list of hostnames or IP addresses where an OpenCypher-enabled server can be found.") + .required(true) + .addValidator(StandardValidators.NON_EMPTY_EL_VALIDATOR) + .expressionLanguageSupported(ExpressionLanguageScope.VARIABLE_REGISTRY) + .dependsOn(CONNECTION_SETTINGS, SERVICE_SETTINGS) + .build(); + + public static final PropertyDescriptor PORT = new PropertyDescriptor.Builder() + .name("tinkerpop-port") + .displayName("Port") + .description("The port where Gremlin Server is running on each host listed as a contact point.") + .required(true) + .defaultValue("8182") + .addValidator(StandardValidators.POSITIVE_INTEGER_VALIDATOR) + .expressionLanguageSupported(ExpressionLanguageScope.VARIABLE_REGISTRY) + .dependsOn(CONNECTION_SETTINGS, SERVICE_SETTINGS) + .build(); + + public static final PropertyDescriptor PATH = new PropertyDescriptor.Builder() + .name("tinkerpop-path") + .displayName("Path") + .description("The URL path where Gremlin Server is running on each host listed as a contact point.") + .required(true) + .defaultValue("/gremlin") + .addValidator(StandardValidators.NON_EMPTY_EL_VALIDATOR) + .expressionLanguageSupported(ExpressionLanguageScope.VARIABLE_REGISTRY) + .dependsOn(CONNECTION_SETTINGS, SERVICE_SETTINGS) + .build(); + + public static final PropertyDescriptor TRAVERSAL_SOURCE_NAME = new PropertyDescriptor.Builder() + .name("gremlin-traversal-source-name") + .displayName("Traversal Source Name") + .description("An optional property that lets you set the name of the remote traversal instance. " + + "This can be really important when working with databases like JanusGraph that support " + + "multiple backend traversal configurations simultaneously.") + .expressionLanguageSupported(ExpressionLanguageScope.VARIABLE_REGISTRY) + .addValidator(Validator.VALID) + .build(); + + public static final PropertyDescriptor REMOTE_OBJECTS_FILE = new PropertyDescriptor.Builder() + .name("remote-objects-file") + .displayName("Remote Objects File") + .description("The remote-objects file yaml used for connecting to the gremlin server. Only the yaml file or the string can be specified.") + .required(true) + .addValidator(StandardValidators.FILE_EXISTS_VALIDATOR) + .expressionLanguageSupported(ExpressionLanguageScope.VARIABLE_REGISTRY) + .dependsOn(CONNECTION_SETTINGS, YAML_SETTINGS) + .build(); + + public static final PropertyDescriptor USER_NAME = new PropertyDescriptor.Builder() + .name("user-name") + .displayName("Username") + .description("The username used to authenticate with the gremlin server." + + " Note: when using a remote.yaml file, this username (if set) will overload any username set in the yaml file.") + .required(false) + .expressionLanguageSupported(ExpressionLanguageScope.VARIABLE_REGISTRY) + .build(); + + public static final PropertyDescriptor PASSWORD = new PropertyDescriptor.Builder() + .name("password") + .displayName("Password") + .description("The password used to authenticate with the gremlin server." + + " Note: when using a remote.yaml file, this password (if set) will override any password set in the yaml file") + .required(false) + .expressionLanguageSupported(ExpressionLanguageScope.VARIABLE_REGISTRY) + .sensitive(true) + .build(); + + public static final PropertyDescriptor EXTRA_RESOURCE = new PropertyDescriptor.Builder() + .name("extension") + .displayName("Extension JARs") + .description("A comma-separated list of Java JAR files to be loaded. This has no practical effect unless combined " + + "with the Extension Classes property which provides a list of particular classes to use as extensions for the " + + "parsing engine.") + .dependsOn(CONNECTION_SETTINGS, YAML_SETTINGS) + .defaultValue(null) + .identifiesExternalResource(ResourceCardinality.MULTIPLE, ResourceType.FILE, ResourceType.DIRECTORY, ResourceType.URL) + .expressionLanguageSupported(ExpressionLanguageScope.VARIABLE_REGISTRY) + .dynamicallyModifiesClasspath(true) + .build(); + + public static final PropertyDescriptor EXTENSION_CLASSES = new PropertyDescriptor.Builder() + .name("extension-classes") + .displayName("Extension Classes") + .addValidator(Validator.VALID) + .description("A comma-separated list of fully qualified Java class names that correspond to classes to implement. This " + + "is useful for services such as JanusGraph that need specific serialization classes. " + + "This configuration property has no effect unless a value for the Extension JAR field is " + + "also provided.") + .dependsOn(EXTRA_RESOURCE) + .expressionLanguageSupported(ExpressionLanguageScope.VARIABLE_REGISTRY) + .dependsOn(CONNECTION_SETTINGS, YAML_SETTINGS) + .required(false) + .build(); + + public static final PropertyDescriptor SSL_CONTEXT_SERVICE = new PropertyDescriptor.Builder() + .name("tinkerpop-ssl-context-service") + .displayName("SSL Context Service") + .description("The SSL Context Service used to provide client certificate information for TLS/SSL " + + "connections.") + .required(false) + .identifiesControllerService(SSLContextService.class) + .build(); + + public static final List<PropertyDescriptor> DESCRIPTORS = Collections.unmodifiableList(Arrays.asList( + SUBMISSION_TYPE, + CONNECTION_SETTINGS, + REMOTE_OBJECTS_FILE, + EXTRA_RESOURCE, + EXTENSION_CLASSES, + CONTACT_POINTS, + PORT, + PATH, + TRAVERSAL_SOURCE_NAME, + USER_NAME, + PASSWORD, + SSL_CONTEXT_SERVICE + )); + + private ScriptEngineManager MANAGER = new ScriptEngineManager(); + private ScriptEngine engine; + private Map<String, CompiledScript> compiledCode; + protected Cluster cluster; + private String traversalSourceName; + private GraphTraversalSource traversalSource; + private boolean scriptSubmission = true; + boolean usesSSL; + protected String transitUrl; + + @OnEnabled + public void onEnabled(final ConfigurationContext context) throws InitializationException { + loadClasses(context); + compiledCode = new ConcurrentHashMap<>(); + engine = MANAGER.getEngineByName("groovy"); + + if (context.getProperty(TRAVERSAL_SOURCE_NAME).isSet()) { + traversalSourceName = context.getProperty(TRAVERSAL_SOURCE_NAME).evaluateAttributeExpressions() + .getValue(); + } + + scriptSubmission = context.getProperty(SUBMISSION_TYPE).getValue().equals(SCRIPT_SUBMISSION.getValue()); + + cluster = buildCluster(context); + } + + @OnDisabled + public void shutdown() { + try { + compiledCode = null; + engine = null; + if (traversalSource != null) { + traversalSource.close(); + } + } catch (Exception e) { + throw new ProcessException(e); + } finally { + if (cluster != null) { + cluster.close(); + } + cluster = null; + traversalSource = null; + } + } + + @Override + public Map<String, String> executeQuery(String s, Map<String, Object> map, GraphQueryResultCallback graphQueryResultCallback) { + try { + if (scriptSubmission) { + return scriptSubmission(s, map, graphQueryResultCallback); + } else { + return bytecodeSubmission(s, map, graphQueryResultCallback); + } + } catch (Exception ex) { + throw new ProcessException(ex); + } + } + + @Override + public String getTransitUrl() { + return this.transitUrl; + } + + @Override + public List<PropertyDescriptor> getSupportedPropertyDescriptors() { + return DESCRIPTORS; + } + + @Override + public Collection<ValidationResult> customValidate(ValidationContext context) { + Collection<ValidationResult> results = new ArrayList<>(); + boolean jarsIsSet = !StringUtils.isEmpty(context.getProperty(EXTRA_RESOURCE).getValue()); + boolean clzIsSet = !StringUtils.isEmpty(context.getProperty(EXTENSION_CLASSES).getValue()); + + if (jarsIsSet && clzIsSet) { + try { + final ClassLoader loader = this.getClass().getClassLoader(); + String[] classes = context.getProperty(EXTENSION_CLASSES).evaluateAttributeExpressions().getValue().split(",[\\s]*"); + for (String clz : classes) { + Class.forName(clz, true, loader); + } + } catch (Exception ex) { + results.add(new ValidationResult.Builder().subject(EXTENSION_CLASSES.getDisplayName()).valid(false).explanation(ex.toString()).build()); + } + } + + boolean standardConfigIsSet = context.getProperty(CONTACT_POINTS).isSet() + && context.getProperty(PATH).isSet() + && context.getProperty(PORT).isSet(); + boolean fileIsSet = context.getProperty(REMOTE_OBJECTS_FILE).isSet(); + + if (standardConfigIsSet && fileIsSet) { + results.add(new ValidationResult.Builder() + .explanation("Cannot set the configuration file and connection details properties at the same time.") + .valid(false) + .build()); + } + if (!standardConfigIsSet && !fileIsSet) { + results.add(new ValidationResult.Builder() + .explanation("Connection details properties or the configuration file must be set.").valid(false).build()); + } + + if (context.getProperty(USER_NAME).isSet() && !context.getProperty(PASSWORD).isSet()) { + results.add(new ValidationResult.Builder() + .explanation("When specifying a username, the password must also be set").valid(false).build() + ); + } + if (context.getProperty(PASSWORD).isSet() && !context.getProperty(USER_NAME).isSet()) { + results.add(new ValidationResult.Builder() + .explanation("When specifying a password, the password must also be set").valid(false).build() + ); + } + return results; + } + + protected Cluster.Builder setupSSL(ConfigurationContext context, Cluster.Builder builder) { + if (context.getProperty(SSL_CONTEXT_SERVICE).isSet()) { + SSLContextService service = context.getProperty(SSL_CONTEXT_SERVICE).asControllerService(SSLContextService.class); + builder + .enableSsl(true) + .keyStore(service.getKeyStoreFile()) + .keyStorePassword(service.getKeyStorePassword()) + .keyStoreType(service.getKeyStoreType()) + .trustStore(service.getTrustStoreFile()) + .trustStorePassword(service.getTrustStorePassword()); + usesSSL = true; + } + + return builder; + } + + + public void loadClasses(ConfigurationContext context) { + String path = context.getProperty(EXTRA_RESOURCE).getValue(); + String classList = context.getProperty(EXTENSION_CLASSES).getValue(); + if (path != null && classList != null && !path.isEmpty() && !classList.isEmpty()) { + try { + ClassLoader loader = Thread.currentThread().getContextClassLoader(); + String[] classes = context.getProperty(EXTENSION_CLASSES).evaluateAttributeExpressions().getValue().split(",[\\s]*"); + for (String cls : classes) { + Class<?> clz = Class.forName(cls.trim(), true, loader); + if (getLogger().isDebugEnabled()) { + getLogger().debug(clz.getName()); + } + } + } catch (Exception e) { + throw new ProcessException(e); + } + } + } + + + protected Cluster buildCluster(ConfigurationContext context) { + + Cluster.Builder builder = Cluster.build(); + if (!context.getProperty(REMOTE_OBJECTS_FILE).isSet()) { + String contactProp = context.getProperty(CONTACT_POINTS).evaluateAttributeExpressions().getValue(); + int port = context.getProperty(PORT).evaluateAttributeExpressions().asInteger(); + String path = context.getProperty(PATH).evaluateAttributeExpressions().getValue(); + String[] contactPoints = contactProp.split(",[\\s]*"); + for (String contactPoint : contactPoints) { + builder.addContactPoint(contactPoint.trim()); + } + builder.port(port).path(path); + } else { + File yamlFile = new File(context.getProperty(REMOTE_OBJECTS_FILE).evaluateAttributeExpressions().getValue()); + try { + builder = Cluster.build(yamlFile); + } catch (Exception ex) { + throw new ProcessException(ex); + } + } + builder = setupSSL(context, builder); + + if (context.getProperty(USER_NAME).isSet() && context.getProperty(PASSWORD).isSet()) { + String username = context.getProperty(USER_NAME).evaluateAttributeExpressions().getValue(); + String password = context.getProperty(PASSWORD).evaluateAttributeExpressions().getValue(); + builder.credentials(username, password); + } + + return builder.create(); + } + + protected Map<String, String> scriptSubmission(String query, Map<String, Object> parameters, GraphQueryResultCallback handler) { + try { + Client client = cluster.connect(); + Iterator<Result> iterator = client.submit(query, parameters).iterator(); + long count = 0; + while (iterator.hasNext()) { + Result result = iterator.next(); + Object obj = result.getObject(); + if (obj instanceof Map) { + handler.process((Map)obj, iterator.hasNext()); + } else { + handler.process(new HashMap<>() {{ + put("result", obj); + }}, iterator.hasNext()); + } + count++; + } + + Map<String, String> resultAttributes = new HashMap<>(); + resultAttributes.put(NODES_CREATED, NOT_SUPPORTED); + resultAttributes.put(RELATIONS_CREATED, NOT_SUPPORTED); + resultAttributes.put(LABELS_ADDED, NOT_SUPPORTED); + resultAttributes.put(NODES_DELETED, NOT_SUPPORTED); + resultAttributes.put(RELATIONS_DELETED, NOT_SUPPORTED); + resultAttributes.put(PROPERTIES_SET, NOT_SUPPORTED); + resultAttributes.put(ROWS_RETURNED, String.valueOf(count)); + + return resultAttributes; + + } catch (Exception ex) { + throw new ProcessException(ex); + } + } + + protected Map<String, String> bytecodeSubmission(String s, Map<String, Object> map, GraphQueryResultCallback graphQueryResultCallback) { + String hash = DigestUtils.md5Hex(s); Review Comment: MD5 is not a secure hashing function. Although this is not a cryptographic function, recommend using SHA-256. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: issues-unsubscr...@nifi.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
