refactor: Cleaned up in the API (moved the PlcConfiguration-related i…

…nterfaces back to SPI), renamed the "canX()" methods to match the bean naming convention of "isXSupported()". Also removed one or two obsolete interfaces)

plc4j/api/pom.xml

@@ -36,11 +36,6 @@
   </properties>
 
   <dependencies>
-    <dependency>
-      <groupId>org.apache.commons</groupId>
-      <artifactId>commons-lang3</artifactId>
-    </dependency>
-
     <dependency>
       <groupId>nl.jqno.equalsverifier</groupId>
       <artifactId>equalsverifier</artifactId>

plc4j/api/src/main/java/org/apache/plc4x/java/DefaultPlcDriverManager.java

@@ -107,10 +107,10 @@ public PlcConnection getConnection(String url, PlcAuthentication authentication)
     }
 
     /**
-     * Returns the codes of all of the drivers which are currently registered at the PlcDriverManager
+     * Returns the codes of all the drivers which are currently registered at the PlcDriverManager
      * @return Set of driver codes for all drivers registered
      */
-    public Set<String> listProtocolCodes() {
+    public Set<String> getProtocolCodes() {
         return driverMap.keySet();
     }
 

plc4j/api/src/main/java/org/apache/plc4x/java/api/PlcDriver.java

@@ -77,7 +77,7 @@ public Optional<OptionMetadata> getTransportConfigurationOptionMetadata(String t
             }
 
             @Override
-            public boolean canDiscover() {
+            public boolean isDiscoverySupported() {
                 return false;
             }
         };

plc4j/api/src/main/java/org/apache/plc4x/java/api/PlcDriverManager.java

@@ -29,7 +29,7 @@ static PlcDriverManager getDefault() {
         return new DefaultPlcDriverManager();
     }
 
-    Set<String> listProtocolCodes();
+    Set<String> getProtocolCodes();
 
     PlcDriver getDriver(String protocolCode) throws PlcConnectionException;
 

plc4j/api/src/main/java/org/apache/plc4x/java/api/messages/PlcBrowseItem.java

@@ -19,10 +19,8 @@
 package org.apache.plc4x.java.api.messages;
 
 import org.apache.plc4x.java.api.model.PlcTag;
-import org.apache.plc4x.java.api.types.PlcValueType;
 import org.apache.plc4x.java.api.value.PlcValue;
 
-import java.util.List;
 import java.util.Map;
 
 public interface PlcBrowseItem {

plc4j/api/src/main/java/org/apache/plc4x/java/api/messages/PlcRequestBuilder.java

@@ -19,6 +19,7 @@
 package org.apache.plc4x.java.api.messages;
 
 public interface PlcRequestBuilder {
+
     PlcRequest build();
 
 }

plc4j/api/src/main/java/org/apache/plc4x/java/api/messages/PlcResponse.java

@@ -23,5 +23,7 @@
  * from a plc to the plc4x system.
  */
 public interface PlcResponse extends PlcMessage {
+
     PlcRequest getRequest();
+
 }

plc4j/api/src/main/java/org/apache/plc4x/java/api/metadata/Option.java

@@ -19,6 +19,8 @@
 
 package org.apache.plc4x.java.api.metadata;
 
+import org.apache.plc4x.java.api.types.OptionType;
+
 import java.util.Optional;
 
 public interface Option {

plc4j/api/src/main/java/org/apache/plc4x/java/api/metadata/OptionMetadata.java

@@ -24,6 +24,7 @@
 public interface OptionMetadata {
 
     List<Option> getOptions();
+
     List<Option> getRequiredOptions();
 
 }

plc4j/api/src/main/java/org/apache/plc4x/java/api/metadata/PlcConnectionMetadata.java

@@ -27,21 +27,21 @@ public interface PlcConnectionMetadata {
     /**
      * Indicates that the connection supports reading.
      */
-    boolean canRead();
+    boolean isReadSupported();
 
     /**
      * Indicates that the connection supports writing.
      */
-    boolean canWrite();
+    boolean isWriteSupported();
 
     /**
      * Indicates that the connection supports subscription.
      */
-    boolean canSubscribe();
+    boolean isSubscribeSupported();
 
     /**
      * Indicates that the connection supports browsing.
      */
-    boolean canBrowse();
+    boolean isBrowseSupported();
 
 }

plc4j/api/src/main/java/org/apache/plc4x/java/api/metadata/PlcDriverMetadata.java

@@ -50,5 +50,6 @@ public interface PlcDriverMetadata {
     /**
      * @return true, if the current driver supports discovery.
      */
-    boolean canDiscover();
+    boolean isDiscoverySupported();
+
 }

plc4j/api/src/main/java/org/apache/plc4x/java/api/metadata/OptionType.java → plc4j/api/src/main/java/org/apache/plc4x/java/api/types/OptionType.java

@@ -17,7 +17,7 @@
  * under the License.
  */
 
-package org.apache.plc4x.java.api.metadata;
+package org.apache.plc4x.java.api.types;
 
 public enum OptionType {
     BOOLEAN,

plc4j/api/src/test/java/org/apache/plc4x/java/mock/ApiMockDriver.java

@@ -21,7 +21,6 @@
 import org.apache.plc4x.java.api.PlcConnection;
 import org.apache.plc4x.java.api.authentication.PlcAuthentication;
 import org.apache.plc4x.java.api.PlcDriver;
-import org.apache.plc4x.java.api.configuration.PlcConnectionConfiguration;
 
 import static org.mockito.Mockito.mock;
 import static org.mockito.Mockito.when;

plc4j/drivers/ab-eth/src/main/java/org/apache/plc4x/java/abeth/AbEthDriver.java

@@ -25,8 +25,8 @@
 import org.apache.plc4x.java.abeth.tag.AbEthTagHandler;
 import org.apache.plc4x.java.abeth.protocol.AbEthProtocolLogic;
 import org.apache.plc4x.java.abeth.readwrite.CIPEncapsulationPacket;
-import org.apache.plc4x.java.api.configuration.PlcConnectionConfiguration;
-import org.apache.plc4x.java.api.configuration.PlcTransportConfiguration;
+import org.apache.plc4x.java.spi.configuration.PlcConnectionConfiguration;
+import org.apache.plc4x.java.spi.configuration.PlcTransportConfiguration;
 import org.apache.plc4x.java.api.model.PlcTag;
 import org.apache.plc4x.java.spi.values.PlcValueHandler;
 import org.apache.plc4x.java.spi.connection.GeneratedDriverBase;

plc4j/drivers/ab-eth/src/main/java/org/apache/plc4x/java/abeth/configuration/AbEthConfiguration.java

@@ -18,7 +18,7 @@
  */
 package org.apache.plc4x.java.abeth.configuration;
 
-import org.apache.plc4x.java.api.configuration.PlcConnectionConfiguration;
+import org.apache.plc4x.java.spi.configuration.PlcConnectionConfiguration;
 import org.apache.plc4x.java.spi.configuration.annotations.ConfigurationParameter;
 import org.apache.plc4x.java.spi.configuration.annotations.Description;
 

plc4j/drivers/ads/src/main/java/org/apache/plc4x/java/ads/AdsPlcDriver.java

@@ -25,10 +25,9 @@
 import org.apache.plc4x.java.ads.tag.AdsTagHandler;
 import org.apache.plc4x.java.ads.protocol.AdsProtocolLogic;
 import org.apache.plc4x.java.ads.readwrite.AmsTCPPacket;
-import org.apache.plc4x.java.api.configuration.PlcConnectionConfiguration;
-import org.apache.plc4x.java.api.configuration.PlcTransportConfiguration;
+import org.apache.plc4x.java.spi.configuration.PlcConnectionConfiguration;
+import org.apache.plc4x.java.spi.configuration.PlcTransportConfiguration;
 import org.apache.plc4x.java.api.messages.PlcDiscoveryRequest;
-import org.apache.plc4x.java.api.metadata.PlcDriverMetadata;
 import org.apache.plc4x.java.spi.messages.DefaultPlcDiscoveryRequest;
 import org.apache.plc4x.java.spi.values.PlcValueHandler;
 import org.apache.plc4x.java.spi.connection.GeneratedDriverBase;

plc4j/drivers/ads/src/main/java/org/apache/plc4x/java/ads/configuration/AdsConfiguration.java

@@ -20,7 +20,7 @@
 
 import org.apache.commons.lang3.ArrayUtils;
 import org.apache.plc4x.java.ads.readwrite.AmsNetId;
-import org.apache.plc4x.java.api.configuration.PlcConnectionConfiguration;
+import org.apache.plc4x.java.spi.configuration.PlcConnectionConfiguration;
 import org.apache.plc4x.java.spi.configuration.ConfigurationParameterConverter;
 import org.apache.plc4x.java.spi.configuration.annotations.*;
 import org.apache.plc4x.java.spi.configuration.annotations.defaults.BooleanDefaultValue;

plc4j/drivers/ads/src/test/java/org/apache/plc4x/protocol/ads/Scanner.java

@@ -61,8 +61,8 @@ public static void main(String[] args) throws Exception {
         // Establish a connection to the plc using the url provided as first argument
         try (PlcConnection plcConnection = new DefaultPlcDriverManager().getConnection(connectionString)) {
             PlcConnectionMetadata metadata = plcConnection.getMetadata();
-            System.out.println("read: " + metadata.canRead());
-            System.out.println("write: " + metadata.canWrite());
+            System.out.println("read: " + metadata.isReadSupported());
+            System.out.println("write: " + metadata.isWriteSupported());
 
             // read symbols
             System.out.println("Reading symbol info");

plc4j/drivers/all/src/site/groovy/generate-config-documentation.groovy

@@ -50,7 +50,7 @@ Thread.currentThread().setContextClassLoader(moduleClassloader)
 def plcDriverManager = new DefaultPlcDriverManager(moduleClassloader)
 
 // Process all driver information.
-for (final def protocolCode in plcDriverManager.listProtocolCodes()) {
+for (final def protocolCode in plcDriverManager.getProtocolCodes()) {
     def outputFile = new File(project.getBasedir(), "src/site/generated/" + protocolCode + ".adoc")
     // In order to re-generate this file, make sure it doesn't exist.
     if(outputFile.exists()) {

plc4j/drivers/bacnet/src/main/java/org/apache/plc4x/java/bacnetip/BacNetIpDriver.java

@@ -19,8 +19,8 @@
 package org.apache.plc4x.java.bacnetip;
 
 import io.netty.buffer.ByteBuf;
-import org.apache.plc4x.java.api.configuration.PlcConnectionConfiguration;
-import org.apache.plc4x.java.api.configuration.PlcTransportConfiguration;
+import org.apache.plc4x.java.spi.configuration.PlcConnectionConfiguration;
+import org.apache.plc4x.java.spi.configuration.PlcTransportConfiguration;
 import org.apache.plc4x.java.bacnetip.configuration.BacNetIpConfiguration;
 import org.apache.plc4x.java.bacnetip.configuration.BacNetPcapReplayTransportConfiguration;
 import org.apache.plc4x.java.bacnetip.configuration.BacNetRawSocketTransportConfiguration;

plc4j/drivers/bacnet/src/main/java/org/apache/plc4x/java/bacnetip/configuration/BacNetIpConfiguration.java

@@ -18,7 +18,7 @@
  */
 package org.apache.plc4x.java.bacnetip.configuration;
 
-import org.apache.plc4x.java.api.configuration.PlcConnectionConfiguration;
+import org.apache.plc4x.java.spi.configuration.PlcConnectionConfiguration;
 import org.apache.plc4x.java.spi.configuration.annotations.ConfigurationParameter;
 import org.apache.plc4x.java.spi.configuration.annotations.Description;
 

plc4j/drivers/c-bus/src/main/java/org/apache/plc4x/java/cbus/CBusDriver.java

@@ -19,8 +19,8 @@
 package org.apache.plc4x.java.cbus;
 
 import io.netty.buffer.ByteBuf;
-import org.apache.plc4x.java.api.configuration.PlcConnectionConfiguration;
-import org.apache.plc4x.java.api.configuration.PlcTransportConfiguration;
+import org.apache.plc4x.java.spi.configuration.PlcConnectionConfiguration;
+import org.apache.plc4x.java.spi.configuration.PlcTransportConfiguration;
 import org.apache.plc4x.java.api.value.PlcValueHandler;
 import org.apache.plc4x.java.cbus.configuration.CBusConfiguration;
 import org.apache.plc4x.java.cbus.configuration.CBusTcpTransportConfiguration;

plc4j/drivers/c-bus/src/main/java/org/apache/plc4x/java/cbus/configuration/CBusConfiguration.java

@@ -18,7 +18,7 @@
  */
 package org.apache.plc4x.java.cbus.configuration;
 
-import org.apache.plc4x.java.api.configuration.PlcConnectionConfiguration;
+import org.apache.plc4x.java.spi.configuration.PlcConnectionConfiguration;
 import org.apache.plc4x.java.spi.configuration.annotations.ConfigurationParameter;
 import org.apache.plc4x.java.spi.configuration.annotations.Description;
 import org.apache.plc4x.java.spi.configuration.annotations.defaults.BooleanDefaultValue;

plc4j/drivers/can/src/main/java/org/apache/plc4x/java/can/adapter/conversation/ConversationContextWrapper.java

@@ -23,7 +23,7 @@
 import java.util.function.Function;
 
 import org.apache.plc4x.java.api.authentication.PlcAuthentication;
-import org.apache.plc4x.java.api.configuration.PlcConnectionConfiguration;
+import org.apache.plc4x.java.spi.configuration.PlcConnectionConfiguration;
 import org.apache.plc4x.java.spi.ConversationContext;
 import org.apache.plc4x.java.transport.can.CANTransport.FrameHandler;
 import org.apache.plc4x.java.transport.can.FrameData;

plc4j/drivers/can/src/main/java/org/apache/plc4x/java/can/generic/GenericCANDriver.java

@@ -18,7 +18,7 @@
  */
 package org.apache.plc4x.java.can.generic;
 
-import org.apache.plc4x.java.api.configuration.PlcConnectionConfiguration;
+import org.apache.plc4x.java.spi.configuration.PlcConnectionConfiguration;
 import org.apache.plc4x.java.api.exceptions.PlcRuntimeException;
 import org.apache.plc4x.java.can.adapter.CANDriverAdapter;
 import org.apache.plc4x.java.can.generic.configuration.GenericCANConfiguration;

plc4j/drivers/can/src/main/java/org/apache/plc4x/java/can/generic/configuration/GenericCANConfiguration.java

@@ -18,7 +18,7 @@
  */
 package org.apache.plc4x.java.can.generic.configuration;
 
-import org.apache.plc4x.java.api.configuration.PlcConnectionConfiguration;
+import org.apache.plc4x.java.spi.configuration.PlcConnectionConfiguration;
 import org.apache.plc4x.java.spi.configuration.annotations.ConfigurationParameter;
 import org.apache.plc4x.java.spi.configuration.annotations.Description;
 import org.apache.plc4x.java.spi.configuration.annotations.defaults.IntDefaultValue;

plc4j/drivers/can/src/test/java/org/apache/plc4x/java/can/generic/GenericCANDriverTest.java

@@ -20,7 +20,6 @@
 
 import java.util.concurrent.CountDownLatch;
 import java.util.concurrent.atomic.AtomicReference;
-import java.util.function.Consumer;
 
 import org.apache.plc4x.java.DefaultPlcDriverManager;
 import org.apache.plc4x.java.api.PlcConnection;
@@ -39,9 +38,9 @@ void testConnection() throws PlcConnectionException {
 
         assertNotNull(connection);
         assertTrue(connection.isConnected());
-        assertFalse(connection.getMetadata().canRead());
-        assertTrue(connection.getMetadata().canWrite());
-        assertTrue(connection.getMetadata().canSubscribe());
+        assertFalse(connection.getMetadata().isReadSupported());
+        assertTrue(connection.getMetadata().isWriteSupported());
+        assertTrue(connection.getMetadata().isSubscribeSupported());
     }
 
     @Test

plc4j/drivers/canopen/src/main/java/org/apache/plc4x/java/canopen/CANOpenPlcDriver.java

@@ -18,7 +18,7 @@
  */
 package org.apache.plc4x.java.canopen;
 
-import org.apache.plc4x.java.api.configuration.PlcConnectionConfiguration;
+import org.apache.plc4x.java.spi.configuration.PlcConnectionConfiguration;
 import org.apache.plc4x.java.api.exceptions.PlcRuntimeException;
 import org.apache.plc4x.java.api.model.PlcTag;
 import org.apache.plc4x.java.api.value.PlcValue;

plc4j/drivers/canopen/src/main/java/org/apache/plc4x/java/canopen/configuration/CANOpenConfiguration.java

@@ -18,7 +18,7 @@
  */
 package org.apache.plc4x.java.canopen.configuration;
 
-import org.apache.plc4x.java.api.configuration.PlcConnectionConfiguration;
+import org.apache.plc4x.java.spi.configuration.PlcConnectionConfiguration;
 import org.apache.plc4x.java.spi.configuration.annotations.ConfigurationParameter;
 import org.apache.plc4x.java.spi.configuration.annotations.Description;
 import org.apache.plc4x.java.spi.configuration.annotations.defaults.IntDefaultValue;

plc4j/drivers/canopen/src/test/java/org/apache/plc4x/java/canopen/CANTestTransport.java

@@ -23,7 +23,7 @@
 import java.util.function.Function;
 import java.util.function.ToIntFunction;
 
-import org.apache.plc4x.java.api.configuration.PlcConnectionConfiguration;
+import org.apache.plc4x.java.spi.configuration.PlcConnectionConfiguration;
 import org.apache.plc4x.java.canopen.readwrite.CANOpenFrame;
 import org.apache.plc4x.java.canopen.transport.CANOpenFrameDataAdapter;
 import org.apache.plc4x.java.canopen.transport.IdentityCANOpenFrameBuilder;