From eab6ecdc47c470eb468a671dd5907cc418b7e000 Mon Sep 17 00:00:00 2001 From: "m.dalakov" Date: Thu, 5 Oct 2017 19:04:18 +0300 Subject: [PATCH] [SECIOTSRK-628] Add maven plugin for javadoc. Fix javadoc errors for generate javadoc artifact --- .../src/main/java/com/samsung/commons/domain/Agent.java | 1 - .../src/main/java/com/samsung/commons/domain/Device.java | 1 - .../src/main/java/com/samsung/commons/domain/Policy.java | 2 +- .../com/samsung/commons/repository/ReportRepository.java | 1 - .../java/com/samsung/commons/service/AgentService.java | 2 -- .../java/com/samsung/commons/service/CommonService.java | 1 - .../java/com/samsung/commons/service/DeviceService.java | 1 - .../java/com/samsung/commons/service/PolicyService.java | 2 -- .../java/com/samsung/commons/service/UserService.java | 2 -- .../com/samsung/commons/service/impl/UserServiceImpl.java | 1 - .../dsm/model/restapi/converter/AgentConverter.java | 2 +- .../dsm/model/restapi/converter/DeviceConverter.java | 2 +- .../samsung/dsm/report/analyzer/impl/RuleAnalyzer.java | 1 + .../com/samsung/dsm/rest/accesstoken/AccessTokenApi.java | 2 +- .../com/samsung/servermq/iotivity/KafkaErrorMessages.java | 2 +- .../java/com/samsung/servermq/iotivity/Publisher.java | 2 +- .../servermq/iotivity/extractor/PostDataExtractor.java | 2 +- .../impl/DeviceRegistrationPostDataExtractor.java | 2 +- .../impl/DeviceUnRegistrationPostDataExtractor.java | 2 +- .../iotivity/extractor/impl/PolicyPostDataExtractor.java | 2 +- .../iotivity/extractor/impl/ReportPostDataExtractor.java | 2 +- .../samsung/servermq/iotivity/report/PrepareReport.java | 2 +- .../java/com/samsung/servermq/rest/DSMRestController.java | 2 +- .../mq/src/main/java/com/samsung/servermq/utils/Cbor.java | 2 +- .../com/samsung/servermq/utils/MessageQueueUtils.java | 4 +--- .../com/samsung/servermq/utils/rest/ServerSender.java | 2 +- .../com/samsung/servermq/utils/rest/ServerSenderImpl.java | 2 +- servers/pom.xml | 15 +++++++++++++++ 28 files changed, 33 insertions(+), 31 deletions(-) diff --git a/servers/commons/src/main/java/com/samsung/commons/domain/Agent.java b/servers/commons/src/main/java/com/samsung/commons/domain/Agent.java index ef70b8c..6c1ea1b 100644 --- a/servers/commons/src/main/java/com/samsung/commons/domain/Agent.java +++ b/servers/commons/src/main/java/com/samsung/commons/domain/Agent.java @@ -93,7 +93,6 @@ public class Agent implements Serializable { * Sets the id. * * @param id the id - * @return the unique identifier */ public void setId(Long id) { this.id = id; diff --git a/servers/commons/src/main/java/com/samsung/commons/domain/Device.java b/servers/commons/src/main/java/com/samsung/commons/domain/Device.java index d5185ec..7bd365b 100644 --- a/servers/commons/src/main/java/com/samsung/commons/domain/Device.java +++ b/servers/commons/src/main/java/com/samsung/commons/domain/Device.java @@ -250,7 +250,6 @@ public class Device implements Serializable { * Sets the id. * * @param id the id - * @return the unique identifier */ public void setId(Long id) { this.id = id; diff --git a/servers/commons/src/main/java/com/samsung/commons/domain/Policy.java b/servers/commons/src/main/java/com/samsung/commons/domain/Policy.java index c820ed1..6cd266f 100644 --- a/servers/commons/src/main/java/com/samsung/commons/domain/Policy.java +++ b/servers/commons/src/main/java/com/samsung/commons/domain/Policy.java @@ -176,7 +176,7 @@ public class Policy implements Serializable { /** * Checks whether objects are equal. - * @param object to compare with + * @param obj to compare with * * @return true if objects are equels, otherwise false */ diff --git a/servers/commons/src/main/java/com/samsung/commons/repository/ReportRepository.java b/servers/commons/src/main/java/com/samsung/commons/repository/ReportRepository.java index dbe7f4c..4ba2e04 100644 --- a/servers/commons/src/main/java/com/samsung/commons/repository/ReportRepository.java +++ b/servers/commons/src/main/java/com/samsung/commons/repository/ReportRepository.java @@ -22,7 +22,6 @@ import java.util.List; * @author Artem Motchanyi * @version 1.0 * @see Report - * @see Device * @since 2016 -09-01 */ @Repository diff --git a/servers/commons/src/main/java/com/samsung/commons/service/AgentService.java b/servers/commons/src/main/java/com/samsung/commons/service/AgentService.java index d93a616..30f5128 100644 --- a/servers/commons/src/main/java/com/samsung/commons/service/AgentService.java +++ b/servers/commons/src/main/java/com/samsung/commons/service/AgentService.java @@ -50,7 +50,6 @@ public interface AgentService extends CommonService { * @param uuid unique agent id * @param name agent name * @return {@link Agent} - * @throws Exception the empty name exception. */ Agent init(String uuid, String name); @@ -61,7 +60,6 @@ public interface AgentService extends CommonService { * @param name agent name * @param device device to which the agent belongs * @return {@link Agent} - * @throws Exception the empty name exception. */ Agent init(String uuid, String name, Device device); diff --git a/servers/commons/src/main/java/com/samsung/commons/service/CommonService.java b/servers/commons/src/main/java/com/samsung/commons/service/CommonService.java index 264cca3..bd8732b 100644 --- a/servers/commons/src/main/java/com/samsung/commons/service/CommonService.java +++ b/servers/commons/src/main/java/com/samsung/commons/service/CommonService.java @@ -12,7 +12,6 @@ package com.samsung.commons.service; * @param the type parameter * @author Sergiy Shram * @version 1.0 - * @see Device * @since 2016 -09-01 */ public interface CommonService { diff --git a/servers/commons/src/main/java/com/samsung/commons/service/DeviceService.java b/servers/commons/src/main/java/com/samsung/commons/service/DeviceService.java index 8a831c1..c54958d 100644 --- a/servers/commons/src/main/java/com/samsung/commons/service/DeviceService.java +++ b/servers/commons/src/main/java/com/samsung/commons/service/DeviceService.java @@ -87,7 +87,6 @@ public interface DeviceService extends CommonService { * @param user user * @param route the route * @return {@link Device} - * @throws Exception the empty name exception. */ Device init(String uuid, String name, String type, String model, int status, User user, String route); diff --git a/servers/commons/src/main/java/com/samsung/commons/service/PolicyService.java b/servers/commons/src/main/java/com/samsung/commons/service/PolicyService.java index 7ba3370..acbe1c8 100644 --- a/servers/commons/src/main/java/com/samsung/commons/service/PolicyService.java +++ b/servers/commons/src/main/java/com/samsung/commons/service/PolicyService.java @@ -49,7 +49,6 @@ public interface PolicyService extends CommonService { * @param deviceUuid of the device * @param policy to set * @return {@link Policy} - * @throws Exception device doesn't exist exception. */ Policy setDevicePolicy(String deviceUuid, String policy); @@ -59,7 +58,6 @@ public interface PolicyService extends CommonService { * @param agentUuid of the agent * @param policy to set * @return {@link Policy} - * @throws Exception agent doesn't exist exception. */ Policy setAgentPolicy(String agentUuid, String policy); diff --git a/servers/commons/src/main/java/com/samsung/commons/service/UserService.java b/servers/commons/src/main/java/com/samsung/commons/service/UserService.java index 07e194f..80b5c56 100644 --- a/servers/commons/src/main/java/com/samsung/commons/service/UserService.java +++ b/servers/commons/src/main/java/com/samsung/commons/service/UserService.java @@ -16,7 +16,6 @@ import java.util.List; * * @author Sergii Shram * @version 1.0 - * @see Role * @since 2016 -09-01 */ public interface UserService extends CommonService { @@ -68,7 +67,6 @@ public interface UserService extends CommonService { * Service method provides user removal by ID. * * @param id of user for removal. - * @throws Exception self removal occurred */ void remove(Long id); diff --git a/servers/commons/src/main/java/com/samsung/commons/service/impl/UserServiceImpl.java b/servers/commons/src/main/java/com/samsung/commons/service/impl/UserServiceImpl.java index 88b9907..a85eb29 100644 --- a/servers/commons/src/main/java/com/samsung/commons/service/impl/UserServiceImpl.java +++ b/servers/commons/src/main/java/com/samsung/commons/service/impl/UserServiceImpl.java @@ -28,7 +28,6 @@ import com.samsung.commons.service.UserService; * * @author Sergii Shram * @version 1.0 - * @see Role * @since 2016 -09-01 */ @Service("userService") diff --git a/servers/dsm/src/main/java/com/samsung/dsm/model/restapi/converter/AgentConverter.java b/servers/dsm/src/main/java/com/samsung/dsm/model/restapi/converter/AgentConverter.java index 8fa396d..b8cdf8f 100644 --- a/servers/dsm/src/main/java/com/samsung/dsm/model/restapi/converter/AgentConverter.java +++ b/servers/dsm/src/main/java/com/samsung/dsm/model/restapi/converter/AgentConverter.java @@ -6,7 +6,7 @@ import org.springframework.stereotype.Service; import com.samsung.dsm.model.restapi.RestAgent; /** - * Agent -> RestAgent + * Agent - RestAgent * * @author Oleksandr Abakumov * @version 1.0 diff --git a/servers/dsm/src/main/java/com/samsung/dsm/model/restapi/converter/DeviceConverter.java b/servers/dsm/src/main/java/com/samsung/dsm/model/restapi/converter/DeviceConverter.java index 47fcdf7..f10ee8c 100644 --- a/servers/dsm/src/main/java/com/samsung/dsm/model/restapi/converter/DeviceConverter.java +++ b/servers/dsm/src/main/java/com/samsung/dsm/model/restapi/converter/DeviceConverter.java @@ -5,7 +5,7 @@ import com.samsung.dsm.model.restapi.RestDevice; import org.springframework.stereotype.Service; /** - * Device -> RestDevice + * Device - RestDevice * * @author Oleksandr Abakumov * @version 1.0 diff --git a/servers/dsm/src/main/java/com/samsung/dsm/report/analyzer/impl/RuleAnalyzer.java b/servers/dsm/src/main/java/com/samsung/dsm/report/analyzer/impl/RuleAnalyzer.java index 617b81a..953c53f 100644 --- a/servers/dsm/src/main/java/com/samsung/dsm/report/analyzer/impl/RuleAnalyzer.java +++ b/servers/dsm/src/main/java/com/samsung/dsm/report/analyzer/impl/RuleAnalyzer.java @@ -81,6 +81,7 @@ public class RuleAnalyzer { * Is valid boolean. * * @param currentRow the current row + * @param reportType the current row * @return the boolean */ protected boolean isValid(String currentRow, String reportType) { diff --git a/servers/dsm/src/main/java/com/samsung/dsm/rest/accesstoken/AccessTokenApi.java b/servers/dsm/src/main/java/com/samsung/dsm/rest/accesstoken/AccessTokenApi.java index c1e2c6d..6e40b6b 100644 --- a/servers/dsm/src/main/java/com/samsung/dsm/rest/accesstoken/AccessTokenApi.java +++ b/servers/dsm/src/main/java/com/samsung/dsm/rest/accesstoken/AccessTokenApi.java @@ -65,7 +65,7 @@ public class AccessTokenApi { /** * Get information about the user by it's access token Request format[GET]: - * ../access_token/?access_token= + * ../access_token/?access_token={access_token} * * @param accessToken access token * @return (OK) response status (UNAUTHORIZED) wrong credentials diff --git a/servers/mq/src/main/java/com/samsung/servermq/iotivity/KafkaErrorMessages.java b/servers/mq/src/main/java/com/samsung/servermq/iotivity/KafkaErrorMessages.java index fe600a9..6b7b670 100644 --- a/servers/mq/src/main/java/com/samsung/servermq/iotivity/KafkaErrorMessages.java +++ b/servers/mq/src/main/java/com/samsung/servermq/iotivity/KafkaErrorMessages.java @@ -8,7 +8,7 @@ import java.util.Map; * * @author Yevhen Zozulia * @version 1.0 - * @see + * @see * @since 2017 -07-06 */ public final class KafkaErrorMessages { diff --git a/servers/mq/src/main/java/com/samsung/servermq/iotivity/Publisher.java b/servers/mq/src/main/java/com/samsung/servermq/iotivity/Publisher.java index 3ad7ba8..67886fe 100644 --- a/servers/mq/src/main/java/com/samsung/servermq/iotivity/Publisher.java +++ b/servers/mq/src/main/java/com/samsung/servermq/iotivity/Publisher.java @@ -7,7 +7,7 @@ import java.util.Map; * * @author Yevhen Zozulia * @version 1.0 - * @see + * @see * @since 2017 -07-06 */ public interface Publisher { diff --git a/servers/mq/src/main/java/com/samsung/servermq/iotivity/extractor/PostDataExtractor.java b/servers/mq/src/main/java/com/samsung/servermq/iotivity/extractor/PostDataExtractor.java index c4ade56..203b490 100644 --- a/servers/mq/src/main/java/com/samsung/servermq/iotivity/extractor/PostDataExtractor.java +++ b/servers/mq/src/main/java/com/samsung/servermq/iotivity/extractor/PostDataExtractor.java @@ -5,7 +5,7 @@ package com.samsung.servermq.iotivity.extractor; * * @author Yevhen Zozulia * @version 1.0 - * @see + * @see * @since 2017 -07-06 */ public interface PostDataExtractor { diff --git a/servers/mq/src/main/java/com/samsung/servermq/iotivity/extractor/impl/DeviceRegistrationPostDataExtractor.java b/servers/mq/src/main/java/com/samsung/servermq/iotivity/extractor/impl/DeviceRegistrationPostDataExtractor.java index adb9a80..b79f99a 100644 --- a/servers/mq/src/main/java/com/samsung/servermq/iotivity/extractor/impl/DeviceRegistrationPostDataExtractor.java +++ b/servers/mq/src/main/java/com/samsung/servermq/iotivity/extractor/impl/DeviceRegistrationPostDataExtractor.java @@ -17,7 +17,7 @@ import com.samsung.servermq.utils.MessageQueueUtils; * * @author Yevhen Zozulia * @version 1.0 - * @see + * @see * @since 2017 -07-06 */ public class DeviceRegistrationPostDataExtractor implements PostDataExtractor { diff --git a/servers/mq/src/main/java/com/samsung/servermq/iotivity/extractor/impl/DeviceUnRegistrationPostDataExtractor.java b/servers/mq/src/main/java/com/samsung/servermq/iotivity/extractor/impl/DeviceUnRegistrationPostDataExtractor.java index c064fd4..1596be9 100644 --- a/servers/mq/src/main/java/com/samsung/servermq/iotivity/extractor/impl/DeviceUnRegistrationPostDataExtractor.java +++ b/servers/mq/src/main/java/com/samsung/servermq/iotivity/extractor/impl/DeviceUnRegistrationPostDataExtractor.java @@ -14,7 +14,7 @@ import com.samsung.servermq.utils.MessageQueueUtils; * * @author Yevhen Zozulia * @version 1.0 - * @see + * @see * @since 2017 -07-06 */ public class DeviceUnRegistrationPostDataExtractor implements PostDataExtractor { diff --git a/servers/mq/src/main/java/com/samsung/servermq/iotivity/extractor/impl/PolicyPostDataExtractor.java b/servers/mq/src/main/java/com/samsung/servermq/iotivity/extractor/impl/PolicyPostDataExtractor.java index b80cbbe..708c595 100644 --- a/servers/mq/src/main/java/com/samsung/servermq/iotivity/extractor/impl/PolicyPostDataExtractor.java +++ b/servers/mq/src/main/java/com/samsung/servermq/iotivity/extractor/impl/PolicyPostDataExtractor.java @@ -15,7 +15,7 @@ import com.samsung.servermq.utils.rest.ServerSender; * * @author Yevhen Zozulia * @version 1.0 - * @see + * @see * @since 2017 -07-06 */ public class PolicyPostDataExtractor implements PostDataExtractor { diff --git a/servers/mq/src/main/java/com/samsung/servermq/iotivity/extractor/impl/ReportPostDataExtractor.java b/servers/mq/src/main/java/com/samsung/servermq/iotivity/extractor/impl/ReportPostDataExtractor.java index c74b0a7..4782f4e 100644 --- a/servers/mq/src/main/java/com/samsung/servermq/iotivity/extractor/impl/ReportPostDataExtractor.java +++ b/servers/mq/src/main/java/com/samsung/servermq/iotivity/extractor/impl/ReportPostDataExtractor.java @@ -19,7 +19,7 @@ import com.samsung.servermq.iotivity.report.PrepareReport; * * @author Yevhen Zozulia * @version 1.0 - * @see + * @see * @since 2017 -07-06 */ public class ReportPostDataExtractor implements PostDataExtractor { diff --git a/servers/mq/src/main/java/com/samsung/servermq/iotivity/report/PrepareReport.java b/servers/mq/src/main/java/com/samsung/servermq/iotivity/report/PrepareReport.java index ab5d687..3efa4b6 100644 --- a/servers/mq/src/main/java/com/samsung/servermq/iotivity/report/PrepareReport.java +++ b/servers/mq/src/main/java/com/samsung/servermq/iotivity/report/PrepareReport.java @@ -5,7 +5,7 @@ package com.samsung.servermq.iotivity.report; * * @author Yevhen Zozulia * @version 1.0 - * @see + * @see * @since 2017 -07-06 */ public class PrepareReport { diff --git a/servers/mq/src/main/java/com/samsung/servermq/rest/DSMRestController.java b/servers/mq/src/main/java/com/samsung/servermq/rest/DSMRestController.java index 66b6ecb..8621410 100644 --- a/servers/mq/src/main/java/com/samsung/servermq/rest/DSMRestController.java +++ b/servers/mq/src/main/java/com/samsung/servermq/rest/DSMRestController.java @@ -31,7 +31,7 @@ import com.samsung.servermq.iotivity.Publisher; * * @author Yevhen Zozulia * @version 1.0 - * @see + * @see * @since 2017 -07-06 */ @RestController diff --git a/servers/mq/src/main/java/com/samsung/servermq/utils/Cbor.java b/servers/mq/src/main/java/com/samsung/servermq/utils/Cbor.java index 7494d03..5dc082d 100644 --- a/servers/mq/src/main/java/com/samsung/servermq/utils/Cbor.java +++ b/servers/mq/src/main/java/com/samsung/servermq/utils/Cbor.java @@ -33,7 +33,7 @@ import com.fasterxml.jackson.dataformat.cbor.CBORFactory; * @param the type parameter * @author Yevhen Zozulia * @version 1.0 - * @see + * @see * @since 2017 -07-06 */ public class Cbor { diff --git a/servers/mq/src/main/java/com/samsung/servermq/utils/MessageQueueUtils.java b/servers/mq/src/main/java/com/samsung/servermq/utils/MessageQueueUtils.java index 39ff7bb..f1fafae 100644 --- a/servers/mq/src/main/java/com/samsung/servermq/utils/MessageQueueUtils.java +++ b/servers/mq/src/main/java/com/samsung/servermq/utils/MessageQueueUtils.java @@ -31,7 +31,7 @@ import org.apache.log4j.Logger; * * @author Yevhen Zozulia * @version 1.0 - * @see + * @see * @since 2017 -07-06 */ public final class MessageQueueUtils { @@ -48,7 +48,6 @@ public final class MessageQueueUtils { * @param payload payload received * @param key property key to get data * @return extracted data in payload - * @throws Exception */ public static T extractDataFromPayload(byte[] payload, String key) { @@ -77,7 +76,6 @@ public final class MessageQueueUtils { * @param key property key * @param value property value * @return cbor encoded payload with providing key and value - * @throws Exception */ public static byte[] buildPayload(String key, T value) { diff --git a/servers/mq/src/main/java/com/samsung/servermq/utils/rest/ServerSender.java b/servers/mq/src/main/java/com/samsung/servermq/utils/rest/ServerSender.java index e18f741..4bdb294 100644 --- a/servers/mq/src/main/java/com/samsung/servermq/utils/rest/ServerSender.java +++ b/servers/mq/src/main/java/com/samsung/servermq/utils/rest/ServerSender.java @@ -5,7 +5,7 @@ package com.samsung.servermq.utils.rest; * * @author Yevhen Zozulia * @version 1.0 - * @see + * @see * @since 2017 -07-06 */ public interface ServerSender { diff --git a/servers/mq/src/main/java/com/samsung/servermq/utils/rest/ServerSenderImpl.java b/servers/mq/src/main/java/com/samsung/servermq/utils/rest/ServerSenderImpl.java index 7d59898..0543625 100644 --- a/servers/mq/src/main/java/com/samsung/servermq/utils/rest/ServerSenderImpl.java +++ b/servers/mq/src/main/java/com/samsung/servermq/utils/rest/ServerSenderImpl.java @@ -16,7 +16,7 @@ import org.springframework.web.client.RestTemplate; * * @author Yevhen Zozulia * @version 1.0 - * @see + * @see * @since 2017 -07-06 */ public class ServerSenderImpl implements ServerSender { diff --git a/servers/pom.xml b/servers/pom.xml index 8f63f0d..9dad773 100644 --- a/servers/pom.xml +++ b/servers/pom.xml @@ -88,10 +88,25 @@ + + org.apache.maven.plugins + maven-javadoc-plugin + 3.0.0-M1 + + + + + org.apache.maven.plugins + maven-javadoc-plugin + 3.0.0-M1 + + + + true -- 2.7.4