From: Oleksandr Abakumov Date: Wed, 29 Nov 2017 13:59:04 +0000 (+0200) Subject: Modified java files headers for Alive X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=1da5ceed2417102e1e88f6cc718c713916c5597e;p=platform%2Fcore%2Fsecurity%2Fsuspicious-activity-monitor.git Modified java files headers for Alive --- diff --git a/servers/alive/src/main/java/com/samsung/alive/Alive.java b/servers/alive/src/main/java/com/samsung/alive/Alive.java index 29cbb9d..e647366 100644 --- a/servers/alive/src/main/java/com/samsung/alive/Alive.java +++ b/servers/alive/src/main/java/com/samsung/alive/Alive.java @@ -12,7 +12,14 @@ import org.springframework.context.ConfigurableApplicationContext; import org.springframework.context.annotation.ImportResource; /** - * The type Alive. + *

Alive entry point

+ * + * @author Oleksandr Abakumov + * @version 1.0 + * @file Alive.java + * @brief Alive entry point + * @date Created : 10/11/2017 + * @date Modified : 10/11/2017 */ @SpringBootApplication @ImportResource("classpath:root-context.xml") diff --git a/servers/alive/src/main/java/com/samsung/alive/exception/AliveDevicesServiceError.java b/servers/alive/src/main/java/com/samsung/alive/exception/AliveDevicesServiceError.java index 82b7322..01a4955 100644 --- a/servers/alive/src/main/java/com/samsung/alive/exception/AliveDevicesServiceError.java +++ b/servers/alive/src/main/java/com/samsung/alive/exception/AliveDevicesServiceError.java @@ -9,7 +9,14 @@ import org.springframework.http.HttpStatus; import org.springframework.web.bind.annotation.ResponseStatus; /** - * When error occurred on alive devices service or rest + *

When error occurred on alive devices service or rest

+ * + * @author Oleksandr Abakumov + * @version 1.0 + * @file AliveDevicesServiceError.java + * @brief When error occurred on alive devices service or rest + * @date Created : 10/11/2017 + * @date Modified : 10/11/2017 */ @ResponseStatus(code = HttpStatus.INTERNAL_SERVER_ERROR) public class AliveDevicesServiceError extends Exception { diff --git a/servers/alive/src/main/java/com/samsung/alive/exception/NoUserFound.java b/servers/alive/src/main/java/com/samsung/alive/exception/NoUserFound.java index afbae9f..015af40 100644 --- a/servers/alive/src/main/java/com/samsung/alive/exception/NoUserFound.java +++ b/servers/alive/src/main/java/com/samsung/alive/exception/NoUserFound.java @@ -9,7 +9,14 @@ import org.springframework.http.HttpStatus; import org.springframework.web.bind.annotation.ResponseStatus; /** - * No user found + *

No user found error

+ * + * @author Oleksandr Abakumov + * @version 1.0 + * @file NoUserFound.java + * @brief No user found error + * @date Created : 10/11/2017 + * @date Modified : 10/11/2017 */ @ResponseStatus(code = HttpStatus.NOT_FOUND) public class NoUserFound extends AliveDevicesServiceError { diff --git a/servers/alive/src/main/java/com/samsung/alive/rest/AliveRestController.java b/servers/alive/src/main/java/com/samsung/alive/rest/AliveRestController.java index a545e13..67b4e2e 100644 --- a/servers/alive/src/main/java/com/samsung/alive/rest/AliveRestController.java +++ b/servers/alive/src/main/java/com/samsung/alive/rest/AliveRestController.java @@ -24,7 +24,14 @@ import com.samsung.commons.service.UserService; import java.util.Optional; /** - * The type Alive rest controller. + *

The type Alive rest controller

+ * + * @author Oleksandr Abakumov + * @version 1.0 + * @file AliveRestController.java + * @brief The type Alive rest controller + * @date Created : 10/11/2017 + * @date Modified : 10/11/2017 */ @RestController @RequestMapping("/restapi/alive") diff --git a/servers/alive/src/main/java/com/samsung/alive/service/AliveDevicesService.java b/servers/alive/src/main/java/com/samsung/alive/service/AliveDevicesService.java index 95c5ebf..dcf6878 100644 --- a/servers/alive/src/main/java/com/samsung/alive/service/AliveDevicesService.java +++ b/servers/alive/src/main/java/com/samsung/alive/service/AliveDevicesService.java @@ -12,7 +12,14 @@ import com.samsung.commons.domain.User; import java.util.Optional; /** - * Gets alive devices from Iotivity + *

Gets alive devices from Iotivity

+ * + * @author Oleksandr Abakumov + * @version 1.0 + * @file AliveDevicesService.java + * @brief AliveDevicesService + * @date Created : 10/11/2017 + * @date Modified : 10/11/2017 */ public interface AliveDevicesService { diff --git a/servers/alive/src/main/java/com/samsung/alive/service/CloudService.java b/servers/alive/src/main/java/com/samsung/alive/service/CloudService.java index d0e49a8..68a4e5d 100644 --- a/servers/alive/src/main/java/com/samsung/alive/service/CloudService.java +++ b/servers/alive/src/main/java/com/samsung/alive/service/CloudService.java @@ -11,7 +11,14 @@ import java.util.Optional; import java.util.Set; /** - * Service that interacts with Iotivity + *

Service that interacts with Iotivity

+ * + * @author Oleksandr Abakumov + * @version 1.0 + * @file CloudService.java + * @brief Service that interacts with Iotivity + * @date Created : 10/11/2017 + * @date Modified : 10/11/2017 */ public interface CloudService { diff --git a/servers/alive/src/main/java/com/samsung/alive/service/impl/AliveDevicesServiceImpl.java b/servers/alive/src/main/java/com/samsung/alive/service/impl/AliveDevicesServiceImpl.java index 987a846..2cc5618 100644 --- a/servers/alive/src/main/java/com/samsung/alive/service/impl/AliveDevicesServiceImpl.java +++ b/servers/alive/src/main/java/com/samsung/alive/service/impl/AliveDevicesServiceImpl.java @@ -27,7 +27,14 @@ import static java.util.Optional.ofNullable; import static java.util.stream.Collectors.toList; /** - * The type Alive devices service. + *

The type Alive devices service

+ * + * @author Oleksandr Abakumov + * @version 1.0 + * @file AliveDevicesServiceImpl.java + * @brief The type Alive devices service + * @date Created : 10/11/2017 + * @date Modified : 10/11/2017 */ @Service public class AliveDevicesServiceImpl implements AliveDevicesService { diff --git a/servers/alive/src/main/java/com/samsung/alive/service/impl/CloudServiceImpl.java b/servers/alive/src/main/java/com/samsung/alive/service/impl/CloudServiceImpl.java index f2c8095..1c2d610 100644 --- a/servers/alive/src/main/java/com/samsung/alive/service/impl/CloudServiceImpl.java +++ b/servers/alive/src/main/java/com/samsung/alive/service/impl/CloudServiceImpl.java @@ -34,7 +34,14 @@ import static org.iotivity.base.QualityOfService.LOW; import static org.iotivity.base.ServiceType.IN_PROC; /** - * The type Cloud service. + *

The type Cloud service

+ * + * @author Oleksandr Abakumov + * @version 1.0 + * @file CloudServiceImpl.java + * @brief The type Cloud service + * @date Created : 10/11/2017 + * @date Modified : 10/11/2017 */ @Service public class CloudServiceImpl implements CloudService { diff --git a/servers/alive/src/main/java/com/samsung/alive/service/impl/CodeAndAccessTokenPair.java b/servers/alive/src/main/java/com/samsung/alive/service/impl/CodeAndAccessTokenPair.java index 8c4d8ae..3727bda 100644 --- a/servers/alive/src/main/java/com/samsung/alive/service/impl/CodeAndAccessTokenPair.java +++ b/servers/alive/src/main/java/com/samsung/alive/service/impl/CodeAndAccessTokenPair.java @@ -5,6 +5,16 @@ */ package com.samsung.alive.service.impl; +/** + *

CodeAndAccessTokenPair

+ * + * @author Oleksandr Abakumov + * @version 1.0 + * @file CodeAndAccessTokenPair.java + * @brief CodeAndAccessTokenPair + * @date Created : 10/11/2017 + * @date Modified : 10/11/2017 + */ public class CodeAndAccessTokenPair { private final String code; private final String accessToken; diff --git a/servers/alive/src/main/java/com/samsung/alive/utils/rest/dsm/DsmApi.java b/servers/alive/src/main/java/com/samsung/alive/utils/rest/dsm/DsmApi.java index 413c540..33c60a4 100644 --- a/servers/alive/src/main/java/com/samsung/alive/utils/rest/dsm/DsmApi.java +++ b/servers/alive/src/main/java/com/samsung/alive/utils/rest/dsm/DsmApi.java @@ -6,11 +6,14 @@ package com.samsung.alive.utils.rest.dsm; /** - * Invokes DSM's methods + *

Invokes DSM's methods

* * @author Oleksandr Abakumov * @version 1.0 - * @since 2017-10-30 + * @file DsmApi.java + * @brief DsmApi interface + * @date Created : 10/11/2017 + * @date Modified : 10/11/2017 */ public interface DsmApi { diff --git a/servers/alive/src/main/java/com/samsung/alive/utils/rest/dsm/DsmApiError.java b/servers/alive/src/main/java/com/samsung/alive/utils/rest/dsm/DsmApiError.java index 4d9d779..a7a614f 100644 --- a/servers/alive/src/main/java/com/samsung/alive/utils/rest/dsm/DsmApiError.java +++ b/servers/alive/src/main/java/com/samsung/alive/utils/rest/dsm/DsmApiError.java @@ -6,7 +6,14 @@ package com.samsung.alive.utils.rest.dsm; /** - * DSM api error + *

DSM api error

+ * + * @author Oleksandr Abakumov + * @version 1.0 + * @file DsmApiError.java + * @brief DsmApiError + * @date Created : 10/11/2017 + * @date Modified : 10/11/2017 */ public class DsmApiError extends Exception { diff --git a/servers/alive/src/main/java/com/samsung/alive/utils/rest/dsm/DsmApiImpl.java b/servers/alive/src/main/java/com/samsung/alive/utils/rest/dsm/DsmApiImpl.java index f6d7920..fe4e3a1 100644 --- a/servers/alive/src/main/java/com/samsung/alive/utils/rest/dsm/DsmApiImpl.java +++ b/servers/alive/src/main/java/com/samsung/alive/utils/rest/dsm/DsmApiImpl.java @@ -12,11 +12,14 @@ import org.apache.log4j.Logger; import static java.lang.String.format; /** - * The type Server sender. + *

The type DSM API

* * @author Oleksandr Abakumov * @version 1.0 - * @since 2017-10-30 + * @file DsmApiImpl.java + * @brief DsmApiImpl + * @date Created : 10/11/2017 + * @date Modified : 10/11/2017 */ public class DsmApiImpl implements DsmApi { diff --git a/servers/alive/src/test/java/com/samsung/alive/AliveTest.java b/servers/alive/src/test/java/com/samsung/alive/AliveTest.java index 8cba14d..18c1510 100644 --- a/servers/alive/src/test/java/com/samsung/alive/AliveTest.java +++ b/servers/alive/src/test/java/com/samsung/alive/AliveTest.java @@ -12,7 +12,14 @@ import static com.samsung.alive.Alive.getContext; import static org.junit.Assert.assertNotNull; /** - * The type Alive test. + *

The type Alive test

+ * + * @author Oleksandr Abakumov + * @version 1.0 + * @file AliveTest.java + * @brief unit test + * @date Created : 10/11/2017 + * @date Modified : 10/11/2017 */ public class AliveTest { diff --git a/servers/alive/src/test/java/com/samsung/alive/rest/AliveRestControllerTest.java b/servers/alive/src/test/java/com/samsung/alive/rest/AliveRestControllerTest.java index b58f741..d931fd3 100644 --- a/servers/alive/src/test/java/com/samsung/alive/rest/AliveRestControllerTest.java +++ b/servers/alive/src/test/java/com/samsung/alive/rest/AliveRestControllerTest.java @@ -36,7 +36,14 @@ import static org.springframework.test.web.servlet.result.MockMvcResultMatchers. import static org.springframework.test.web.servlet.setup.MockMvcBuilders.standaloneSetup; /** - * The type Alive devices api test. + *

Unit test REST

+ * + * @author Oleksandr Abakumov + * @version 1.0 + * @file AliveRestControllerTest.java + * @brief unit test + * @date Created : 10/11/2017 + * @date Modified : 10/11/2017 */ @RunWith(SpringJUnit4ClassRunner.class) @ContextConfiguration(locations = { "classpath:root-context.xml" }) diff --git a/servers/alive/src/test/java/com/samsung/alive/service/impl/AliveDevicesServiceImplTest.java b/servers/alive/src/test/java/com/samsung/alive/service/impl/AliveDevicesServiceImplTest.java index 546256b..fb6dc4e 100644 --- a/servers/alive/src/test/java/com/samsung/alive/service/impl/AliveDevicesServiceImplTest.java +++ b/servers/alive/src/test/java/com/samsung/alive/service/impl/AliveDevicesServiceImplTest.java @@ -40,7 +40,14 @@ import static org.powermock.reflect.Whitebox.setInternalState; import static org.springframework.test.annotation.DirtiesContext.MethodMode.AFTER_METHOD; /** - * The type Alive Devices service test. + *

The type Alive Devices service test.

+ * + * @author Oleksandr Abakumov + * @version 1.0 + * @file AliveDevicesServiceImplTest.java + * @brief unit test + * @date Created : 10/11/2017 + * @date Modified : 10/11/2017 */ @RunWith(SpringJUnit4ClassRunner.class) @WebAppConfiguration diff --git a/servers/alive/src/test/java/com/samsung/alive/utils/rest/DsmApiImplTest.java b/servers/alive/src/test/java/com/samsung/alive/utils/rest/DsmApiImplTest.java index 87b091e..de43588 100644 --- a/servers/alive/src/test/java/com/samsung/alive/utils/rest/DsmApiImplTest.java +++ b/servers/alive/src/test/java/com/samsung/alive/utils/rest/DsmApiImplTest.java @@ -23,11 +23,14 @@ import static org.mockito.Matchers.eq; import static org.mockito.Mockito.when; /** - * Server sender test + *

DSM REST API unit test

* * @author Oleksandr Abakumov * @version 1.0 - * @since 2017-10-30 + * @file DsmApiImplTest.java + * @brief unit test + * @date Created : 10/11/2017 + * @date Modified : 10/11/2017 */ @RunWith(SpringJUnit4ClassRunner.class) public class DsmApiImplTest {