docs: Add standard Javadoc comments to all Java source files

This commit is contained in:
jade
2026-07-09 09:11:46 +09:00
parent 69d7a7bff0
commit 5e4f88ea41
147 changed files with 2259 additions and 115 deletions

View File

@@ -8,6 +8,20 @@ import io.shinhanlife.axhub.biz.mcp.tool.annotation.McpParameter;
import lombok.Getter;
import lombok.Setter;
/**
* @package io.shinhanlife.axhub.biz.mcp.tool.dto
* @className BillingProcessReq
* @description AX HUB 시스템 처리 클래스
* @author 김형식
* @create 2026.09.01
* <pre>
* ---------- 개정이력 ----------
* 수정일 수정자 수정내용
* ---------- -------- ---------------------------
* 2026.09.01 김형식 최초생성
*
* </pre>
*/
@Getter
@Setter
@Builder
@@ -20,4 +34,4 @@ public class BillingProcessReq {
@McpParameter(description = "심사 승인 여부 (예: APPROVE, REJECT)")
private String approvalStatus;
}
}

View File

@@ -8,6 +8,20 @@ import io.shinhanlife.axhub.biz.mcp.tool.annotation.McpParameter;
import lombok.Getter;
import lombok.Setter;
/**
* @package io.shinhanlife.axhub.biz.mcp.tool.dto
* @className BillingStatusReq
* @description AX HUB 시스템 처리 클래스
* @author 김형식
* @create 2026.09.01
* <pre>
* ---------- 개정이력 ----------
* 수정일 수정자 수정내용
* ---------- -------- ---------------------------
* 2026.09.01 김형식 최초생성
*
* </pre>
*/
@Getter
@Setter
@Builder
@@ -17,4 +31,4 @@ public class BillingStatusReq {
@McpParameter(description = "조회할 청구 접수 번호", required = true)
private String billingId;
}
}

View File

@@ -8,6 +8,20 @@ import io.shinhanlife.axhub.biz.mcp.tool.annotation.McpParameter;
import lombok.Getter;
import lombok.Setter;
/**
* @package io.shinhanlife.axhub.biz.mcp.tool.dto
* @className BondCheckReq
* @description AX HUB 시스템 처리 클래스
* @author 김형식
* @create 2026.09.01
* <pre>
* ---------- 개정이력 ----------
* 수정일 수정자 수정내용
* ---------- -------- ---------------------------
* 2026.09.01 김형식 최초생성
*
* </pre>
*/
@Getter
@Setter
@Builder
@@ -17,4 +31,4 @@ public class BondCheckReq {
@McpParameter(description = "확인하고자 하는 디지털 증권 발행 금액", required = true)
private Long amount;
}
}

View File

@@ -8,6 +8,20 @@ import io.shinhanlife.axhub.biz.mcp.tool.annotation.McpParameter;
import lombok.Getter;
import lombok.Setter;
/**
* @package io.shinhanlife.axhub.biz.mcp.tool.dto
* @className BondIssueReq
* @description AX HUB 시스템 처리 클래스
* @author 김형식
* @create 2026.09.01
* <pre>
* ---------- 개정이력 ----------
* 수정일 수정자 수정내용
* ---------- -------- ---------------------------
* 2026.09.01 김형식 최초생성
*
* </pre>
*/
@Getter
@Setter
@Builder
@@ -20,4 +34,4 @@ public class BondIssueReq {
@McpParameter(description = "발행 대상 계좌 번호", required = true)
private String targetAccount;
}
}

View File

@@ -8,6 +8,20 @@ import io.shinhanlife.axhub.biz.mcp.tool.annotation.McpParameter;
import lombok.Getter;
import lombok.Setter;
/**
* @package io.shinhanlife.axhub.biz.mcp.tool.dto
* @className ContractDetailReq
* @description AX HUB 시스템 처리 클래스
* @author 김형식
* @create 2026.09.01
* <pre>
* ---------- 개정이력 ----------
* 수정일 수정자 수정내용
* ---------- -------- ---------------------------
* 2026.09.01 김형식 최초생성
*
* </pre>
*/
@Getter
@Setter
@Builder
@@ -20,4 +34,4 @@ public class ContractDetailReq {
@McpParameter(description = "조회할 계약 번호", required = true)
private String contractId;
}
}

