Added KafkaChannelConfiguration configuration properties, clean doc g…

…eneration, removed index from javadoc

src/Configuration/OpenDDSManager.conf

@@ -0,0 +1,125 @@
+# Copy this file to test folder and set up according to your configuration.
+
+#
+# OpenDDS configuration
+#
+
+#Data Distribution Manager Global
+datadistributionmanager.common.protocol=opendds
+datadistributionmanager.common.protolib=DataDistributionManagerOpenDDS.dll
+datadistributionmanager.maxmessagesize=
+datadistributionmanager.timeout.serverlost=
+datadistributionmanager.loglevel.global=
+
+#Data Distribution Manager Channel Global
+datadistributionmanager.timeout.createchannel=
+datadistributionmanager.timeout.channelseek=
+datadistributionmanager.timeout.receive=
+datadistributionmanager.timeout.keepalive=
+datadistributionmanager.timeout.consumer=
+datadistributionmanager.timeout.producer=
+datadistributionmanager.timeout.commit=
+datadistributionmanager.commit.sync=true/false
+datadistributionmanager.event.sync=true/false
+
+#Data Distribution Manager OpenDDS Global
+
+datadistributionmanager.opendds.cmdlineargs=-DCPSConfigFile dds_tcp_conf.ini -DCPSTransportDebugLevel 10
+datadistributionmanager.opendds.domain_id=
+datadistributionmanager.opendds.dcps.debug_level=
+datadistributionmanager.opendds.dcpsinforepo.autostart=
+datadistributionmanager.opendds.dcpsinforepo.monitor=
+datadistributionmanager.opendds.dcpsinforepo.logonapplication=
+
+#Data Distribution Manager OpenDDS Global DomainParticipantQos
+datadistributionmanager.opendds.domainparticipantqos.userdataqospolicy.value=
+datadistributionmanager.opendds.domainparticipantqos.entityfactoryqospolicy.autoenable_created_entities=
+datadistributionmanager.opendds.domainparticipantqos.propertyqospolicy.value=
+
+#Data Distribution Manager OpenDDS Channel TopicQos
+datadistributionmanager.opendds.topicqos.topicdataqospolicy.value=
+datadistributionmanager.opendds.topicqos.durabilityqospolicy.kind=
+datadistributionmanager.opendds.topicqos.durabilityserviceqospolicy.service_cleanup_delay=
+datadistributionmanager.opendds.topicqos.durabilityserviceqospolicy.kind=
+datadistributionmanager.opendds.topicqos.durabilityserviceqospolicy.history_depth=
+datadistributionmanager.opendds.topicqos.durabilityserviceqospolicy.max_samples=
+datadistributionmanager.opendds.topicqos.durabilityserviceqospolicy.max_instances=
+datadistributionmanager.opendds.topicqos.durabilityserviceqospolicy.max_samples_per_instance=
+datadistributionmanager.opendds.topicqos.deadlineqospolicy.period=
+datadistributionmanager.opendds.topicqos.latencybudgetqospolicy.period=
+datadistributionmanager.opendds.topicqos.livelinessqospolicy.kind=
+datadistributionmanager.opendds.topicqos.livelinessqospolicy.lease_duration=
+datadistributionmanager.opendds.topicqos.reliabilityqospolicy.kind=
+datadistributionmanager.opendds.topicqos.reliabilityqospolicy.max_blocking_time=
+datadistributionmanager.opendds.topicqos.destinationorderqospolicy.kind=
+datadistributionmanager.opendds.topicqos.historyqospolicy.kind=
+datadistributionmanager.opendds.topicqos.historyqospolicy.depth=
+datadistributionmanager.opendds.topicqos.resourcelimitsqospolicy.max_instances=
+datadistributionmanager.opendds.topicqos.resourcelimitsqospolicy.max_samples=
+datadistributionmanager.opendds.topicqos.resourcelimitsqospolicy.depth=
+datadistributionmanager.opendds.topicqos.transportpriorityqospolicy.value=
+datadistributionmanager.opendds.topicqos.lifespanqospolicy.duration=
+datadistributionmanager.opendds.topicqos.ownershipqospolicy.kind=
+
+#Data Distribution Manager OpenDDS Channel PublisherQos
+datadistributionmanager.opendds.publisherqos.presentationqospolicy.access_scope=
+datadistributionmanager.opendds.publisherqos.presentationqospolicy.coherent_access=
+datadistributionmanager.opendds.publisherqos.presentationqospolicy.ordered_access=
+datadistributionmanager.opendds.publisherqos.partitionqospolicy.name=
+datadistributionmanager.opendds.publisherqos.groupdataqospolicy.value=
+datadistributionmanager.opendds.publisherqos.entityfactoryqospolicy.autoenable_created_entities=
+
+#Data Distribution Manager OpenDDS Channel SubscriberQos
+datadistributionmanager.opendds.subscriberqos.presentationqospolicy.access_scope=
+datadistributionmanager.opendds.subscriberqos.presentationqospolicy.coherent_access=
+datadistributionmanager.opendds.subscriberqos.presentationqospolicy.ordered_access=
+datadistributionmanager.opendds.subscriberqos.partitionqospolicy.name=
+datadistributionmanager.opendds.subscriberqos.groupdataqospolicy.value=
+datadistributionmanager.opendds.subscriberqos.entityfactoryqospolicy.autoenable_created_entities=
+
+#Data Distribution Manager OpenDDS Channel DataWriterQos
+datadistributionmanager.opendds.datawriterqos.durabilityqospolicy.kind=
+datadistributionmanager.opendds.datawriterqos.durabilityserviceqospolicy.service_cleanup_delay=
+datadistributionmanager.opendds.datawriterqos.durabilityserviceqospolicy.kind=
+datadistributionmanager.opendds.datawriterqos.durabilityserviceqospolicy.history_depth=
+datadistributionmanager.opendds.datawriterqos.durabilityserviceqospolicy.max_samples=
+datadistributionmanager.opendds.datawriterqos.durabilityserviceqospolicy.max_instances=
+datadistributionmanager.opendds.datawriterqos.durabilityserviceqospolicy.max_samples_per_instance=
+datadistributionmanager.opendds.datawriterqos.deadlineqospolicy.period=
+datadistributionmanager.opendds.datawriterqos.latencybudgetqospolicy.period=
+datadistributionmanager.opendds.datawriterqos.livelinessqospolicy.kind=
+datadistributionmanager.opendds.datawriterqos.livelinessqospolicy.lease_duration=
+datadistributionmanager.opendds.datawriterqos.reliabilityqospolicy.kind=
+datadistributionmanager.opendds.datawriterqos.reliabilityqospolicy.max_blocking_time=
+datadistributionmanager.opendds.datawriterqos.destinationorderqospolicy.kind=
+datadistributionmanager.opendds.datawriterqos.historyqospolicy.kind=
+datadistributionmanager.opendds.datawriterqos.historyqospolicy.depth=
+datadistributionmanager.opendds.datawriterqos.resourcelimitsqospolicy.max_instances=
+datadistributionmanager.opendds.datawriterqos.resourcelimitsqospolicy.max_samples=
+datadistributionmanager.opendds.datawriterqos.resourcelimitsqospolicy.depth=
+datadistributionmanager.opendds.datawriterqos.transportpriorityqospolicy.value=
+datadistributionmanager.opendds.datawriterqos.lifespanqospolicy.duration=
+datadistributionmanager.opendds.datawriterqos.userdataqospolicy.value=
+datadistributionmanager.opendds.datawriterqos.ownershipqospolicy.kind=
+datadistributionmanager.opendds.datawriterqos.ownershipstrengthqospolicy.value=
+datadistributionmanager.opendds.datawriterqos.writerdatalifecycleqospolicy.autodispose_unregistered_instances=
+
+#Data Distribution Manager OpenDDS Channel DataReaderQos
+datadistributionmanager.opendds.datareaderqos.durabilityqospolicy.kind=
+datadistributionmanager.opendds.datareaderqos.deadlineqospolicy.period=
+datadistributionmanager.opendds.datareaderqos.latencybudgetqospolicy.period=
+datadistributionmanager.opendds.datareaderqos.livelinessqospolicy.kind=
+datadistributionmanager.opendds.datareaderqos.livelinessqospolicy.lease_duration=
+datadistributionmanager.opendds.datareaderqos.reliabilityqospolicy.kind=
+datadistributionmanager.opendds.datareaderqos.reliabilityqospolicy.max_blocking_time=
+datadistributionmanager.opendds.datareaderqos.destinationorderqospolicy.kind=
+datadistributionmanager.opendds.datareaderqos.historyqospolicy.kind=
+datadistributionmanager.opendds.datareaderqos.historyqospolicy.depth=
+datadistributionmanager.opendds.datareaderqos.resourcelimitsqospolicy.max_instances=
+datadistributionmanager.opendds.datareaderqos.resourcelimitsqospolicy.max_samples=
+datadistributionmanager.opendds.datareaderqos.resourcelimitsqospolicy.max_samples_per_instance=
+datadistributionmanager.opendds.datareaderqos.userdataqospolicy.value=
+datadistributionmanager.opendds.datareaderqos.ownershipqospolicy.kind=
+datadistributionmanager.opendds.datareaderqos.timebasedfilterqospolicy.minimum_separation=
+datadistributionmanager.opendds.datareaderqos.readerdatalifecycleqospolicy.autopurge_nowriter_samples_delay=
+datadistributionmanager.opendds.datareaderqos.readerdatalifecycleqospolicy.autopurge_disposed_samples_delay=

