Polished
Project: http://git-wip-us.apache.org/repos/asf/camel/repo Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/4f81dc6e Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/4f81dc6e Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/4f81dc6e Branch: refs/heads/master Commit: 4f81dc6eb0dc9b74d9fbe27588415be5a0dbfc46 Parents: 2e11ef5 Author: Claus Ibsen <davscl...@apache.org> Authored: Sat Sep 23 09:31:16 2017 +0200 Committer: Claus Ibsen <davscl...@apache.org> Committed: Sat Sep 23 09:31:16 2017 +0200 ---------------------------------------------------------------------- components/camel-iec60870/pom.xml | 11 +------ .../main/docs/iec60870-client-component.adoc | 32 ++++++-------------- .../main/docs/iec60870-server-component.adoc | 31 ++++++------------- .../iec60870/client/ClientEndpoint.java | 7 ++++- .../iec60870/server/ServerEndpoint.java | 7 ++++- .../iec60870/testing/ExampleApplication1.java | 1 + .../ClientComponentConfiguration.java | 4 ++- .../ServerComponentConfiguration.java | 4 ++- 8 files changed, 38 insertions(+), 59 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/camel/blob/4f81dc6e/components/camel-iec60870/pom.xml ---------------------------------------------------------------------- diff --git a/components/camel-iec60870/pom.xml b/components/camel-iec60870/pom.xml index 6102479..7b49501 100644 --- a/components/camel-iec60870/pom.xml +++ b/components/camel-iec60870/pom.xml @@ -34,7 +34,6 @@ <properties> <camel.osgi.export.pkg> - !*.internal.*, org.apache.camel.component.iec60870.* </camel.osgi.export.pkg> <camel.osgi.export.service> @@ -44,6 +43,7 @@ </properties> <dependencies> + <dependency> <groupId>org.apache.camel</groupId> <artifactId>camel-core</artifactId> @@ -54,31 +54,26 @@ <artifactId>org.eclipse.neoscada.protocol.iec60870</artifactId> <version>${neoscada-version}</version> </dependency> - <dependency> <groupId>org.eclipse.neoscada.protocols</groupId> <artifactId>org.eclipse.neoscada.protocol.iec60870.client</artifactId> <version>${neoscada-version}</version> </dependency> - <dependency> <groupId>org.eclipse.neoscada.protocols</groupId> <artifactId>org.eclipse.neoscada.protocol.iec60870.client.data</artifactId> <version>${neoscada-version}</version> </dependency> - <dependency> <groupId>org.eclipse.neoscada.protocols</groupId> <artifactId>org.eclipse.neoscada.protocol.iec60870.server</artifactId> <version>${neoscada-version}</version> </dependency> - <dependency> <groupId>org.eclipse.neoscada.protocols</groupId> <artifactId>org.eclipse.neoscada.protocol.iec60870.server.data</artifactId> <version>${neoscada-version}</version> </dependency> - <dependency> <groupId>org.eclipse.neoscada.utils</groupId> <artifactId>org.eclipse.scada.utils</artifactId> @@ -90,25 +85,21 @@ <artifactId>netty-buffer</artifactId> <version>${netty-version}</version> </dependency> - <dependency> <groupId>io.netty</groupId> <artifactId>netty-codec</artifactId> <version>${netty-version}</version> </dependency> - <dependency> <groupId>io.netty</groupId> <artifactId>netty-common</artifactId> <version>${netty-version}</version> </dependency> - <dependency> <groupId>io.netty</groupId> <artifactId>netty-handler</artifactId> <version>${netty-version}</version> </dependency> - <dependency> <groupId>io.netty</groupId> <artifactId>netty-transport</artifactId> http://git-wip-us.apache.org/repos/asf/camel/blob/4f81dc6e/components/camel-iec60870/src/main/docs/iec60870-client-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-iec60870/src/main/docs/iec60870-client-component.adoc b/components/camel-iec60870/src/main/docs/iec60870-client-component.adoc index 6af9fb8..b91c44a 100644 --- a/components/camel-iec60870/src/main/docs/iec60870-client-component.adoc +++ b/components/camel-iec60870/src/main/docs/iec60870-client-component.adoc @@ -2,27 +2,21 @@ *Available as of Camel version 2.20* -### IEC 60870-5-104 Client Component - -*Available as of Camel 2.20* - The *IEC 60870-5-104 Client* component provides access to IEC 60870 servers using the http://eclipse.org/eclipsescada[Eclipse NeoSCADAâ¢] implementation. -*Java 8*: This component requires Java 8 at runtime. - Maven users will need to add the following dependency to their `pom.xml` for this component: [source,xml] ------------------------------------------------------------- +---- <dependency> <groupId>org.apache.camel</groupId> <artifactId>camel-iec60870</artifactId> <version>x.x.x</version> <!-- use the same version as your Camel core version --> </dependency> ------------------------------------------------------------- +---- // component options: START The IEC 60870 Client component supports 2 options which are listed below. @@ -41,20 +35,20 @@ The IEC 60870 Client component supports 2 options which are listed below. -### URI format +=== URI format The URI syntax of the endpoint is: [source] ------------------------- +---- iec60870-client:host:port/00-01-02-03-04 ------------------------- +---- The information object address is encoded in the path in the syntax shows above. Please note that always the full, 5 octet address format is being used. Unused octets have to be filled with zero. -### URI options +=== URI options // endpoint options: START @@ -107,7 +101,8 @@ If a new connection id is encountered the connection options will be evaluated a is created with those options. -NOTE: If two URIs specify the same connection (host, port, â¦) but different connection options, then it is +[NOTE] +If two URIs specify the same connection (host, port, â¦) but different connection options, then it is undefined which of those connection options will be used. @@ -117,13 +112,4 @@ The final connection options will be evaluated in the following order: * Otherwise the +defaultConnectionOptions+ instance is copied and customized in the following steps * Apply +protocolOptions+ if present * Apply +dataModuleOptions+ if present -* Apply all explicit connection parameters (e.g. +timeZone+) - - - -### See Also - -* link:configuring-camel.html[Configuring Camel] -* link:component.html[Component] -* link:endpoint.html[Endpoint] -* link:getting-started.html[Getting Started] +* Apply all explicit connection parameters (e.g. +timeZone+) \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/4f81dc6e/components/camel-iec60870/src/main/docs/iec60870-server-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-iec60870/src/main/docs/iec60870-server-component.adoc b/components/camel-iec60870/src/main/docs/iec60870-server-component.adoc index 5915a51..ba3f6af 100644 --- a/components/camel-iec60870/src/main/docs/iec60870-server-component.adoc +++ b/components/camel-iec60870/src/main/docs/iec60870-server-component.adoc @@ -1,32 +1,26 @@ -== IEC 60870-5-104 server Component +== IEC 60870-5-104 Server Component *Available as of Camel version 2.20* -### IEC 60870-5-104 Server Component - -*Available as of Camel 2.20* - The *IEC 60870-5-104 Server* component provides access to IEC 60870 servers using the http://eclipse.org/eclipsescada[Eclipse NeoSCADAâ¢] implementation. -*Java 8*: This component requires Java 8 at runtime. - Maven users will need to add the following dependency to their `pom.xml` for this component: [source,xml] ------------------------------------------------------------- +---- <dependency> <groupId>org.apache.camel</groupId> <artifactId>camel-iec60870</artifactId> <version>x.x.x</version> <!-- use the same version as your Camel core version --> </dependency> ------------------------------------------------------------- +---- // component options: START -The IEC 60870-5-104 server component supports 2 options which are listed below. +The IEC 60870-5-104 Server component supports 2 options which are listed below. @@ -42,26 +36,26 @@ The IEC 60870-5-104 server component supports 2 options which are listed below. -### URI format +=== URI format The URI syntax of the endpoint is: [source] ------------------------- +---- iec60870-server:host:port/00-01-02-03-04 ------------------------- +---- The information object address is encoded in the path in the syntax shows above. Please note that always the full, 5 octet address format is being used. Unused octets have to be filled with zero. -### URI options +=== URI options // endpoint options: START -The IEC 60870-5-104 server endpoint is configured using URI syntax: +The IEC 60870-5-104 Server endpoint is configured using URI syntax: ---- iec60870-server:endpointUri @@ -104,10 +98,3 @@ with the following path and query parameters: |=== // endpoint options: END - -### See Also - -* link:configuring-camel.html[Configuring Camel] -* link:component.html[Component] -* link:endpoint.html[Endpoint] -* link:getting-started.html[Getting Started] http://git-wip-us.apache.org/repos/asf/camel/blob/4f81dc6e/components/camel-iec60870/src/main/java/org/apache/camel/component/iec60870/client/ClientEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-iec60870/src/main/java/org/apache/camel/component/iec60870/client/ClientEndpoint.java b/components/camel-iec60870/src/main/java/org/apache/camel/component/iec60870/client/ClientEndpoint.java index e554a4f..bf440ab 100644 --- a/components/camel-iec60870/src/main/java/org/apache/camel/component/iec60870/client/ClientEndpoint.java +++ b/components/camel-iec60870/src/main/java/org/apache/camel/component/iec60870/client/ClientEndpoint.java @@ -26,7 +26,12 @@ import org.apache.camel.component.iec60870.ObjectAddress; import org.apache.camel.impl.DefaultComponent; import org.apache.camel.spi.UriEndpoint; -@UriEndpoint(firstVersion = "2.20.0", scheme = "iec60870-client", syntax = "iec60870-client:endpointUri", title = "IEC 60870 Client", consumerClass = ClientConsumer.class, label = "iot") +/** + * IEC 60870 component used for telecontrol (supervisory control and data acquisition) + * such as controlling electric power transmission grids and other geographically widespread control systems. + */ +@UriEndpoint(firstVersion = "2.20.0", scheme = "iec60870-client", syntax = "iec60870-client:endpointUri", + title = "IEC 60870 Client", consumerClass = ClientConsumer.class, label = "iot") public class ClientEndpoint extends AbstractIecEndpoint<ClientConnectionMultiplexor> { public ClientEndpoint(final String uri, final DefaultComponent component, final ClientConnectionMultiplexor connection, final ObjectAddress address) { http://git-wip-us.apache.org/repos/asf/camel/blob/4f81dc6e/components/camel-iec60870/src/main/java/org/apache/camel/component/iec60870/server/ServerEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-iec60870/src/main/java/org/apache/camel/component/iec60870/server/ServerEndpoint.java b/components/camel-iec60870/src/main/java/org/apache/camel/component/iec60870/server/ServerEndpoint.java index ebee197..19681d3 100644 --- a/components/camel-iec60870/src/main/java/org/apache/camel/component/iec60870/server/ServerEndpoint.java +++ b/components/camel-iec60870/src/main/java/org/apache/camel/component/iec60870/server/ServerEndpoint.java @@ -27,7 +27,12 @@ import org.apache.camel.impl.DefaultComponent; import org.apache.camel.spi.UriEndpoint; import org.apache.camel.spi.UriParam; -@UriEndpoint(firstVersion = "2.20.0", scheme = "iec60870-server", syntax = "iec60870-server:endpointUri", title = "IEC 60870-5-104 server", consumerClass = ServerConsumer.class, label = "iot") +/** + * IEC 60870 component used for telecontrol (supervisory control and data acquisition) + * such as controlling electric power transmission grids and other geographically widespread control systems. + */ +@UriEndpoint(firstVersion = "2.20.0", scheme = "iec60870-server", syntax = "iec60870-server:endpointUri", + title = "IEC 60870-5-104 Server", consumerClass = ServerConsumer.class, label = "iot") public class ServerEndpoint extends AbstractIecEndpoint<ServerConnectionMultiplexor> { /** http://git-wip-us.apache.org/repos/asf/camel/blob/4f81dc6e/components/camel-iec60870/src/test/java/org/apache/camel/component/iec60870/testing/ExampleApplication1.java ---------------------------------------------------------------------- diff --git a/components/camel-iec60870/src/test/java/org/apache/camel/component/iec60870/testing/ExampleApplication1.java b/components/camel-iec60870/src/test/java/org/apache/camel/component/iec60870/testing/ExampleApplication1.java index 1d144fb..75a891f 100644 --- a/components/camel-iec60870/src/test/java/org/apache/camel/component/iec60870/testing/ExampleApplication1.java +++ b/components/camel-iec60870/src/test/java/org/apache/camel/component/iec60870/testing/ExampleApplication1.java @@ -21,6 +21,7 @@ import org.apache.camel.builder.RouteBuilder; import org.apache.camel.impl.DefaultCamelContext; public class ExampleApplication1 { + public static void main(final String[] args) throws Exception { new ExampleApplication1().run(); } http://git-wip-us.apache.org/repos/asf/camel/blob/4f81dc6e/platforms/spring-boot/components-starter/camel-iec60870-starter/src/main/java/org/apache/camel/component/iec60870/client/springboot/ClientComponentConfiguration.java ---------------------------------------------------------------------- diff --git a/platforms/spring-boot/components-starter/camel-iec60870-starter/src/main/java/org/apache/camel/component/iec60870/client/springboot/ClientComponentConfiguration.java b/platforms/spring-boot/components-starter/camel-iec60870-starter/src/main/java/org/apache/camel/component/iec60870/client/springboot/ClientComponentConfiguration.java index beaa2a9..273cec4 100644 --- a/platforms/spring-boot/components-starter/camel-iec60870-starter/src/main/java/org/apache/camel/component/iec60870/client/springboot/ClientComponentConfiguration.java +++ b/platforms/spring-boot/components-starter/camel-iec60870-starter/src/main/java/org/apache/camel/component/iec60870/client/springboot/ClientComponentConfiguration.java @@ -21,7 +21,9 @@ import org.apache.camel.spring.boot.ComponentConfigurationPropertiesCommon; import org.springframework.boot.context.properties.ConfigurationProperties; /** - * Camel IEC 60870-5-104 support + * IEC 60870 component used for telecontrol (supervisory control and data + * acquisition) such as controlling electric power transmission grids and other + * geographically widespread control systems. * * Generated by camel-package-maven-plugin - do not edit this file! */ http://git-wip-us.apache.org/repos/asf/camel/blob/4f81dc6e/platforms/spring-boot/components-starter/camel-iec60870-starter/src/main/java/org/apache/camel/component/iec60870/server/springboot/ServerComponentConfiguration.java ---------------------------------------------------------------------- diff --git a/platforms/spring-boot/components-starter/camel-iec60870-starter/src/main/java/org/apache/camel/component/iec60870/server/springboot/ServerComponentConfiguration.java b/platforms/spring-boot/components-starter/camel-iec60870-starter/src/main/java/org/apache/camel/component/iec60870/server/springboot/ServerComponentConfiguration.java index c58ac3f..c6dc3aa 100644 --- a/platforms/spring-boot/components-starter/camel-iec60870-starter/src/main/java/org/apache/camel/component/iec60870/server/springboot/ServerComponentConfiguration.java +++ b/platforms/spring-boot/components-starter/camel-iec60870-starter/src/main/java/org/apache/camel/component/iec60870/server/springboot/ServerComponentConfiguration.java @@ -21,7 +21,9 @@ import org.apache.camel.spring.boot.ComponentConfigurationPropertiesCommon; import org.springframework.boot.context.properties.ConfigurationProperties; /** - * Camel IEC 60870-5-104 support + * IEC 60870 component used for telecontrol (supervisory control and data + * acquisition) such as controlling electric power transmission grids and other + * geographically widespread control systems. * * Generated by camel-package-maven-plugin - do not edit this file! */
