Modified java files headers for Alive
authorOleksandr Abakumov <o.abakumov@samsung.com>
Wed, 29 Nov 2017 13:59:04 +0000 (15:59 +0200)
committerOleksandr Abakumov <o.abakumov@samsung.com>
Wed, 29 Nov 2017 14:01:27 +0000 (16:01 +0200)
16 files changed:
servers/alive/src/main/java/com/samsung/alive/Alive.java
servers/alive/src/main/java/com/samsung/alive/exception/AliveDevicesServiceError.java
servers/alive/src/main/java/com/samsung/alive/exception/NoUserFound.java
servers/alive/src/main/java/com/samsung/alive/rest/AliveRestController.java
servers/alive/src/main/java/com/samsung/alive/service/AliveDevicesService.java
servers/alive/src/main/java/com/samsung/alive/service/CloudService.java
servers/alive/src/main/java/com/samsung/alive/service/impl/AliveDevicesServiceImpl.java
servers/alive/src/main/java/com/samsung/alive/service/impl/CloudServiceImpl.java
servers/alive/src/main/java/com/samsung/alive/service/impl/CodeAndAccessTokenPair.java
servers/alive/src/main/java/com/samsung/alive/utils/rest/dsm/DsmApi.java
servers/alive/src/main/java/com/samsung/alive/utils/rest/dsm/DsmApiError.java
servers/alive/src/main/java/com/samsung/alive/utils/rest/dsm/DsmApiImpl.java
servers/alive/src/test/java/com/samsung/alive/AliveTest.java
servers/alive/src/test/java/com/samsung/alive/rest/AliveRestControllerTest.java
servers/alive/src/test/java/com/samsung/alive/service/impl/AliveDevicesServiceImplTest.java
servers/alive/src/test/java/com/samsung/alive/utils/rest/DsmApiImplTest.java