src/DataDistributionManagerJava/CreateJar.bat

@@ -9,7 +9,7 @@ mkdir javadoc
 "%JDK_ROOT_FOLDER%\bin\javac.exe" -Xlint:deprecation --source 8 --target 8 -d ./Output ./src/org/mases/datadistributionmanager/*.java ./src/org/mases/datadistributionmanager/configuration/*.java
 IF %ERRORLEVEL% NEQ 0 GOTO ERROR
 @echo javac END
-"%JDK_ROOT_FOLDER%\bin\javadoc.exe" --source 8 -notimestamp -quiet -author -public -d ./javadoc -link https://docs.oracle.com/javase/8/docs/api/ ./src/org/mases/datadistributionmanager/*.java ./src/org/mases/datadistributionmanager/configuration/*.java
+"%JDK_ROOT_FOLDER%\bin\javadoc.exe" --source 8 -notimestamp -noindex -quiet -author -public -d ./javadoc -link https://docs.oracle.com/javase/8/docs/api/ ./src/org/mases/datadistributionmanager/*.java ./src/org/mases/datadistributionmanager/configuration/*.java
 IF %ERRORLEVEL% NEQ 0 GOTO ERROR
 @echo javadoc END
 

src/DataDistributionManagerJava/src/org/mases/datadistributionmanager/IConfiguration.java

@@ -26,6 +26,8 @@ public interface IConfiguration {
      * The configuration parameters to use written as key=value
      * 
      * @return an array of {@link String} with key=value pairs
+     * 
+     * @throws IllegalArgumentException if something was not right or compatible in the configuration properties
      */
     String[] getConfiguration() throws IllegalArgumentException;
 }