View File

@@ -8,6 +8,20 @@ import io.shinhanlife.axhub.biz.mcp.tool.annotation.McpParameter;
import lombok.Getter;
import lombok.Setter;
/**
* @package io.shinhanlife.axhub.biz.mcp.tool.dto
* @className ContractStatusReq
* @description AX HUB 시스템 처리 클래스
* @author 김형식
* @create 2026.09.01
* <pre>
* ---------- 개정이력 ----------
* 수정일 수정자 수정내용
* ---------- -------- ---------------------------
* 2026.09.01 김형식 최초생성
*
* </pre>
*/
@Getter
@Setter
@Builder
@@ -20,4 +34,4 @@ public class ContractStatusReq {
@McpParameter(description = "조회할 계약 번호")
private String contractId;
}
}

View File

@@ -8,6 +8,20 @@ import io.shinhanlife.axhub.biz.mcp.tool.annotation.McpParameter;
import lombok.Getter;
import lombok.Setter;
/**
* @package io.shinhanlife.axhub.biz.mcp.tool.dto
* @className CustomerDetailReq
* @description AX HUB 시스템 처리 클래스
* @author 김형식
* @create 2026.09.01
* <pre>
* ---------- 개정이력 ----------
* 수정일 수정자 수정내용
* ---------- -------- ---------------------------
* 2026.09.01 김형식 최초생성
*
* </pre>
*/
@Getter
@Setter
@Builder
@@ -20,4 +34,4 @@ public class CustomerDetailReq {
@McpParameter(description = "고객 식별 번호 (CID)")
private String customerId;
}
}

View File

@@ -8,6 +8,20 @@ import io.shinhanlife.axhub.biz.mcp.tool.annotation.McpParameter;
import lombok.Getter;
import lombok.Setter;
/**
* @package io.shinhanlife.axhub.biz.mcp.tool.dto
* @className CustomerGradeReq
* @description AX HUB 시스템 처리 클래스
* @author 김형식
* @create 2026.09.01
* <pre>
* ---------- 개정이력 ----------
* 수정일 수정자 수정내용
* ---------- -------- ---------------------------
* 2026.09.01 김형식 최초생성
*
* </pre>
*/
@Getter
@Setter
@Builder
@@ -20,4 +34,4 @@ public class CustomerGradeReq {
@McpParameter(description = "고객 식별 번호 (CID)")
private String customerId;
}
}

View File

@@ -8,6 +8,20 @@ import io.shinhanlife.axhub.biz.mcp.tool.annotation.McpParameter;
import lombok.Getter;
import lombok.Setter;
/**
* @package io.shinhanlife.axhub.biz.mcp.tool.dto
* @className LeaveCountReq
* @description AX HUB 시스템 처리 클래스
* @author 김형식
* @create 2026.09.01
* <pre>
* ---------- 개정이력 ----------
* 수정일 수정자 수정내용
* ---------- -------- ---------------------------
* 2026.09.01 김형식 최초생성
*
* </pre>
*/
@Getter
@Setter
@Builder
@@ -17,4 +31,4 @@ public class LeaveCountReq {
@McpParameter(description = "연차 내역을 조회할 사원 번호", required = true)
private String employeeId;
}
}

View File

@@ -7,6 +7,20 @@ import lombok.Getter;
import lombok.NoArgsConstructor;
import lombok.ToString;
/**
* @package io.shinhanlife.axhub.biz.mcp.tool.dto
* @className TemplateDownloadReq
* @description AX HUB 시스템 처리 클래스
* @author 김형식
* @create 2026.09.01
* <pre>
* ---------- 개정이력 ----------
* 수정일 수정자 수정내용
* ---------- -------- ---------------------------
* 2026.09.01 김형식 최초생성
*
* </pre>
*/
@Getter
@Builder
@ToString
@@ -18,4 +32,4 @@ public class TemplateDownloadReq {
* 다운로드할 템플릿의 종류 ID (예: CUSTOMER_EXCEL, PRODUCT_PDF 등)
*/
private String templateId;
}
}