index 29cbb9d..e647366 100644 (file)
@@ -12,7 +12,14 @@ import org.springframework.context.ConfigurableApplicationContext;
 import org.springframework.context.annotation.ImportResource;
 
 /**
- * The type Alive.
+ * <h1>Alive entry point</h1>
+ *
+ * @author <A HREF="mailto:o.abakumov@samsung.com">Oleksandr Abakumov</A>
+ * @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")
index 82b7322..01a4955 100644 (file)
@@ -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
+ * <h1>When error occurred on alive devices service or rest</h1>
+ *
+ * @author <A HREF="mailto:o.abakumov@samsung.com">Oleksandr Abakumov</A>
+ * @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 {
index afbae9f..015af40 100644 (file)
@@ -9,7 +9,14 @@ import org.springframework.http.HttpStatus;
 import org.springframework.web.bind.annotation.ResponseStatus;
 
 /**
- * No user found
+ * <h1>No user found error</h1>
+ *
+ * @author <A HREF="mailto:o.abakumov@samsung.com">Oleksandr Abakumov</A>
+ * @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 {
index a545e13..67b4e2e 100644 (file)
@@ -24,7 +24,14 @@ import com.samsung.commons.service.UserService;
 import java.util.Optional;
 
 /**
- * The type Alive rest controller.
+ * <h1>The type Alive rest controller</h1>
+ *
+ * @author <A HREF="mailto:o.abakumov@samsung.com">Oleksandr Abakumov</A>
+ * @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")
index 95c5ebf..dcf6878 100644 (file)
@@ -12,7 +12,14 @@ import com.samsung.commons.domain.User;
 import java.util.Optional;
 
 /**
- * Gets alive devices from Iotivity
+ * <h1>Gets alive devices from Iotivity</h1>
+ *
+ * @author <A HREF="mailto:o.abakumov@samsung.com">Oleksandr Abakumov</A>
+ * @version 1.0
+ * @file AliveDevicesService.java
+ * @brief AliveDevicesService
+ * @date Created : 10/11/2017
+ * @date Modified : 10/11/2017
  */
 public interface AliveDevicesService {
 
index d0e49a8..68a4e5d 100644 (file)
@@ -11,7 +11,14 @@ import java.util.Optional;
 import java.util.Set;
 
 /**
- * Service that interacts with Iotivity
+ * <h1>Service that interacts with Iotivity</h1>
+ *
+ * @author <A HREF="mailto:o.abakumov@samsung.com">Oleksandr Abakumov</A>
+ * @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 {
 
index 987a846..2cc5618 100644 (file)
@@ -27,7 +27,14 @@ import static java.util.Optional.ofNullable;
 import static java.util.stream.Collectors.toList;
 
 /**
- * The type Alive devices service.
+ * <h1>The type Alive devices service</h1>
+ *
+ * @author <A HREF="mailto:o.abakumov@samsung.com">Oleksandr Abakumov</A>
+ * @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 {
index f2c8095..1c2d610 100644 (file)
@@ -34,7 +34,14 @@ import static org.iotivity.base.QualityOfService.LOW;
 import static org.iotivity.base.ServiceType.IN_PROC;
 
 /**
- * The type Cloud service.
+ * <h1>The type Cloud service</h1>
+ *
+ * @author <A HREF="mailto:o.abakumov@samsung.com">Oleksandr Abakumov</A>
+ * @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 {
index 8c4d8ae..3727bda 100644 (file)
@@ -5,6 +5,16 @@
  */
 package com.samsung.alive.service.impl;
 
+/**
+ * <h1>CodeAndAccessTokenPair</h1>
+ *
+ * @author <A HREF="mailto:o.abakumov@samsung.com">Oleksandr Abakumov</A>
+ * @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;
index 413c540..33c60a4 100644 (file)
@@ -6,11 +6,14 @@
 package com.samsung.alive.utils.rest.dsm;
 
 /**
- * Invokes DSM's methods
+ * <h1>Invokes DSM's methods</h1>
  *
  * @author <A HREF="mailto:o.abakumov@samsung.com">Oleksandr Abakumov</A>
  * @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 {
 
index 4d9d779..a7a614f 100644 (file)
@@ -6,7 +6,14 @@
 package com.samsung.alive.utils.rest.dsm;
 
 /**
- * DSM api error
+ * <h1>DSM api error</h1>
+ *
+ * @author <A HREF="mailto:o.abakumov@samsung.com">Oleksandr Abakumov</A>
+ * @version 1.0
+ * @file DsmApiError.java
+ * @brief DsmApiError
+ * @date Created : 10/11/2017
+ * @date Modified : 10/11/2017
  */
 public class DsmApiError extends Exception {
 
index f6d7920..fe4e3a1 100644 (file)
@@ -12,11 +12,14 @@ import org.apache.log4j.Logger;
 import static java.lang.String.format;
 
 /**
- * The type Server sender.
+ * <h1>The type DSM API</h1>
  *
  * @author <A HREF="mailto:o.abakumov@samsung.com">Oleksandr Abakumov</A>
  * @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 {
 
index 8cba14d..18c1510 100644 (file)
@@ -12,7 +12,14 @@ import static com.samsung.alive.Alive.getContext;
 import static org.junit.Assert.assertNotNull;
 
 /**
- * The type Alive test.
+ * <h1>The type Alive test</h1>
+ *
+ * @author <A HREF="mailto:o.abakumov@samsung.com">Oleksandr Abakumov</A>
+ * @version 1.0
+ * @file AliveTest.java
+ * @brief unit test
+ * @date Created : 10/11/2017
+ * @date Modified : 10/11/2017
  */
 public class AliveTest {
 
index b58f741..d931fd3 100644 (file)
@@ -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.
+ * <h1>Unit test REST</h1>
+ *
+ * @author <A HREF="mailto:o.abakumov@samsung.com">Oleksandr Abakumov</A>
+ * @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" })
index 546256b..fb6dc4e 100644 (file)
@@ -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.
+ * <h1>The type Alive Devices service test.</h1>
+ *
+ * @author <A HREF="mailto:o.abakumov@samsung.com">Oleksandr Abakumov</A>
+ * @version 1.0
+ * @file AliveDevicesServiceImplTest.java
+ * @brief unit test
+ * @date Created : 10/11/2017
+ * @date Modified : 10/11/2017
  */
 @RunWith(SpringJUnit4ClassRunner.class)
 @WebAppConfiguration
index 87b091e..de43588 100644 (file)
@@ -23,11 +23,14 @@ import static org.mockito.Matchers.eq;
 import static org.mockito.Mockito.when;
 
 /**
- * Server sender test
+ * <h1>DSM REST API unit test</h1>
  *
  * @author <A HREF="mailto:o.abakumov@samsung.com">Oleksandr Abakumov</A>
  * @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 {