exceptionfactory commented on code in PR #6192: URL: https://github.com/apache/nifi/pull/6192#discussion_r922296919
########## nifi-nar-bundles/nifi-smb-bundle/nifi-smb-connection-pool/src/main/java/org/apache/nifi/services/smb/SmbjSessionProviderService.java: ########## @@ -0,0 +1,175 @@ +/* + * 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.services.smb; + +import static java.util.Arrays.asList; +import static java.util.concurrent.TimeUnit.SECONDS; +import static org.apache.nifi.expression.ExpressionLanguageScope.FLOWFILE_ATTRIBUTES; +import static org.apache.nifi.processor.util.StandardValidators.INTEGER_VALIDATOR; +import static org.apache.nifi.processor.util.StandardValidators.NON_BLANK_VALIDATOR; +import static org.apache.nifi.processor.util.StandardValidators.NON_EMPTY_VALIDATOR; +import static org.apache.nifi.processor.util.StandardValidators.PORT_VALIDATOR; + +import com.hierynomus.smbj.SMBClient; +import com.hierynomus.smbj.SmbConfig; +import com.hierynomus.smbj.auth.AuthenticationContext; +import com.hierynomus.smbj.session.Session; +import com.hierynomus.smbj.transport.tcp.async.AsyncDirectTcpTransportFactory; +import java.io.IOException; +import java.io.UncheckedIOException; +import java.net.URI; +import java.util.Collection; +import java.util.Collections; +import java.util.List; +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.PropertyDescriptor; +import org.apache.nifi.components.ValidationContext; +import org.apache.nifi.components.ValidationResult; +import org.apache.nifi.controller.AbstractControllerService; +import org.apache.nifi.controller.ConfigurationContext; + +@Tags({"microsoft", "samba"}) +@CapabilityDescription("Provides connection pool for ListSmb processor. ") +public class SmbjSessionProviderService extends AbstractControllerService implements SmbSessionProviderService { + + public static final PropertyDescriptor HOSTNAME = new PropertyDescriptor.Builder() + .displayName("Hostname") + .name("hostname") + .description("The network host of the SMB file server.") + .required(false) + .expressionLanguageSupported(FLOWFILE_ATTRIBUTES) + .addValidator(NON_BLANK_VALIDATOR) + .build(); + public static final PropertyDescriptor DOMAIN = new PropertyDescriptor.Builder() + .displayName("Domain") + .name("domain") + .description( + "The domain used for authentication. Optional, in most cases username and password is sufficient.") + .required(false) + .addValidator(NON_EMPTY_VALIDATOR) + .build(); + public static final PropertyDescriptor USERNAME = new PropertyDescriptor.Builder() + .displayName("Username") + .name("username") + .description( + "The username used for authentication.") + .required(false) + .defaultValue("Guest") + .addValidator(NON_EMPTY_VALIDATOR) + .build(); + public static final PropertyDescriptor PASSWORD = new PropertyDescriptor.Builder() + .displayName("Password") + .name("password") + .description("The password used for authentication.") + .required(false) + .addValidator(NON_EMPTY_VALIDATOR) + .sensitive(true) + .build(); + public static final PropertyDescriptor PORT = new PropertyDescriptor.Builder() + .displayName("Port") + .name("port") + .description("Port to use for connection.") + .required(true) + .addValidator(PORT_VALIDATOR) + .defaultValue("445") + .build(); + public static final PropertyDescriptor TIMEOUT = new PropertyDescriptor.Builder() + .displayName("Timeout") + .name("timeout") + .description("Timeout in seconds for read and write operations.") + .required(true) + .defaultValue("5") + .addValidator(INTEGER_VALIDATOR) + .build(); + private static final List<PropertyDescriptor> PROPERTIES = Collections + .unmodifiableList(asList( + HOSTNAME, + DOMAIN, + USERNAME, + PASSWORD, + PORT, + TIMEOUT + )); + private SMBClient smbClient; + private AuthenticationContext authenticationContext; + private ConfigurationContext context; + private String hostname; + private Integer port; + + @Override + public Session getSession() { + try { + return smbClient.connect(hostname, port).authenticate(authenticationContext); + } catch (IOException e) { + throw new UncheckedIOException(e); + } + } + + @Override + public URI getServiceLocation() { + return URI.create(String.format("smb://%s:%d", hostname, port)); + } + + @OnEnabled + public void onEnabled(ConfigurationContext context) throws IOException { + this.context = context; + this.hostname = context.getProperty(HOSTNAME).getValue(); + this.port = context.getProperty(PORT).asInteger(); + this.smbClient = new SMBClient(SmbConfig.builder() + .withTimeout(context.getProperty(TIMEOUT).asLong(), SECONDS) + .withTransportLayerFactory(new AsyncDirectTcpTransportFactory<>()) + .build()); + createAuthenticationContext(); + } + + @OnDisabled + public void onDisabled() { + smbClient.close(); + } + + @Override + protected List<PropertyDescriptor> getSupportedPropertyDescriptors() { + return PROPERTIES; + } + + @Override + protected Collection<ValidationResult> customValidate(ValidationContext validationContext) { + final String hostname = validationContext.getProperty(HOSTNAME).getValue(); + final String port = validationContext.getProperty(PORT).getValue(); + final String timeout = validationContext.getProperty(TIMEOUT).getValue(); + + return asList(HOSTNAME.validate(hostname, validationContext), + PORT.validate(port, validationContext), + TIMEOUT.validate(timeout, validationContext) + ); + } Review Comment: Yes, the `customValidate()` method works in addition to the validators defined on each PropertyDescriptor, so it is not necessary to implement `customValidate()` when standard validators are defined. A custom validation implementation can be used to evaluate dependencies between properties, or other logic, but the standard validators work when a property can be evaluate on its own. -- 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