xit-java
/
mens-traffic-parent
21
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doc: comment 정리

Browse Source
dev
gitea-관리자 1 year ago
parent f9a7913350
commit e5799b86ea
19 changed files with 122 additions and 102 deletions
Show Stats Download Patch File Download Diff File

6
mens-api/src/main/java/kr/xit/biz/ens/mapper/IKkoMyDocMapper.java
Unescape Escape View File

@ -6,16 +6,16 @@ import org.egovframe.rte.psl.dataaccess.mapper.Mapper;
/** /**
* <pre> * <pre>
* description : * description : 카카오 전자문서 API용 mapper
* *
* packageName : kr.xit.biz.ens.mapper * packageName : kr.xit.biz.ens.mapper
* fileName : IKkoMyDocMapper * fileName : IKkoMyDocMapper
* author : limju * author : limju
* date : 2023-06-05 * date : 2023-08-31
* ====================================================================== * ======================================================================
* 변경일 변경자 변경 내용 * 변경일 변경자 변경 내용
* ---------------------------------------------------------------------- * ----------------------------------------------------------------------
* 2023-06-05 limju 최초 생성 * 2023-08-31 limju 최초 생성
* *
* </pre> * </pre>
*/ */

6
mens-api/src/main/java/kr/xit/biz/ens/model/KkoMyDocDTO.java
Unescape Escape View File

@ -11,16 +11,16 @@ import lombok.*;
/** /**
* <pre> * <pre>
* description : tb_ens_ Entity DTO * description : 카카오 전자문서 DTO
* *
* packageName : kr.xit.biz.ens.model * packageName : kr.xit.biz.ens.model
* fileName : KkoMyDocDTO * fileName : KkoMyDocDTO
* author : limju * author : limju
* date : 2023-06-05 * date : 2023-08-31
* ====================================================================== * ======================================================================
* 변경일 변경자 변경 내용 * 변경일 변경자 변경 내용
* ---------------------------------------------------------------------- * ----------------------------------------------------------------------
* 2023-06-05 limju 최초 생성 * 2023-08-31 limju 최초 생성
* *
* </pre> * </pre>
*/ */

1
mens-api/src/main/java/kr/xit/biz/ens/package-info.java
Unescape Escape View File

@ -2,7 +2,6 @@
* ENS business packages * ENS business packages
* <p> * <p>
* 전자고지 : ens * 전자고지 : ens
* sms
* </p> * </p>
* @since 1.0 * @since 1.0
* @author limju * @author limju

6
mens-api/src/main/java/kr/xit/biz/ens/service/IKkoMyDocService.java
Unescape Escape View File

@ -5,16 +5,16 @@ import kr.xit.core.model.ApiResponseDTO;
/** /**
* <pre> * <pre>
* description : * description : 카카오 전자문서 API Service Interface
* *
* packageName : kr.xit.biz.ens.service * packageName : kr.xit.biz.ens.service
* fileName : IKkoMyDocService * fileName : IKkoMyDocService
* author : limju * author : limju
* date : 2023-06-05 * date : 2023-08-31
* ====================================================================== * ======================================================================
* 변경일 변경자 변경 내용 * 변경일 변경자 변경 내용
* ---------------------------------------------------------------------- * ----------------------------------------------------------------------
* 2023-06-05 limju 최초 생성 * 2023-08-31 limju 최초 생성
* *
* </pre> * </pre>
*/ */

6
mens-api/src/main/java/kr/xit/biz/ens/service/KkoMyDocService.java
Unescape Escape View File

@ -16,16 +16,16 @@ import lombok.RequiredArgsConstructor;
/** /**
* <pre> * <pre>
* description : 전자고지 통합발송 연계 서비스(배치) * description : 카카오 전자문서 API Service
* *
* packageName : kr.xit.biz.ens.service * packageName : kr.xit.biz.ens.service
* fileName : KkoMyDocService * fileName : KkoMyDocService
* author : limju * author : limju
* date : 2023-06-05 * date : 2023-08-31
* ====================================================================== * ======================================================================
* 변경일 변경자 변경 내용 * 변경일 변경자 변경 내용
* ---------------------------------------------------------------------- * ----------------------------------------------------------------------
* 2023-06-05 limju 최초 생성 * 2023-08-31 limju 최초 생성
* *
* </pre> * </pre>
*/ */

