Fix about 90 javadoc warnings

server/appenders/file-appender/src/main/java/org/kaaproject/kaa/server/appenders/file/appender/FileSystemLogEventService.java

@@ -35,7 +35,7 @@ public interface FileSystemLogEventService {
    * Create log user and log group and give them permissions to access
    * logs of application with specific id.
    *
-   * @param applicationId the application id
+   * @param appender      the appender
    * @param config        the File log appender config
    * @param path          the path to logs directory
    */

server/appenders/flume-appender/src/main/java/org/kaaproject/kaa/server/appenders/flume/appender/client/BalancingFlumeClientManager.java

@@ -88,7 +88,8 @@ private Properties generateProperties(FlumeNodes parameters) {
   }
 
   @Override
-  public ListenableFuture<AppendAsyncResultPojo> sendEventToFlumeAsync(Event event) throws EventDeliveryException {
+  public ListenableFuture<AppendAsyncResultPojo> sendEventToFlumeAsync(Event event)
+          throws EventDeliveryException {
     return currentClient.appendAsync(event);
   }
 

server/appenders/flume-appender/src/main/java/org/kaaproject/kaa/server/appenders/flume/appender/client/FlumeClientManager.java

@@ -42,6 +42,13 @@ public abstract class FlumeClientManager<T> {
   private static final Logger LOG = LoggerFactory.getLogger(FlumeClientManager.class);
   protected AsyncRpcClient currentClient = null;
 
+  /**
+   * Create new instance of <code>FlumeClientManager</code>.
+   *
+   * @param configuration is configuration of new instance <code>FlumeClientManager</code>
+   * @param <T> type of <code>FlumeClientManager</code> parameters
+   * @return new instance of <code>FlumeClientManager</code>
+   */
   @SuppressWarnings("unchecked")
   public static <T> FlumeClientManager<T> getInstance(FlumeConfig configuration) {
     FlumeClientManager<?> clientManager = null;
@@ -75,9 +82,15 @@ public static <T> FlumeClientManager<T> getInstance(FlumeConfig configuration) {
   public abstract ListenableFuture<AppendAsyncResultPojo> sendEventToFlumeAsync(Event event)
       throws EventDeliveryException;
 
-  public abstract ListenableFuture<AppendBatchAsyncResultPojo> sendEventsToFlumeAsync(List<Event> events)
+  public abstract ListenableFuture<AppendBatchAsyncResultPojo>
+      sendEventsToFlumeAsync(List<Event> events)
       throws EventDeliveryException;
 
+  /**
+   * Initialized current client using parameters.
+   *
+   * @param parameters is parameters of client
+   */
   public void init(T parameters) {
     if (parameters != null) {
       currentClient = initManager(parameters);
@@ -90,6 +103,12 @@ public void init(T parameters) {
     }
   }
 
+  /**
+   * Initialized current client using parameters.
+   *
+   * @param parameters is parameters of client
+   * @param clientThreadPoolSize is amount of client thread pool
+   */
   public void init(T parameters, int clientThreadPoolSize) {
     if (parameters != null) {
       currentClient = initManager(parameters, clientThreadPoolSize);
@@ -102,6 +121,9 @@ public void init(T parameters, int clientThreadPoolSize) {
     }
   }
 
+  /**
+   * Immediately closes the client and field <code>currentClient</code> assign on null.
+   */
   public void cleanUp() {
     LOG.debug("Close flume rpc client.");
     if (currentClient != null) {

server/appenders/flume-appender/src/main/java/org/kaaproject/kaa/server/appenders/flume/appender/client/async/AppendAsyncResultPojo.java

@@ -22,6 +22,12 @@ public class AppendAsyncResultPojo {
   public boolean isSuccessful;
   public Event event;
 
+  /**
+   * Create new instance of <code>AppendBatchAsyncResultPojo</code>.
+   *
+   * @param isSuccessful is represent successful or not the result
+   * @param event        the event
+   */
   public AppendAsyncResultPojo(boolean isSuccessful, Event event) {
     super();
     this.isSuccessful = isSuccessful;

server/appenders/flume-appender/src/main/java/org/kaaproject/kaa/server/appenders/flume/appender/client/async/AppendBatchAsyncResultPojo.java

@@ -24,6 +24,12 @@ public class AppendBatchAsyncResultPojo {
   public boolean isSuccessful;
   public List<Event> events;
 
+  /**
+   * Create new instance of <code>AppendBatchAsyncResultPojo</code>.
+   *
+   * @param isSuccessful is represent successful or not the result
+   * @param events       is <code>List</code> of events
+   */
   public AppendBatchAsyncResultPojo(boolean isSuccessful, List<Event> events) {
     super();
     this.isSuccessful = isSuccessful;

server/appenders/flume-appender/src/main/java/org/kaaproject/kaa/server/appenders/flume/appender/client/async/AsyncRpcClient.java

@@ -25,7 +25,8 @@
 import java.util.List;
 
 public interface AsyncRpcClient extends RpcClient {
-  public ListenableFuture<AppendAsyncResultPojo> appendAsync(Event event) throws EventDeliveryException;
+  public ListenableFuture<AppendAsyncResultPojo> appendAsync(Event event)
+          throws EventDeliveryException;
 
   public ListenableFuture<AppendBatchAsyncResultPojo> appendBatchAsync(List<Event> events)
       throws EventDeliveryException;

server/appenders/flume-appender/src/main/java/org/kaaproject/kaa/server/appenders/flume/appender/client/async/AvroAsyncRpcClient.java

@@ -41,6 +41,12 @@ public class AvroAsyncRpcClient implements AsyncRpcClient {
   ArrayBlockingQueue<RpcClient> clientQueue;
   ListeningExecutorService executorService;
 
+  /**
+   * Create new instance of <code>AvroAsyncRpcClient</code>.
+   *
+   * @param starterProp the properties of starter
+   * @param numberOfClientThreads is number of client's threads
+   */
   public AvroAsyncRpcClient(Properties starterProp, int numberOfClientThreads) {
     clientQueue = new ArrayBlockingQueue<RpcClient>(numberOfClientThreads);
 
@@ -54,6 +60,13 @@ public AvroAsyncRpcClient(Properties starterProp, int numberOfClientThreads) {
         .listeningDecorator(Executors.newFixedThreadPool(numberOfClientThreads));
   }
 
+  /**
+   * Create new instance of <code>AvroAsyncRpcClient</code>.
+   *
+   * @param hostname        the RPC hostname, use it to create RPC client
+   * @param port            the RPC port, use it to create RPC client
+   * @param numberOfThreads is number of client's threads
+   */
   public AvroAsyncRpcClient(String hostname, Integer port, int numberOfThreads) {
     int numberOfClientThreads = numberOfThreads;
 
@@ -69,6 +82,12 @@ public AvroAsyncRpcClient(String hostname, Integer port, int numberOfThreads) {
         .listeningDecorator(Executors.newFixedThreadPool(numberOfClientThreads));
   }
 
+  /**
+   * Async append event to RPC client, return listenable future.
+   *
+   * @param event to adding by RPC
+   * @return listenable future
+   */
   public ListenableFuture<AppendAsyncResultPojo> appendAsync(final Event event)
       throws EventDeliveryException {
     ListenableFuture<AppendAsyncResultPojo> future = executorService.submit(
@@ -83,6 +102,12 @@ public AppendAsyncResultPojo call() throws Exception {
     return future;
   }
 
+  /**
+   * Async append some events to RPC client, return listenable future.
+   *
+   * @param events to adding by RPC
+   * @return listenable future
+   */
   public ListenableFuture<AppendBatchAsyncResultPojo> appendBatchAsync(final List<Event> events)
       throws EventDeliveryException {
     ListenableFuture<AppendBatchAsyncResultPojo> future = executorService

server/appenders/mongo-appender/src/main/java/org/kaaproject/kaa/server/appenders/mongo/appender/LogEvent.java

@@ -17,15 +17,12 @@
 package org.kaaproject.kaa.server.appenders.mongo.appender;
 
 import static com.mongodb.util.JSON.parse;
-import static org.kaaproject.kaa.server.common.nosql.mongo.dao.model.MongoDaoUtil.decodeReservedCharacteres;
 import static org.kaaproject.kaa.server.common.nosql.mongo.dao.model.MongoDaoUtil.encodeReservedCharacteres;
 
 import com.mongodb.DBObject;
-import com.mongodb.util.JSON;
 
 import org.kaaproject.kaa.common.dto.logs.LogEventDto;
 import org.kaaproject.kaa.server.common.log.shared.appender.data.ProfileInfo;
-import org.kaaproject.kaa.server.common.nosql.mongo.dao.model.MongoDaoUtil;
 import org.springframework.data.annotation.Id;
 import org.springframework.data.mongodb.core.mapping.Document;
 
@@ -47,6 +44,14 @@ public LogEvent() {
 
   }
 
+  /**
+   * Create new instance of <code>LogEvent</code>.
+   *
+   * @param dto           data transfer object, that contain id, header and event. use these data to
+   *                      assign on appropriate field
+   * @param clientProfile the client profile info
+   * @param serverProfile the server profile info
+   */
   public LogEvent(LogEventDto dto, ProfileInfo clientProfile, ProfileInfo serverProfile) {
     this.id = dto.getId();
     this.header = encodeReservedCharacteres((DBObject) parse(dto.getHeader()));

server/appenders/mongo-appender/src/main/java/org/kaaproject/kaa/server/appenders/mongo/appender/LogEventDao.java

@@ -25,7 +25,8 @@ public interface LogEventDao {
 
   void createCollection(String collectionName);
 
-  List<LogEvent> save(List<LogEventDto> logEventDtos, ProfileInfo clientProfile, ProfileInfo serverProfile, String collectionName);
+  List<LogEvent> save(List<LogEventDto> logEventDtos, ProfileInfo clientProfile,
+                      ProfileInfo serverProfile, String collectionName);
 
   void removeAll(String collectionName);
 

server/appenders/mongo-appender/src/main/java/org/kaaproject/kaa/server/appenders/mongo/appender/LogEventMongoDao.java

@@ -47,6 +47,13 @@ public class LogEventMongoDao implements LogEventDao {
   private MongoClient mongoClient;
   private MongoTemplate mongoTemplate;
 
+  /**
+   * Create new instance of <code>LogEventMongoDao</code> using configuration instance of
+   * <code>MongoDbConfig</code>.
+   *
+   * @param configuration the configuration of log event mongo dao, it contain server size,
+   *                      credentials, max wait time, etc.
+   */
   @SuppressWarnings("deprecation")
   public LogEventMongoDao(MongoDbConfig configuration) throws Exception {
 

server/common/admin-rest-client/src/main/java/org/kaaproject/kaa/server/common/admin/AdminClient.java

@@ -58,7 +58,7 @@
 import org.kaaproject.kaa.common.dto.credentials.CredentialsStatus;
 import org.kaaproject.kaa.common.dto.ctl.CTLSchemaDto;
 import org.kaaproject.kaa.common.dto.ctl.CTLSchemaExportMethod;
-import org.kaaproject.kaa.common.dto.ctl.CTLSchemaMetaInfoDto;
+import org.kaaproject.kaa.common.dto.ctl.CtlSchemaMetaInfoDto;
 import org.kaaproject.kaa.common.dto.event.AefMapInfoDto;
 import org.kaaproject.kaa.common.dto.event.ApplicationEventFamilyMapDto;
 import org.kaaproject.kaa.common.dto.event.EcfInfoDto;
@@ -97,7 +97,6 @@
 import java.io.InputStream;
 import java.io.OutputStream;
 import java.util.ArrayList;
-import java.util.Arrays;
 import java.util.List;
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
@@ -1042,39 +1041,39 @@ public boolean checkFqnExistsWithAppToken(String fqn, String tenantId,
     }
   }
 
-  public CTLSchemaMetaInfoDto promoteScopeToTenant(String applicationId, String fqn) {
+  public CtlSchemaMetaInfoDto promoteScopeToTenant(String applicationId, String fqn) {
     MultiValueMap<String, Object> params = new LinkedMultiValueMap<>();
     params.add("applicationId", applicationId);
     params.add("fqn", fqn);
     return restTemplate.postForObject(restTemplate.getUrl() + "CTL/promoteScopeToTenant",
-        params, CTLSchemaMetaInfoDto.class);
+        params, CtlSchemaMetaInfoDto.class);
   }
 
   //CHECKSTYLE:OFF
-  public List<CTLSchemaMetaInfoDto> getSystemLevelCTLSchemas() {
+  public List<CtlSchemaMetaInfoDto> getSystemLevelCTLSchemas() {
     //CHECKSTYLE:ON
-    ResponseEntity<List<CTLSchemaMetaInfoDto>> entity = restTemplate.exchange(
+    ResponseEntity<List<CtlSchemaMetaInfoDto>> entity = restTemplate.exchange(
         restTemplate.getUrl() + "CTL/getSystemSchemas",
-        HttpMethod.GET, null, new ParameterizedTypeReference<List<CTLSchemaMetaInfoDto>>() {});
+        HttpMethod.GET, null, new ParameterizedTypeReference<List<CtlSchemaMetaInfoDto>>() {});
     return entity.getBody();
   }
 
   //CHECKSTYLE:OFF
-  public List<CTLSchemaMetaInfoDto> getTenantLevelCTLSchemas() {
+  public List<CtlSchemaMetaInfoDto> getTenantLevelCTLSchemas() {
     //CHECKSTYLE:ON
-    ResponseEntity<List<CTLSchemaMetaInfoDto>> entity = restTemplate.exchange(
+    ResponseEntity<List<CtlSchemaMetaInfoDto>> entity = restTemplate.exchange(
         restTemplate.getUrl() + "CTL/getTenantSchemas",
-        HttpMethod.GET, null,  new ParameterizedTypeReference<List<CTLSchemaMetaInfoDto>>() {});
+        HttpMethod.GET, null,  new ParameterizedTypeReference<List<CtlSchemaMetaInfoDto>>() {});
     return entity.getBody();
   }
 
   //CHECKSTYLE:OFF
-  public List<CTLSchemaMetaInfoDto> getApplicationLevelCTLSchemasByAppToken(
+  public List<CtlSchemaMetaInfoDto> getApplicationLevelCTLSchemasByAppToken(
       String applicationToken) {
     //CHECKSTYLE:ON
-    ResponseEntity<List<CTLSchemaMetaInfoDto>> entity = restTemplate.exchange(
+    ResponseEntity<List<CtlSchemaMetaInfoDto>> entity = restTemplate.exchange(
         restTemplate.getUrl() + "CTL/getApplicationSchemas/" + applicationToken,
-        HttpMethod.GET, null,  new ParameterizedTypeReference<List<CTLSchemaMetaInfoDto>>() {});
+        HttpMethod.GET, null,  new ParameterizedTypeReference<List<CtlSchemaMetaInfoDto>>() {});
     return entity.getBody();
   }
 

server/common/admin-rest-client/src/main/java/org/kaaproject/kaa/server/common/admin/HttpComponentsRequestFactoryBasicAuth.java

@@ -53,6 +53,11 @@ public class HttpComponentsRequestFactoryBasicAuth extends HttpComponentsClientH
   private HttpHost host;
   private CredentialsProvider credsProvider;
 
+  /**
+   * Create new instance of <code>HttpComponentsRequestFactoryBasicAuth</code>.
+   *
+   * @param host the http host
+   */
   public HttpComponentsRequestFactoryBasicAuth(HttpHost host) {
     super(createHttpClient());
     this.host = host;
@@ -89,6 +94,12 @@ public CredentialsProvider getCredentialsProvider() {
     return credsProvider;
   }
 
+  /**
+   * Set credentials to field <code>credsProvider</code>.
+   *
+   * @param username the username, part of credentials
+   * @param password the password, part of credentials
+   */
   public void setCredentials(String username, String password) {
     credsProvider.setCredentials(
         new AuthScope(host.getHostName(), host.getPort(), AuthScope.ANY_REALM),

server/common/dao/src/main/java/org/kaaproject/kaa/server/common/dao/CtlService.java

@@ -18,7 +18,7 @@
 
 import org.apache.avro.Schema;
 import org.kaaproject.kaa.common.dto.ctl.CTLSchemaDto;
-import org.kaaproject.kaa.common.dto.ctl.CTLSchemaMetaInfoDto;
+import org.kaaproject.kaa.common.dto.ctl.CtlSchemaMetaInfoDto;
 import org.kaaproject.kaa.common.dto.file.FileData;
 
 import java.util.List;
@@ -52,9 +52,9 @@ public interface CtlService {
    * Update existing CTL schema meta info scope by the given CTL schema meta info object.
    *
    * @param ctlSchemaMetaInfo the CTL schema meta info object.
-   * @return CTLSchemaMetaInfoDto the updated CTL schema meta info object.
+   * @return CtlSchemaMetaInfoDto the updated CTL schema meta info object.
    */
-  CTLSchemaMetaInfoDto updateCtlSchemaMetaInfoScope(CTLSchemaMetaInfoDto ctlSchemaMetaInfo);
+  CtlSchemaMetaInfoDto updateCtlSchemaMetaInfoScope(CtlSchemaMetaInfoDto ctlSchemaMetaInfo);
 
   /**
    * Find CTL schema meta infos which are the application level siblings to the CTL
@@ -65,7 +65,7 @@ public interface CtlService {
    * @param applicationId the application identifier.
    * @return the CTL schema meta information objects which are the siblings to the given CTL.
    */
-  List<CTLSchemaMetaInfoDto> findSiblingsByFqnTenantIdAndApplicationId(
+  List<CtlSchemaMetaInfoDto> findSiblingsByFqnTenantIdAndApplicationId(
           String fqn, String tenantId, String applicationId);
 
   /**
@@ -143,7 +143,7 @@ CTLSchemaDto findAnyCtlSchemaByFqnAndVerAndTenantIdAndApplicationId(
    *
    * @return the list of available system CTL schemas meta info in the database.
    */
-  List<CTLSchemaMetaInfoDto> findSystemCtlSchemasMetaInfo();
+  List<CtlSchemaMetaInfoDto> findSystemCtlSchemasMetaInfo();
 
   /**
    * Find available CTL schemas meta info for tenant(include
@@ -152,7 +152,7 @@ CTLSchemaDto findAnyCtlSchemaByFqnAndVerAndTenantIdAndApplicationId(
    * @param tenantId the tenant identifier.
    * @return the list of available CTL schemas meta info for tenant with given identifier.
    */
-  List<CTLSchemaMetaInfoDto> findAvailableCtlSchemasMetaInfoForTenant(String tenantId);
+  List<CtlSchemaMetaInfoDto> findAvailableCtlSchemasMetaInfoForTenant(String tenantId);
 
   /**
    * Find available CTL schemas meta info for application(include
@@ -162,7 +162,7 @@ CTLSchemaDto findAnyCtlSchemaByFqnAndVerAndTenantIdAndApplicationId(
    * @param applicationId the application identifier.
    * @return the list of available CTL schemas meta info for application with given identifier.
    */
-  List<CTLSchemaMetaInfoDto> findAvailableCtlSchemasMetaInfoForApplication(
+  List<CtlSchemaMetaInfoDto> findAvailableCtlSchemasMetaInfoForApplication(
           String tenantId, String applicationId);
 
   /**