View File

@@ -8,6 +8,20 @@ import io.shinhanlife.axhub.biz.mcp.tool.annotation.McpParameter;
import lombok.Getter;
import lombok.Setter;
/**
* @package io.shinhanlife.axhub.biz.mcp.tool.dto
* @className VacationRegisterReq
* @description AX HUB 시스템 처리 클래스
* @author 김형식
* @create 2026.09.01
* <pre>
* ---------- 개정이력 ----------
* 수정일 수정자 수정내용
* ---------- -------- ---------------------------
* 2026.09.01 김형식 최초생성
*
* </pre>
*/
@Getter
@Setter
@Builder
@@ -20,4 +34,4 @@ public class VacationRegisterReq {
@McpParameter(description = "휴가 일자 (YYYY-MM-DD 형식)", required = true)
private String date;
}
}

View File

@@ -4,6 +4,20 @@ import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cache.annotation.EnableCaching;
/**
* @package io.shinhanlife.axhub.biz.mcp.tool.other
* @className AxHubToolOtherApplication
* @description AX HUB 시스템 처리 클래스
* @author 김형식
* @create 2026.09.01
* <pre>
* ---------- 개정이력 ----------
* 수정일 수정자 수정내용
* ---------- -------- ---------------------------
* 2026.09.01 김형식 최초생성
*
* </pre>
*/
@SpringBootApplication(scanBasePackages = {"io.shinhanlife.axhub.biz.mcp.tool", "io.shinhanlife.axhub.biz.mcp.adapter", "io.shinhanlife.axhub.common.mcp", "io.shinhanlife.axhub.common.config"})
@org.springframework.boot.context.properties.ConfigurationPropertiesScan(basePackages = {"io.shinhanlife.axhub.biz.mcp.tool", "io.shinhanlife.axhub.biz.mcp.adapter", "io.shinhanlife.axhub.common.mcp", "io.shinhanlife.axhub.common.config"})
@EnableCaching
@@ -11,4 +25,4 @@ public class AxHubToolOtherApplication {
public static void main(String[] args) {
SpringApplication.run(AxHubToolOtherApplication.class, args);
}
}
}

View File

@@ -13,6 +13,20 @@ import io.shinhanlife.axhub.biz.mcp.tool.dto.BillingProcessReq;
routingType = "MCI",
group = "CLAIM"
)
/**
* @package io.shinhanlife.axhub.biz.mcp.tool.service
* @className BillingProcessService
* @description AX HUB 시스템 처리 클래스
* @author 김형식
* @create 2026.09.01
* <pre>
* ---------- 개정이력 ----------
* 수정일 수정자 수정내용
* ---------- -------- ---------------------------
* 2026.09.01 김형식 최초생성
*
* </pre>
*/
@lombok.extern.slf4j.Slf4j
public class BillingProcessService extends AbstractMcpToolService {
@@ -50,4 +64,4 @@ public class BillingProcessService extends AbstractMcpToolService {
}
return result;
}
}
}

View File

@@ -9,6 +9,20 @@ import io.shinhanlife.axhub.biz.mcp.tool.dto.BondIssueReq;
routingType = "EAI",
group = "POLICY"
)
/**
* @package io.shinhanlife.axhub.biz.mcp.tool.service
* @className BondIssueService
* @description AX HUB 시스템 처리 클래스
* @author 김형식
* @create 2026.09.01
* <pre>
* ---------- 개정이력 ----------
* 수정일 수정자 수정내용
* ---------- -------- ---------------------------
* 2026.09.01 김형식 최초생성
*
* </pre>
*/
public class BondIssueService extends AbstractMcpToolService {
@McpFunction(name = "check", description = "발행 가능 여부 조회", prompt = "디지털 증권 발행 한도가 충분한지 확인해줘.", mappingId = "BOND_001")
@@ -20,4 +34,4 @@ public class BondIssueService extends AbstractMcpToolService {
public Object issue(BondIssueReq data) {
return executeLegacy("EAI", "BOND_002", data);
}
}
}

