주석 추가

This commit is contained in:
Kang Jung Kyo 2024-11-07 15:57:37 +09:00
parent 6c45592b0f
commit 16e32421a8
2 changed files with 70 additions and 4 deletions

View File

@ -47,6 +47,13 @@ public class LoginController {
String autoLoginAesKey;
/**
* Q.CAST III에 로그인하여 사용자 정보를 획득한다.
*
* @param loginUser LoginUser
* @return UserLoginResponse
* @throws Exception
*/
@Operation(description = "Q.CAST III에 로그인하여 사용자 정보를 획득한다.")
@PostMapping("/v1.0/login")
@ResponseStatus(HttpStatus.CREATED)
@ -60,6 +67,13 @@ public class LoginController {
return loginService.getUser(loginUser);
}
/**
* 가입 신청 정보를 등록한다.
*
* @param joinUser JoinUser
* @return DefaultResponse
* @throws Exception
*/
@Operation(description = "가입 신청 정보를 등록한다.")
@PostMapping("/v1.0/user/join")
@ResponseStatus(HttpStatus.CREATED)
@ -67,18 +81,39 @@ public class LoginController {
return loginService.joinUser(joinUser);
}
/**
* 비밀번호를 초기화한다.
*
* @param userPassword UserPassword
* @return DefaultResponse
* @throws Exception
*/
@Operation(description = "비밀번호를 초기화한다.")
@PatchMapping("/v1.0/user/init-password")
public DefaultResponse initPassword(@RequestBody UserPassword userPassword) throws Exception {
return loginService.initPassword(userPassword);
}
/**
* 비밀번호를 변경한다.
*
* @param userPassword UserPassword
* @return DefaultResponse
* @throws Exception
*/
@Operation(description = "비밀번호를 변경한다.")
@PatchMapping("/v1.0/user/change-password")
public DefaultResponse changePassword(@RequestBody UserPassword userPassword) throws Exception {
return loginService.changePassword(userPassword);
}
/**
* 자동 로그인에 사용하는 아이디를 암호화한다.
*
* @param loginUser LoginUser
* @return String
* @throws Exception
*/
@Operation(description = "자동 로그인에 사용하는 아이디를 암호화한다.")
@PostMapping("/v1.0/user/login/autoLoginEncryptData")
public String getAutoLoginEncryptData(@RequestBody LoginUser loginUser) throws Exception {
@ -116,6 +151,13 @@ public class LoginController {
return loginEncryptId;
}
/**
* 자동 로그인에 사용하는 아이디를 복호화한다.
*
* @param loginUser LoginUser
* @return String
* @throws Exception
*/
@Operation(description = "자동 로그인에 사용하는 아이디를 복호화한다.")
@PostMapping("/v1.0/user/login/autoLoginDecryptData")
public String getAutoLoginDecryptData(@RequestBody LoginUser loginUser) throws Exception {

View File

@ -33,7 +33,13 @@ public class LoginService {
@Autowired
Messages message;
// 로그인 처리
/**
* 로그인 처리
*
* @param loginUser LoginUser
* @return UserLoginResponse
* @throws Exception
*/
public UserLoginResponse getLogin(LoginUser loginUser) throws Exception {
if (loginUser.getLoginId() == null || "".equals(loginUser.getLoginId()))
throw new QcastException(ErrorCode.INVALID_INPUT_VALUE,
@ -64,7 +70,13 @@ public class LoginService {
return loginMapper.getUser(loginUser);
}
// 가입 신청 등록
/**
* 가입 신청 등록
*
* @param joinUser JoinUser
* @return DefaultResponse
* @throws Exception
*/
public DefaultResponse joinUser(JoinUser joinUser) throws Exception {
if (joinUser.getStoreQcastNm() == null || "".equals(joinUser.getStoreQcastNm()))
throw new QcastException(ErrorCode.INVALID_INPUT_VALUE,
@ -131,7 +143,13 @@ public class LoginService {
return defaultResponse;
}
// 비밀번호 초기화
/**
* 비밀번호 초기화
*
* @param userPassword UserPassword
* @return DefaultResponse
* @throws Exception
*/
public DefaultResponse initPassword(UserPassword userPassword) throws Exception {
if (userPassword.getLoginId() == null || "".equals(userPassword.getLoginId()))
throw new QcastException(ErrorCode.INVALID_INPUT_VALUE,
@ -157,7 +175,13 @@ public class LoginService {
return defaultResponse;
}
// 비밀번호 변경
/**
* 비밀번호 변경
*
* @param userPassword UserPassword
* @return DefaultResponse
* @throws Exception
*/
public DefaultResponse changePassword(UserPassword userPassword) throws Exception {
if (userPassword.getLoginId() == null || "".equals(userPassword.getLoginId()))
throw new QcastException(ErrorCode.INVALID_INPUT_VALUE,