Issue #318: add missing javadoc

Signed-off-by: Florian Fendt <Florian.Fendt@bosch-si.com>

services/connectivity/messaging/src/main/java/org/eclipse/ditto/services/connectivity/messaging/BaseClientActor.java

@@ -844,6 +844,8 @@ private CompletionStage<Status.Status> testMessageMappingProcessor(@Nullable fin
     /**
      * Starts the {@link MessageMappingProcessorActor} responsible for payload transformation/mapping as child actor
      * behind a (cluster node local) RoundRobin pool and a dynamic resizer from the current mapping context.
+     * @return {@link org.eclipse.ditto.services.connectivity.messaging.MessageMappingProcessorActor} or exception, which will
+     * also cause an sideeffect that stores the mapping actor in the local variable {@code messageMappingProcessorActor}.
      */
     protected Either<DittoRuntimeException, ActorRef> startMessageMappingProcessor() {
         final MappingContext mappingContext = stateData().getConnection().getMappingContext().orElse(null);
@@ -855,6 +857,8 @@ protected Either<DittoRuntimeException, ActorRef> startMessageMappingProcessor()
      * behind a (cluster node local) RoundRobin pool and a dynamic resizer.
      *
      * @param mappingContext the MappingContext containing information about how to map external messages
+     * @return {@link org.eclipse.ditto.services.connectivity.messaging.MessageMappingProcessorActor} or exception, which will
+     * also cause an sideeffect that stores the mapping actor in the local variable {@code messageMappingProcessorActor}.
      */
     protected Either<DittoRuntimeException, ActorRef> startMessageMappingProcessor(
             @Nullable final MappingContext mappingContext) {

services/connectivity/messaging/src/main/java/org/eclipse/ditto/services/connectivity/messaging/MessageMappingProcessor.java

@@ -73,6 +73,7 @@ private MessageMappingProcessor(final String connectionId, final MessageMapperRe
      * Initializes a new command processor with mappers defined in mapping mappingContext. The dynamic access is needed
      * to instantiate message mappers for an actor system
      *
+     * @param connectionId the connection that the processor works for.
      * @param mappingContext the mapping Context
      * @param actorSystem the dynamic access used for message mapper instantiation
      * @param log the log adapter

services/connectivity/messaging/src/main/java/org/eclipse/ditto/services/connectivity/messaging/internal/SSLContextCreator.java

@@ -93,6 +93,7 @@ private SSLContextCreator(final Either<TrustManager, String> trust,
     /**
      * Create an SSL context creator with a preconfigured trust manager.
      *
+     * @param trustManager the trust manager.
      * @param dittoHeaders headers to write in Ditto runtime exceptions; {@code null} to write empty headers.
      * @return the SSL context creator.
      */

services/connectivity/messaging/src/main/java/org/eclipse/ditto/services/connectivity/messaging/kafka/KafkaClientActor.java

@@ -68,6 +68,7 @@ private KafkaClientActor(final Connection connection,
      *
      * @param connection the connection.
      * @param conciergeForwarder the actor used to send signals to the concierge service.
+     * @param factory factory for creating a kafka publisher actor.
      * @return the Akka configuration Props object.
      */
     public static Props props(final Connection connection, final ActorRef conciergeForwarder,

services/connectivity/messaging/src/main/java/org/eclipse/ditto/services/connectivity/messaging/kafka/KafkaConnectionFactory.java

@@ -34,6 +34,7 @@ public interface KafkaConnectionFactory {
     /**
      * Create an Akka stream flow of Kafka messages.
      *
+     * @param <T> type of the pass through object.
      * @return Akka stream flow that publishes Kafka messages to the broker.
      */
     <T> Flow<ProducerMessage.Envelope<String, String, T>, ProducerMessage.Results<String, String, T>, NotUsed> newFlow();

services/connectivity/messaging/src/main/java/org/eclipse/ditto/services/connectivity/messaging/kafka/KafkaSpecificConfig.java

@@ -32,6 +32,7 @@ public interface KafkaSpecificConfig {
     /**
      * Validates the given connection against the config. Assumes that the connection {@code isApplicable}.
      * @param connection the connection to validate.
+     * @param dittoHeaders headers that were sent with the connection.
      * @throws org.eclipse.ditto.model.connectivity.ConnectionConfigurationInvalidException if the configuration is invalid.
      */
     void validateOrThrow(Connection connection, DittoHeaders dittoHeaders);

services/connectivity/messaging/src/main/java/org/eclipse/ditto/services/connectivity/messaging/monitoring/logs/DefaultEvictingQueue.java

@@ -20,6 +20,7 @@
 import java.util.Queue;
 
 import javax.annotation.Nullable;
+import javax.annotation.concurrent.NotThreadSafe;
 
 /**
  * Default implementation of {@link org.eclipse.ditto.services.connectivity.messaging.monitoring.logs.EvictingQueue}.
@@ -28,6 +29,7 @@
  *
  * @param <E> type of elements in the queue.
  */
+@NotThreadSafe
 final class DefaultEvictingQueue<E> extends AbstractQueue<E> implements EvictingQueue<E> {
 
     private final int capacity;