src/DataDistributionManagerJava/src/org/mases/datadistributionmanager/SmartDataDistribution.java

@@ -199,9 +199,8 @@ public SmartDataDistribution() {
      * 
      * @param conf_file Configuration file to use
      * @return {@link HRESULT}
-     * @throws IllegalArgumentException
      */
-    public HRESULT Initialize(String conf_file) throws IllegalArgumentException {
+    public HRESULT Initialize(String conf_file) {
         return Initialize(conf_file, null, null);
     }
 
@@ -211,9 +210,8 @@ public HRESULT Initialize(String conf_file) throws IllegalArgumentException {
      * @param conf_file    Configuration file to use
      * @param topicTrailer Trailer string to append on channel names
      * @return {@link HRESULT}
-     * @throws IllegalArgumentException
      */
-    public HRESULT Initialize(String conf_file, String topicTrailer) throws IllegalArgumentException {
+    public HRESULT Initialize(String conf_file, String topicTrailer) {
         return Initialize(conf_file, null, topicTrailer);
     }
 
@@ -246,7 +244,7 @@ public HRESULT Initialize(String conf_file, String szMyAddress, String topicTrai
      * @param configuration The configuration coming from an instance of
      *                      {@link IConfiguration}
      * @return {@link HRESULT}
-     * @throws IllegalArgumentException
+     * @throws IllegalArgumentException @see {@link IConfiguration} 
      */
     public HRESULT Initialize(IConfiguration configuration) throws IllegalArgumentException {
         return Initialize(configuration.getConfiguration(), null, null);
@@ -259,7 +257,7 @@ public HRESULT Initialize(IConfiguration configuration) throws IllegalArgumentEx
      *                      {@link IConfiguration}
      * @param topicTrailer  Trailer string to append on channel names
      * @return {@link HRESULT}
-     * @throws IllegalArgumentException
+     * @throws IllegalArgumentException @see {@link IConfiguration} 
      */
     public HRESULT Initialize(IConfiguration configuration, String topicTrailer) throws IllegalArgumentException {
         return Initialize(configuration.getConfiguration(), null, topicTrailer);
@@ -273,7 +271,7 @@ public HRESULT Initialize(IConfiguration configuration, String topicTrailer) thr
      * @param szMyAddress   The name of the server hosting the process
      * @param topicTrailer  Trailer string to append on channel names
      * @return {@link HRESULT}
-     * @throws IllegalArgumentException
+     * @throws IllegalArgumentException @see {@link IConfiguration} 
      */
     public HRESULT Initialize(IConfiguration configuration, String szMyAddress, String topicTrailer)
             throws IllegalArgumentException {
@@ -285,9 +283,8 @@ public HRESULT Initialize(IConfiguration configuration, String szMyAddress, Stri
      * 
      * @param arrayParams array of key=value parameters
      * @return {@link HRESULT}
-     * @throws IllegalArgumentException
      */
-    public HRESULT Initialize(String[] arrayParams) throws IllegalArgumentException {
+    public HRESULT Initialize(String[] arrayParams) {
         return Initialize(arrayParams, null, null);
     }
 
@@ -297,9 +294,8 @@ public HRESULT Initialize(String[] arrayParams) throws IllegalArgumentException
      * @param arrayParams  array of key=value parameters
      * @param topicTrailer Trailer string to append on channel names
      * @return {@link HRESULT}
-     * @throws IllegalArgumentException
      */
-    public HRESULT Initialize(String[] arrayParams, String topicTrailer) throws IllegalArgumentException {
+    public HRESULT Initialize(String[] arrayParams, String topicTrailer) {
         return Initialize(arrayParams, null, topicTrailer);
     }
 
@@ -472,7 +468,7 @@ public String GetParameter(DDM_GENERAL_PARAMETER paramId) {
      * @param clazz       The class to be instantiated
      * @param channelName The channel name
      * @return The allocated instance
-     * @throws Throwable
+     * @throws Throwable generic exception for all errors (if subsystem was unable to create a channel the exception is a generic {@link Exception})
      */
     public <T extends SmartDataDistributionChannel> T CreateSmartChannel(Class<T> clazz, String channelName)
             throws Throwable {
@@ -487,7 +483,7 @@ public <T extends SmartDataDistributionChannel> T CreateSmartChannel(Class<T> cl
      * @param configuration The configuration coming from an instance of
      *                      {@link IConfiguration}
      * @return The allocated instance
-     * @throws Throwable
+     * @throws Throwable generic exception for all errors (if subsystem was unable to create a channel the exception is a generic {@link Exception})
      */
     public <T extends SmartDataDistributionChannel> T CreateSmartChannel(Class<T> clazz, String channelName,
             IConfiguration configuration) throws Throwable {
@@ -503,7 +499,7 @@ public <T extends SmartDataDistributionChannel> T CreateSmartChannel(Class<T> cl
      * @param configuration The configuration coming from an instance of
      *                      {@link IConfiguration}
      * @return The allocated instance
-     * @throws Throwable
+     * @throws Throwable generic exception for all errors (if subsystem was unable to create a channel the exception is a generic {@link Exception})
      */
     public <T extends SmartDataDistributionChannel> T CreateSmartChannel(Class<T> clazz, String channelName,
             IConfiguration configuration, DDM_CHANNEL_DIRECTION direction) throws Throwable {
@@ -519,7 +515,7 @@ public <T extends SmartDataDistributionChannel> T CreateSmartChannel(Class<T> cl
      * @param direction   The {@link DDM_CHANNEL_DIRECTION} of the channel
      * @param arrayParams Specific parameters which override main parameters
      * @return The allocated instance
-     * @throws Throwable
+     * @throws Throwable generic exception for all errors (if subsystem was unable to create a channel the exception is a generic {@link Exception})
      */
     @SuppressWarnings("unchecked")
     public <T extends SmartDataDistributionChannel> T CreateSmartChannel(Class<T> clazz, String channelName,