View File

@@ -10,6 +10,20 @@ import io.shinhanlife.axhub.biz.mcp.tool.dto.LeaveCountReq;
routingType = "HTTP",
group = "HR"
)
/**
* @package io.shinhanlife.axhub.biz.mcp.tool.service
* @className CommonUtilityService
* @description AX HUB 시스템 처리 클래스
* @author 김형식
* @create 2026.09.01
* <pre>
* ---------- 개정이력 ----------
* 수정일 수정자 수정내용
* ---------- -------- ---------------------------
* 2026.09.01 김형식 최초생성
*
* </pre>
*/
public class CommonUtilityService extends AbstractMcpToolService {
@McpFunction(name = "register_vacation", description = "휴가 등록", prompt = "내일 하루 연차 휴가를 등록해줘.", mappingId = "HR_VAC_01")
@@ -22,4 +36,4 @@ public class CommonUtilityService extends AbstractMcpToolService {
return executeLegacy("HTTP", "HR_VAC_02", data);
}
}
}

View File

@@ -9,6 +9,20 @@ import io.shinhanlife.axhub.biz.mcp.tool.dto.ContractDetailReq;
routingType = "HTTP",
group = "CONTRACT"
)
/**
* @package io.shinhanlife.axhub.biz.mcp.tool.service
* @className ContractInquiryService
* @description AX HUB 시스템 처리 클래스
* @author 김형식
* @create 2026.09.01
* <pre>
* ---------- 개정이력 ----------
* 수정일 수정자 수정내용
* ---------- -------- ---------------------------
* 2026.09.01 김형식 최초생성
*
* </pre>
*/
public class ContractInquiryService extends AbstractMcpToolService {
@McpFunction(name = "contract_status", description = "계약상태 조회", prompt = "김신한 고객의 현재 계약 상태를 조회해줘.", mappingId = "CNTR_001")
@@ -20,4 +34,4 @@ public class ContractInquiryService extends AbstractMcpToolService {
public Object getDetail(ContractDetailReq data) {
return executeLegacy("HTTP", "CNTR_002", data);
}
}
}

View File

@@ -9,6 +9,20 @@ import io.shinhanlife.axhub.biz.mcp.tool.dto.CustomerDetailReq;
routingType = "TCP",
group = "CUSTOMER"
)
/**
* @package io.shinhanlife.axhub.biz.mcp.tool.service
* @className CustomerInfoService
* @description AX HUB 시스템 처리 클래스
* @author 김형식
* @create 2026.09.01
* <pre>
* ---------- 개정이력 ----------
* 수정일 수정자 수정내용
* ---------- -------- ---------------------------
* 2026.09.01 김형식 최초생성
*
* </pre>
*/
public class CustomerInfoService extends AbstractMcpToolService {
@McpFunction(name = "grade", description = "고객등급 조회", prompt = "이 고객의 VIP 등급을 조회해줘.", mappingId = "CRM_001")
@@ -20,4 +34,4 @@ public class CustomerInfoService extends AbstractMcpToolService {
public Object getDetail(CustomerDetailReq data) {
return executeLegacy("TCP", "CRM_002", data);
}
}
}

View File

@@ -11,6 +11,20 @@ import java.util.Map;
routingType = "HTTP",
group = "COMMON"
)
/**
* @package io.shinhanlife.axhub.biz.mcp.tool.service
* @className TemplateUtilityService
* @description AX HUB 시스템 처리 클래스
* @author 김형식
* @create 2026.09.01
* <pre>
* ---------- 개정이력 ----------
* 수정일 수정자 수정내용
* ---------- -------- ---------------------------
* 2026.09.01 김형식 최초생성
*
* </pre>
*/
public class TemplateUtilityService extends AbstractMcpToolService {
@McpFunction(
@@ -39,4 +53,4 @@ public class TemplateUtilityService extends AbstractMcpToolService {
throw new RuntimeException("템플릿 URL 생성 실패", e);
}
}
}
}