8
mens-api/src/main/java/kr/xit/biz/ens/web/KkoMyDocController.java
Unescape Escape View File

@ -14,20 +14,20 @@ import org.springframework.web.bind.annotation.RestController;
/** /**
* <pre> * <pre>
* description : * description : 카카오 전자문서 API Controller
* *
* packageName : kr.xit.biz.ens.web * packageName : kr.xit.biz.ens.web
* fileName : KkoMyDocController * fileName : KkoMyDocController
* author : limju * author : limju
* date : 2023-06-05 * date : 2023-08-31
* ====================================================================== * ======================================================================
* 변경일 변경자 변경 내용 * 변경일 변경자 변경 내용
* ---------------------------------------------------------------------- * ----------------------------------------------------------------------
* 2023-06-05 limju 최초 생성 * 2023-08-31 limju 최초 생성
* *
* </pre> * </pre>
*/ */
@Tag(name = "KkoMyDocController", description = "카카오페이 전자문서 콘텐츠 조회") @Tag(name = "KkoMyDocController", description = "카카오페이 전자문서 API Controller")
@RequiredArgsConstructor @RequiredArgsConstructor
@RestController @RestController
@RequestMapping(value = "/api/ens/v1") @RequestMapping(value = "/api/ens/v1")

4
mens-api/src/main/java/kr/xit/core/biz/model/AuditFields.java
Unescape Escape View File

@ -21,11 +21,11 @@ import lombok.experimental.SuperBuilder;
* packageName : kr.xit.core.biz.model * packageName : kr.xit.core.biz.model
* fileName : AuditFields * fileName : AuditFields
* author : limju * author : limju
* date : 2023-06-05 * date : 2023-08-31
* ====================================================================== * ======================================================================
* 변경일 변경자 변경 내용 * 변경일 변경자 변경 내용
* ---------------------------------------------------------------------- * ----------------------------------------------------------------------
* 2023-06-05 limju 최초 생성 * 2023-08-31 limju 최초 생성
* *
* </pre> * </pre>
*/ */

33
mens-api/src/main/java/kr/xit/core/biz/web/AuthApiController.java
Unescape Escape View File

