plc4j/drivers/opcua/src/main/java/org/apache/plc4x/java/opcua/OpcuaPlcDriver.java - plc4x - Git at Google

 /*
  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.plc4x.java.opcua;

 import org.apache.plc4x.java.api.PlcConnection;
 import org.apache.plc4x.java.api.authentication.PlcAuthentication;
 import org.apache.plc4x.java.api.exceptions.PlcConnectionException;
 import org.apache.plc4x.java.opcua.field.OpcuaField;
 import org.apache.plc4x.java.opcua.field.OpcuaPlcFieldHandler;
 import org.apache.plc4x.java.opcua.optimizer.OpcuaOptimizer;
 import org.apache.plc4x.java.opcua.protocol.*;
 import org.apache.plc4x.java.opcua.config.*;
 import org.apache.plc4x.java.opcua.readwrite.*;
 import org.apache.plc4x.java.opcua.readwrite.io.*;
 import org.apache.plc4x.java.spi.configuration.ConfigurationFactory;
 import org.apache.plc4x.java.spi.connection.*;
 import org.apache.plc4x.java.spi.transport.Transport;
 import org.apache.plc4x.java.spi.values.IEC61131ValueHandler;
 import org.apache.plc4x.java.api.value.PlcValueHandler;
 import org.apache.plc4x.java.spi.configuration.Configuration;
 import org.apache.plc4x.java.spi.connection.GeneratedDriverBase;
 import io.netty.buffer.ByteBuf;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;

 import java.util.ServiceLoader;
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;

 import java.util.function.ToIntFunction;

 import static org.apache.plc4x.java.spi.configuration.ConfigurationFactory.configure;

 public class OpcuaPlcDriver extends GeneratedDriverBase<OpcuaAPU> {

     private static final Logger LOGGER = LoggerFactory.getLogger(OpcuaPlcDriver.class);

     public static final Pattern INET_ADDRESS_PATTERN = Pattern.compile("(:(?<transportCode>tcp))?://" +
                                                                         "(?<transportHost>[\\w.-]+)(:" +
                                                                         "(?<transportPort>\\d*))?");

     public static final Pattern URI_PATTERN = Pattern.compile("^(?<protocolCode>opcua)" +
                                                                     INET_ADDRESS_PATTERN +
                                                                     "(?<transportEndpoint>[\\w/=]*)[\\?]?" +
                                                                     "(?<paramString>([^\\=]+\\=[^\\=&]+[&]?)*)"
                                                                 );

     private boolean isEncrypted;

     @Override
     public String getProtocolCode() {
         return "opcua";
     }

     @Override
     public String getProtocolName() {
         return "Opcua";
     }

     @Override
     protected Class<? extends Configuration> getConfigurationType() {
         return OpcuaConfiguration.class;
     }

     @Override
     protected String getDefaultTransport() {
         return "tcp";
     }

     @Override
     protected boolean awaitSetupComplete() {
         return true;
     }

     @Override
     protected boolean awaitDiscoverComplete() {
         return isEncrypted;
     }

     @Override
     protected boolean canRead() {
         return true;
     }

     @Override
     protected boolean canWrite() {
         return true;
     }

     @Override
     protected boolean canSubscribe() {
         return true;
     }

     @Override
     protected OpcuaOptimizer getOptimizer() {
         return new OpcuaOptimizer();
     }

     @Override
     protected OpcuaPlcFieldHandler getFieldHandler() {
         return new OpcuaPlcFieldHandler();
     }

     @Override
     protected PlcValueHandler getValueHandler() {
         return new IEC61131ValueHandler();
     }

     protected boolean awaitDisconnectComplete() {
         return true;
     }

     @Override
     protected ProtocolStackConfigurer<OpcuaAPU> getStackConfigurer() {
         return SingleProtocolStackConfigurer.builder(OpcuaAPU.class, OpcuaAPUIO.class)
             .withProtocol(OpcuaProtocolLogic.class)
             .withPacketSizeEstimator(ByteLengthEstimator.class)
             .withParserArgs(true)
             .littleEndian()
             .build();
     }

     @Override
     public PlcConnection getConnection(String connectionString) throws PlcConnectionException {
         // Split up the connection string into it's individual segments.
         Matcher matcher = URI_PATTERN.matcher(connectionString);
         if (!matcher.matches()) {
             throw new PlcConnectionException(
                 "Connection string doesn't match the format '{protocol-code}:({transport-code})?//{transport-host}(:{transport-port})(/{transport-endpoint})(?{parameter-string)?'");
         }
         final String protocolCode = matcher.group("protocolCode");
         final String transportCode = (matcher.group("transportCode") != null) ?
             matcher.group("transportCode") : getDefaultTransport();
         final String transportHost = matcher.group("transportHost");
         final String transportPort = matcher.group("transportPort");
         final String transportEndpoint = matcher.group("transportEndpoint");
         final String paramString = matcher.group("paramString");

         // Check if the protocol code matches this driver.
         if(!protocolCode.equals(getProtocolCode())) {
             // Actually this shouldn't happen as the DriverManager should have not used this driver in the first place.
             throw new PlcConnectionException(
                 "This driver is not suited to handle this connection string");
         }

         // Create the configuration object.
         OpcuaConfiguration configuration = (OpcuaConfiguration) new ConfigurationFactory().createConfiguration(
             getConfigurationType(), paramString);
         if(configuration == null) {
             throw new PlcConnectionException("Unsupported configuration");
         }
         configuration.setTransportCode(transportCode);
         configuration.setHost(transportHost);
         configuration.setPort(transportPort);
         configuration.setEndpoint("opc." + transportCode + "://" + transportHost + ":" + transportPort + "" + transportEndpoint);

         // Try to find a transport in order to create a communication channel.
         Transport transport = null;
         ServiceLoader<Transport> transportLoader = ServiceLoader.load(
             Transport.class, Thread.currentThread().getContextClassLoader());
         for (Transport curTransport : transportLoader) {
             if(curTransport.getTransportCode().equals(transportCode)) {
                 transport = curTransport;
                 break;
             }
         }
         if(transport == null) {
             throw new PlcConnectionException("Unsupported transport " + transportCode);
         }

         // Inject the configuration into the transport.
         configure(configuration, transport);

         // Create an instance of the communication channel which the driver should use.
         ChannelFactory channelFactory = transport.createChannelFactory(transportHost + ":" + transportPort);
         if(channelFactory == null) {
             throw new PlcConnectionException("Unable to get channel factory from url " + transportHost + ":" + transportPort);
         }
         configure(configuration, channelFactory);

         // Give drivers the option to customize the channel.
         initializePipeline(channelFactory);

         // Make the "await setup complete" overridable via system property.
         boolean awaitSetupComplete = awaitSetupComplete();
         if(System.getProperty(PROPERTY_PLC4X_FORCE_AWAIT_SETUP_COMPLETE) != null) {
             awaitSetupComplete = Boolean.parseBoolean(System.getProperty(PROPERTY_PLC4X_FORCE_AWAIT_SETUP_COMPLETE));
         }

         // Make the "await disconnect complete" overridable via system property.
         boolean awaitDisconnectComplete = awaitDisconnectComplete();
         if(System.getProperty(PROPERTY_PLC4X_FORCE_AWAIT_DISCONNECT_COMPLETE) != null) {
             awaitDisconnectComplete = Boolean.parseBoolean(System.getProperty(PROPERTY_PLC4X_FORCE_AWAIT_DISCONNECT_COMPLETE));
         }

         if (configuration.getSecurityPolicy() != null && !(configuration.getSecurityPolicy().equals("None"))) {
             try {
                 configuration.openKeyStore();
             } catch (Exception e) {
                 throw new PlcConnectionException("Unable to open keystore, please confirm you have the correct permissions");
             }
         }

         this.isEncrypted = configuration.isEncrypted();

         // Make the "await disconnect complete" overridable via system property.
         boolean awaitDiscoverComplete = awaitDiscoverComplete();
         if(System.getProperty(PROPERTY_PLC4X_FORCE_AWAIT_DISCOVER_COMPLETE) != null) {
             awaitDiscoverComplete = Boolean.parseBoolean(System.getProperty(PROPERTY_PLC4X_FORCE_AWAIT_DISCOVER_COMPLETE));
         }

         return new DefaultNettyPlcConnection(
             canRead(), canWrite(), canSubscribe(),
             getFieldHandler(),
             getValueHandler(),
             configuration,
             channelFactory,
             awaitSetupComplete,
             awaitDisconnectComplete,
             awaitDiscoverComplete,
             getStackConfigurer(),
             getOptimizer());
     }

     @Override
     public PlcConnection getConnection(String url, PlcAuthentication authentication) throws PlcConnectionException {
         throw new PlcConnectionException("Authentication not supported.");
     }

     /** Estimate the Length of a Packet */
     public static class ByteLengthEstimator implements ToIntFunction<ByteBuf> {
         @Override
         public int applyAsInt(ByteBuf byteBuf) {
             if (byteBuf.readableBytes() >= 8) {
                 return Integer.reverseBytes(byteBuf.getInt(byteBuf.readerIndex() + 4));
             }
             return -1;
         }
     }

     @Override
     public OpcuaField prepareField(String query){
         return OpcuaField.of(query);
     }

 }
	/*
	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.plc4x.java.opcua;

	import org.apache.plc4x.java.api.PlcConnection;
	import org.apache.plc4x.java.api.authentication.PlcAuthentication;
	import org.apache.plc4x.java.api.exceptions.PlcConnectionException;
	import org.apache.plc4x.java.opcua.field.OpcuaField;
	import org.apache.plc4x.java.opcua.field.OpcuaPlcFieldHandler;
	import org.apache.plc4x.java.opcua.optimizer.OpcuaOptimizer;
	import org.apache.plc4x.java.opcua.protocol.*;
	import org.apache.plc4x.java.opcua.config.*;
	import org.apache.plc4x.java.opcua.readwrite.*;
	import org.apache.plc4x.java.opcua.readwrite.io.*;
	import org.apache.plc4x.java.spi.configuration.ConfigurationFactory;
	import org.apache.plc4x.java.spi.connection.*;
	import org.apache.plc4x.java.spi.transport.Transport;
	import org.apache.plc4x.java.spi.values.IEC61131ValueHandler;
	import org.apache.plc4x.java.api.value.PlcValueHandler;
	import org.apache.plc4x.java.spi.configuration.Configuration;
	import org.apache.plc4x.java.spi.connection.GeneratedDriverBase;
	import io.netty.buffer.ByteBuf;
	import org.slf4j.Logger;
	import org.slf4j.LoggerFactory;

	import java.util.ServiceLoader;
	import java.util.regex.Matcher;
	import java.util.regex.Pattern;

	import java.util.function.ToIntFunction;

	import static org.apache.plc4x.java.spi.configuration.ConfigurationFactory.configure;

	public class OpcuaPlcDriver extends GeneratedDriverBase<OpcuaAPU> {

	private static final Logger LOGGER = LoggerFactory.getLogger(OpcuaPlcDriver.class);

	public static final Pattern INET_ADDRESS_PATTERN = Pattern.compile("(:(?<transportCode>tcp))?://" +
	"(?<transportHost>[\\w.-]+)(:" +
	"(?<transportPort>\\d*))?");

	public static final Pattern URI_PATTERN = Pattern.compile("^(?<protocolCode>opcua)" +
	INET_ADDRESS_PATTERN +
	"(?<transportEndpoint>[\\w/=]*)[\\?]?" +
	"(?<paramString>([^\\=]+\\=[^\\=&]+[&]?)*)"
	);

	private boolean isEncrypted;

	@Override
	public String getProtocolCode() {
	return "opcua";
	}

	@Override
	public String getProtocolName() {
	return "Opcua";
	}

	@Override
	protected Class<? extends Configuration> getConfigurationType() {
	return OpcuaConfiguration.class;
	}

	@Override
	protected String getDefaultTransport() {
	return "tcp";
	}

	@Override
	protected boolean awaitSetupComplete() {
	return true;
	}

	@Override
	protected boolean awaitDiscoverComplete() {
	return isEncrypted;
	}

	@Override
	protected boolean canRead() {
	return true;
	}

	@Override
	protected boolean canWrite() {
	return true;
	}

	@Override
	protected boolean canSubscribe() {
	return true;
	}

	@Override
	protected OpcuaOptimizer getOptimizer() {
	return new OpcuaOptimizer();
	}

	@Override
	protected OpcuaPlcFieldHandler getFieldHandler() {
	return new OpcuaPlcFieldHandler();
	}

	@Override
	protected PlcValueHandler getValueHandler() {
	return new IEC61131ValueHandler();
	}

	protected boolean awaitDisconnectComplete() {
	return true;
	}

	@Override
	protected ProtocolStackConfigurer<OpcuaAPU> getStackConfigurer() {
	return SingleProtocolStackConfigurer.builder(OpcuaAPU.class, OpcuaAPUIO.class)
	.withProtocol(OpcuaProtocolLogic.class)
	.withPacketSizeEstimator(ByteLengthEstimator.class)
	.withParserArgs(true)
	.littleEndian()
	.build();
	}

	@Override
	public PlcConnection getConnection(String connectionString) throws PlcConnectionException {
	// Split up the connection string into it's individual segments.
	Matcher matcher = URI_PATTERN.matcher(connectionString);
	if (!matcher.matches()) {
	throw new PlcConnectionException(
	"Connection string doesn't match the format '{protocol-code}:({transport-code})?//{transport-host}(:{transport-port})(/{transport-endpoint})(?{parameter-string)?'");
	}
	final String protocolCode = matcher.group("protocolCode");
	final String transportCode = (matcher.group("transportCode") != null) ?
	matcher.group("transportCode") : getDefaultTransport();
	final String transportHost = matcher.group("transportHost");
	final String transportPort = matcher.group("transportPort");
	final String transportEndpoint = matcher.group("transportEndpoint");
	final String paramString = matcher.group("paramString");

	// Check if the protocol code matches this driver.
	if(!protocolCode.equals(getProtocolCode())) {
	// Actually this shouldn't happen as the DriverManager should have not used this driver in the first place.
	throw new PlcConnectionException(
	"This driver is not suited to handle this connection string");
	}

	// Create the configuration object.
	OpcuaConfiguration configuration = (OpcuaConfiguration) new ConfigurationFactory().createConfiguration(
	getConfigurationType(), paramString);
	if(configuration == null) {
	throw new PlcConnectionException("Unsupported configuration");
	}
	configuration.setTransportCode(transportCode);
	configuration.setHost(transportHost);
	configuration.setPort(transportPort);
	configuration.setEndpoint("opc." + transportCode + "://" + transportHost + ":" + transportPort + "" + transportEndpoint);

	// Try to find a transport in order to create a communication channel.
	Transport transport = null;
	ServiceLoader<Transport> transportLoader = ServiceLoader.load(
	Transport.class, Thread.currentThread().getContextClassLoader());
	for (Transport curTransport : transportLoader) {
	if(curTransport.getTransportCode().equals(transportCode)) {
	transport = curTransport;
	break;
	}
	}
	if(transport == null) {
	throw new PlcConnectionException("Unsupported transport " + transportCode);
	}

	// Inject the configuration into the transport.
	configure(configuration, transport);

	// Create an instance of the communication channel which the driver should use.
	ChannelFactory channelFactory = transport.createChannelFactory(transportHost + ":" + transportPort);
	if(channelFactory == null) {
	throw new PlcConnectionException("Unable to get channel factory from url " + transportHost + ":" + transportPort);
	}
	configure(configuration, channelFactory);

	// Give drivers the option to customize the channel.
	initializePipeline(channelFactory);

	// Make the "await setup complete" overridable via system property.
	boolean awaitSetupComplete = awaitSetupComplete();
	if(System.getProperty(PROPERTY_PLC4X_FORCE_AWAIT_SETUP_COMPLETE) != null) {
	awaitSetupComplete = Boolean.parseBoolean(System.getProperty(PROPERTY_PLC4X_FORCE_AWAIT_SETUP_COMPLETE));
	}

	// Make the "await disconnect complete" overridable via system property.
	boolean awaitDisconnectComplete = awaitDisconnectComplete();
	if(System.getProperty(PROPERTY_PLC4X_FORCE_AWAIT_DISCONNECT_COMPLETE) != null) {
	awaitDisconnectComplete = Boolean.parseBoolean(System.getProperty(PROPERTY_PLC4X_FORCE_AWAIT_DISCONNECT_COMPLETE));
	}

	if (configuration.getSecurityPolicy() != null && !(configuration.getSecurityPolicy().equals("None"))) {
	try {
	configuration.openKeyStore();
	} catch (Exception e) {
	throw new PlcConnectionException("Unable to open keystore, please confirm you have the correct permissions");
	}
	}

	this.isEncrypted = configuration.isEncrypted();

	// Make the "await disconnect complete" overridable via system property.
	boolean awaitDiscoverComplete = awaitDiscoverComplete();
	if(System.getProperty(PROPERTY_PLC4X_FORCE_AWAIT_DISCOVER_COMPLETE) != null) {
	awaitDiscoverComplete = Boolean.parseBoolean(System.getProperty(PROPERTY_PLC4X_FORCE_AWAIT_DISCOVER_COMPLETE));
	}

	return new DefaultNettyPlcConnection(
	canRead(), canWrite(), canSubscribe(),
	getFieldHandler(),
	getValueHandler(),
	configuration,
	channelFactory,
	awaitSetupComplete,
	awaitDisconnectComplete,
	awaitDiscoverComplete,
	getStackConfigurer(),
	getOptimizer());
	}

	@Override
	public PlcConnection getConnection(String url, PlcAuthentication authentication) throws PlcConnectionException {
	throw new PlcConnectionException("Authentication not supported.");
	}

	/** Estimate the Length of a Packet */
	public static class ByteLengthEstimator implements ToIntFunction<ByteBuf> {
	@Override
	public int applyAsInt(ByteBuf byteBuf) {
	if (byteBuf.readableBytes() >= 8) {
	return Integer.reverseBytes(byteBuf.getInt(byteBuf.readerIndex() + 4));
	}
	return -1;
	}
	}

	@Override
	public OpcuaField prepareField(String query){
	return OpcuaField.of(query);
	}

	}