@ -67,19 +67,24 @@ public class AuthApiController {
* @param request 세션처리를 위한 HttpServletRequest * @param request 세션처리를 위한 HttpServletRequest
* @return 로그인결과(세션정보) * @return 로그인결과(세션정보)
*/ */
@Operation(summary = "로그인" , description = "로그인")
@io.swagger.v3.oas.annotations.parameters.RequestBody( @io.swagger.v3.oas.annotations.parameters.RequestBody(
required = true, required = true,
content = { content = {
@Content( @Content(
mediaType = "application/json", mediaType = "application/json",
examples = { examples = {
@ExampleObject( @ExampleObject(value = """
value = "{\"id\":\"admin\",\"password\":\"1\",\"userSe\":\"USR\"}") {
"id": "admin",
"password": "1",
"userSe": "USR"
}
""")
} }
) )
} }
) )
@Operation(summary = "로그인" , description = "로그인")
@PostMapping(value = "/login", consumes = {MediaType.APPLICATION_JSON_VALUE , MediaType.TEXT_HTML_VALUE}) @PostMapping(value = "/login", consumes = {MediaType.APPLICATION_JSON_VALUE , MediaType.TEXT_HTML_VALUE})
public ApiResponseDTO<?> login(@RequestBody final LoginVO loginVO, HttpServletRequest request) { public ApiResponseDTO<?> login(@RequestBody final LoginVO loginVO, HttpServletRequest request) {
// 1. 일반 로그인 처리 // 1. 일반 로그인 처리
@ -92,7 +97,6 @@ public class AuthApiController {
return ApiResponseDTO.success(egovMessageSource.getMessage("fail.common.login")); return ApiResponseDTO.success(egovMessageSource.getMessage("fail.common.login"));
} }
@Operation(summary = "로그인(JWT)" , description = "로그인(JWT)")
@io.swagger.v3.oas.annotations.parameters.RequestBody( @io.swagger.v3.oas.annotations.parameters.RequestBody(
required = true, required = true,
content = { content = {
@ -102,19 +106,28 @@ public class AuthApiController {
@ExampleObject( @ExampleObject(
name = "admin", name = "admin",
description = "admin", description = "admin",
value = "{\"id\":\"admin\",\"password\":\"1\",\"userSe\":\"USR\"}"), value = """
{
"id": "admin",
"password": "1",
"userSe": "USR"
}
"""),
@ExampleObject( @ExampleObject(
name = "admin1", name = "admin1",
description = "admin1", description = "admin1",
value = "{\"id\":\"admin1\",\"password\":\"1\",\"userSe\":\"USR\"}"), value = """
@ExampleObject( {
name = "admin2", "id": "admin1",
description = "admin2", "password": "1",
value = "{\"id\":\"admin2\",\"password\":\"1\",\"userSe\":\"USR\"}") "userSe": "USR"
}
""")
} }
) )
} }
) )
@Operation(summary = "로그인(JWT)" , description = "로그인(JWT)")
@PostMapping(value = "/loginJwt") @PostMapping(value = "/loginJwt")
public ApiResponseDTO<?> loginJWT(@RequestBody final LoginVO loginVO, HttpServletRequest request) { public ApiResponseDTO<?> loginJWT(@RequestBody final LoginVO loginVO, HttpServletRequest request) {
HashMap<String, Object> resultMap = new HashMap<String, Object>(); HashMap<String, Object> resultMap = new HashMap<String, Object>();

4
mens-batch/src/main/java/kr/xit/biz/ens/mapper/IEnsBatchMapper.java
Unescape Escape View File

@ -17,11 +17,11 @@ import kr.xit.biz.ens.model.EnsDTO;
* packageName : kr.xit.biz.ens.mapper * packageName : kr.xit.biz.ens.mapper
* fileName : IEnsBatchMapper * fileName : IEnsBatchMapper
* author : limju * author : limju
* date : 2023-06-05 * date : 2023-08-31
* ====================================================================== * ======================================================================
* 변경일 변경자 변경 내용 * 변경일 변경자 변경 내용
* ---------------------------------------------------------------------- * ----------------------------------------------------------------------
* 2023-06-05 limju 최초 생성 * 2023-08-31 limju 최초 생성
* *
* </pre> * </pre>
*/ */

4
mens-batch/src/main/java/kr/xit/biz/ens/model/CntcDTO.java
Unescape Escape View File

@ -14,11 +14,11 @@ import lombok.experimental.SuperBuilder;
* packageName : kr.xit.biz.ens.model * packageName : kr.xit.biz.ens.model
* fileName : CntcDTO * fileName : CntcDTO
* author : limju * author : limju
* date : 2023-06-05 * date : 2023-08-31
* ====================================================================== * ======================================================================
* 변경일 변경자 변경 내용 * 변경일 변경자 변경 내용
* ---------------------------------------------------------------------- * ----------------------------------------------------------------------
* 2023-06-05 limju 최초 생성 * 2023-08-31 limju 최초 생성
* *
* </pre> * </pre>
*/ */

4
mens-batch/src/main/java/kr/xit/biz/ens/model/EnsDTO.java
Unescape Escape View File

@ -23,11 +23,11 @@ import javax.validation.constraints.Size;
* packageName : kr.xit.biz.ens.model * packageName : kr.xit.biz.ens.model
* fileName : EnsDTO * fileName : EnsDTO
* author : limju * author : limju
* date : 2023-06-05 * date : 2023-08-31
* ====================================================================== * ======================================================================
* 변경일 변경자 변경 내용 * 변경일 변경자 변경 내용
* ---------------------------------------------------------------------- * ----------------------------------------------------------------------
* 2023-06-05 limju 최초 생성 * 2023-08-31 limju 최초 생성
* *
* </pre> * </pre>
*/ */

4
mens-batch/src/main/java/kr/xit/biz/ens/service/EnsBatchService.java
Unescape Escape View File

@ -51,11 +51,11 @@ import javax.validation.Validator;
* packageName : kr.xit.biz.ens.service * packageName : kr.xit.biz.ens.service
* fileName : EnsBatchService * fileName : EnsBatchService
* author : limju * author : limju
* date : 2023-06-05 * date : 2023-08-31
* ====================================================================== * ======================================================================
* 변경일 변경자 변경 내용 * 변경일 변경자 변경 내용
* ---------------------------------------------------------------------- * ----------------------------------------------------------------------
* 2023-06-05 limju 최초 생성 * 2023-08-31 limju 최초 생성
* *
* </pre> * </pre>
*/ */

4
mens-batch/src/main/java/kr/xit/biz/ens/service/IEnsBatchService.java
Unescape Escape View File

@ -11,11 +11,11 @@ import kr.xit.biz.ens.model.EnsDTO;
* packageName : kr.xit.biz.ens.service * packageName : kr.xit.biz.ens.service
* fileName : IEnsBatchService * fileName : IEnsBatchService
* author : limju * author : limju
* date : 2023-06-05 * date : 2023-08-31
* ====================================================================== * ======================================================================
* 변경일 변경자 변경 내용 * 변경일 변경자 변경 내용
* ---------------------------------------------------------------------- * ----------------------------------------------------------------------
* 2023-06-05 limju 최초 생성 * 2023-08-31 limju 최초 생성
* *
* </pre> * </pre>
*/ */

118
mens-batch/src/main/java/kr/xit/biz/ens/web/ApiCallTestController.java
Unescape Escape View File

@ -30,11 +30,11 @@ import org.springframework.web.bind.annotation.RestController;
* packageName : kr.xit.biz.ens.web * packageName : kr.xit.biz.ens.web
* fileName : SendMessageLinkController * fileName : SendMessageLinkController
* author : limju * author : limju
* date : 2023-06-05 * date : 2023-08-31
* ====================================================================== * ======================================================================
* 변경일 변경자 변경 내용 * 변경일 변경자 변경 내용
* ---------------------------------------------------------------------- * ----------------------------------------------------------------------
* 2023-06-05 limju 최초 생성 * 2023-08-31 limju 최초 생성
* *
* </pre> * </pre>
*/ */
@ -63,32 +63,36 @@ public class ApiCallTestController {
* @param reqDTO * @param reqDTO
* @return ResponseEntity * @return ResponseEntity
*/ */
@Operation(summary = "문서발송 요청", description = "카카오페이 전자문서 서버로 문서발송 처리를 요청")
@io.swagger.v3.oas.annotations.parameters.RequestBody(required = true, content = { @io.swagger.v3.oas.annotations.parameters.RequestBody(required = true, content = {
@Content(mediaType = "application/json", examples = { @Content(mediaType = "application/json", examples = {
@ExampleObject(value = "{\"document\": {\n" @ExampleObject(value = """
+ " \"title\": \"문서 제목\",\n" {
+ " \"read_expired_sec\": 3600,\n" "document": {
+ " \"hash\": \"6EFE827AC88914DE471C621AE\",\n" "title": "문서 제목",
+ " \"common_categories\": [\n" "read_expired_sec": 3600,
+ " \"NOTICE\"\n" "hash": "6EFE827AC88914DE471C621AE",
+ " ],\n" "common_categories": [
+ " \"receiver\": {\n" "NOTICE"
+ " \"phone_number\": \"01093414345\",\n" ],
+ " \"name\": \"김지호\",\n" "receiver": {
+ " \"birthday\": \"19831218\",\n" "phone_number": "01093414345",
+ " \"is_required_verify_name\": false\n" "name": "김지호",
+ " },\n" "birthday": "19831218",
+ " \"property\": {\n" "is_required_verify_name": false
+ " \"link\": \"http://ip:8081/api/kakaopay/v1/ott\",\n" },
+ " \"cs_number\": \"02-123-4567\",\n" "property": {
+ " \"cs_name\": \"콜센터\",\n" "link": "http://ip:8081/api/kakaopay/v1/ott",
+ " \"payload\": \"payload 파라미터 입니다.\",\n" "cs_number": "02-123-4567",
+ " \"message\": \"해당 안내문은 다음과 같습니다.\"\n" "cs_name": "콜센터",
+ " }\n" "payload": "payload 파라미터 입니다.",
+ " }}") "message": "해당 안내문은 다음과 같습니다."
}
}
}
""")
}) })
}) })
@Operation(summary = "문서발송 요청", description = "카카오페이 전자문서 서버로 문서발송 처리를 요청")
@PostMapping(value = "/documents", produces = MediaType.APPLICATION_JSON_VALUE) @PostMapping(value = "/documents", produces = MediaType.APPLICATION_JSON_VALUE)
public ApiResponseDTO<?> requestSend( public ApiResponseDTO<?> requestSend(
@RequestBody final SendRequest reqDTO @RequestBody final SendRequest reqDTO
@ -116,32 +120,34 @@ public class ApiCallTestController {
@Operation(summary = "대량 문서발송 요청", description = "카카오페이 전자문서 서버로 대량 문서발송 처리를 요청") @Operation(summary = "대량 문서발송 요청", description = "카카오페이 전자문서 서버로 대량 문서발송 처리를 요청")
@io.swagger.v3.oas.annotations.parameters.RequestBody(required = true, content = { @io.swagger.v3.oas.annotations.parameters.RequestBody(required = true, content = {
@Content(mediaType = "application/json", examples = { @Content(mediaType = "application/json", examples = {
@ExampleObject(value = "{\n" @ExampleObject(value = """
+ " \"documents\": [\n" {
+ " {\n" "documents": [
+ " \"title\": \"문서 제목\",\n" {
+ " \"read_expired_sec\": 3600,\n" "title": "문서 제목",
+ " \"hash\": \"6EFE827AC88914DE471C621AE\",\n" "read_expired_sec": 3600,
+ " \"common_categories\": [\n" "hash": "6EFE827AC88914DE471C621AE",
+ " \"NOTICE\"\n" "common_categories": [
+ " ],\n" "NOTICE"
+ " \"receiver\": {\n" ],
+ " \"phone_number\": \"01093414345\",\n" "receiver": {
+ " \"name\": \"김지호\",\n" "phone_number": "01093414345",
+ " \"birthday\": \"19831218\",\n" "name": "김지호",
+ " \"is_required_verify_name\": false\n" "birthday": "19831218",
+ " },\n" "is_required_verify_name": false
+ " \"property\": {\n" },
+ " \"link\": \"http://ip:8081/api/kakaopay/v1/ott\",\n" "property": {
+ " \"cs_number\": \"02-123-4567\",\n" "link": "http://ip:8081/api/kakaopay/v1/ott",
+ " \"cs_name\": \"콜센터\",\n" "cs_number": "02-123-4567",
+ " \"payload\": \"payload 파라미터 입니다.\",\n" "cs_name": "콜센터",
+ " \"message\": \"해당 안내문은 다음과 같습니다.\",\n" "payload": "payload 파라미터 입니다.",
+ " \"external_document_uuid\": \"A000001\"\n" "message": "해당 안내문은 다음과 같습니다.",
+ " }\n" "external_document_uuid": "A000001"
+ " }\n" }
+ " ]\n" }
+ "}") ]
}
""")
}) })
}) })
@PostMapping(value = "/documents/bulk", produces = MediaType.APPLICATION_JSON_VALUE) @PostMapping(value = "/documents/bulk", produces = MediaType.APPLICATION_JSON_VALUE)
@ -168,11 +174,13 @@ public class ApiCallTestController {
*/ */
@io.swagger.v3.oas.annotations.parameters.RequestBody(required = true, content = { @io.swagger.v3.oas.annotations.parameters.RequestBody(required = true, content = {
@Content(mediaType = "application/json", examples = { @Content(mediaType = "application/json", examples = {
@ExampleObject(value = "{\n" @ExampleObject(value = """
+ " \"document_binder_uuids\": [\n" {
+ " \"BIN-883246dbff7b11edb3bb7affed8a016d\"\n" "document_binder_uuids": [
+ " ]\n" "BIN-883246dbff7b11edb3bb7affed8a016d"
+ "}") ]
}
""")
}) })
}) })
@Operation(summary = "대량 문서 상태 조회 요청", description = "카카오페이 전자문서 서버로 대량 문서 상태 조회 요청") @Operation(summary = "대량 문서 상태 조회 요청", description = "카카오페이 전자문서 서버로 대량 문서 상태 조회 요청")

4
mens-batch/src/main/java/kr/xit/biz/ens/web/EnsBatchController.java
Unescape Escape View File

@ -20,11 +20,11 @@ import lombok.RequiredArgsConstructor;
* packageName : kr.xit.biz.ens.web * packageName : kr.xit.biz.ens.web
* fileName : EnsBatchController * fileName : EnsBatchController
* author : limju * author : limju
* date : 2023-06-05 * date : 2023-08-31
* ====================================================================== * ======================================================================
* 변경일 변경자 변경 내용 * 변경일 변경자 변경 내용
* ---------------------------------------------------------------------- * ----------------------------------------------------------------------
* 2023-06-05 limju 최초 생성 * 2023-08-31 limju 최초 생성
* *
* </pre> * </pre>
*/ */

4
mens-batch/src/main/java/kr/xit/core/biz/model/AuditFields.java
Unescape Escape View File

@ -21,11 +21,11 @@ import lombok.experimental.SuperBuilder;
* packageName : kr.xit.core.biz.model * packageName : kr.xit.core.biz.model
* fileName : AuditFields * fileName : AuditFields
* author : limju * author : limju
* date : 2023-06-05 * date : 2023-08-31
* ====================================================================== * ======================================================================
* 변경일 변경자 변경 내용 * 변경일 변경자 변경 내용
* ---------------------------------------------------------------------- * ----------------------------------------------------------------------
* 2023-06-05 limju 최초 생성 * 2023-08-31 limju 최초 생성
* *
* </pre> * </pre>
*/ */

2
mens-core/README.md
Unescape Escape View File

@ -24,7 +24,7 @@ logging:
level: level:
root: debug root: debug
file: file:
path: D:/data/ens/logs path: D:/data/mens/logs
``` ```
### SQL 로그 : p6spy 또는 log4jdbc ### SQL 로그 : p6spy 또는 log4jdbc
```yml ```yml

2
mens-core/src/main/java/kr/xit/core/spring/config/custom/bouncy/BouncyUtils.java
Unescape Escape View File

@ -275,7 +275,7 @@ public class BouncyUtils {
// TODO::암호화할 속성 // TODO::암호화할 속성
public static void main(String[] args) throws Exception { public static void main(String[] args) throws Exception {
String path = "d:/data/ens/.pem/"; String path = "d:/data/mens/.pem/";
String macAddress = "00-21-5E-DB-59-36"; //dev mac IpMacUtils.getMacAddress("ip"); String macAddress = "00-21-5E-DB-59-36"; //dev mac IpMacUtils.getMacAddress("ip");
//String macAddress = "FC-34-97-15-04-44"; //local mac //String macAddress = "FC-34-97-15-04-44"; //local mac
String key = "mxLAM1fAEDPWkFz8"; String key = "mxLAM1fAEDPWkFz8";

4
mens-core/src/main/java/kr/xit/core/support/utils/SFTPUtils.java
Unescape Escape View File

@ -291,8 +291,8 @@ public class SFTPUtils {
System.out.println(fileNameList); System.out.println(fileNameList);
sftpUtil.mv( sftpUtil.mv(
"/data/ens/sg-pni-cctv/err/20230622111301_49고3736_174번카메라-UDP_101.jpg", "/data/mens/sg-pni-cctv/err/20230622111301_49고3736_174번카메라-UDP_101.jpg",
"/data/ens/sg-pni-cctv/rcv/20230622111301_49고3736_174번카메라-UDP_101.jpg" "/data/mens/sg-pni-cctv/rcv/20230622111301_49고3736_174번카메라-UDP_101.jpg"
); );
}catch(Exception e) { }catch(Exception e) {

Write Preview
Loading…
Cancel
Save