diff --git a/src/main/java/cokr/xit/base/security/access/dao/ActionGroupMapper.java b/src/main/java/cokr/xit/base/security/access/dao/ActionGroupMapper.java index 624b829..3f30723 100644 --- a/src/main/java/cokr/xit/base/security/access/dao/ActionGroupMapper.java +++ b/src/main/java/cokr/xit/base/security/access/dao/ActionGroupMapper.java @@ -15,20 +15,24 @@ import cokr.xit.foundation.data.DataObject; */ @Mapper("actionGroupMapper") public interface ActionGroupMapper extends AbstractMapper { - /**주어진 조건에 따라 기능 그룹 목록을 조회한다. - * @param by 조건 필드 이름 - *
{
- * "authIDs": 권한 아이디(배열),
- * "groupIDs": 기능그룹 아이디(배열)
- * }
* @return 저장된 정보수
*/
int removeUsers(Map {
- * "groupList": 기능 그룹 목록,
+ * "groupList": [기능 그룹 목록],
* "groupStart": 목록 시작 인덱스,
* "groupFetch": 한 번에 가져오는 기능 그룹 정보수,
* "groupTotal": 조회 결과 찾은 기능 그룹 전체 수
@@ -68,7 +64,7 @@ public class ActionGroupController extends AbstractController {
}
/**사용자의 기능 그룹 선택을 위한 화면을 연다.
- * @return "actionGroup/select"
+ * @return base/actionGroup/select-actionGroup
*/
@RequestMapping(name="기능 그룹 선택", value="/select.do")
public ModelAndView select(boolean multiple) {
@@ -83,7 +79,7 @@ public class ActionGroupController extends AbstractController {
* @param groupID 기능 그룹 아이디
* @return jsonView
* {
- * "duplicate": true || false
+ * "duplicate": 중복이면 true, 그렇지 않으면false
* }
*/
@RequestMapping(name="중복 확인", value="/duplicate.do")
@@ -93,14 +89,17 @@ public class ActionGroupController extends AbstractController {
.addObject("duplicate", group != null);
}
+ /**주어진 아이디의 기능 그룹 정보를 반환한다.
+ * @param groupID 기능 그룹 아이디
+ * @return base/actionGroup/actionGroup-info 또는 jsonView
+ * {
+ * "groupInfo": 기능 그룹 정보
+ * }
+ */
@RequestMapping(name="기능 그룹 정보 조회", value="/info.do")
public ModelAndView getInfo(String groupID) {
if (!isEmpty(groupID)) {
- ActionQuery req = new ActionQuery()
- .setBy("groupID")
- .setTerm(groupID);
- List groupList = actionGroupService.getGroupList(req);
- DataObject groupInfo = !groupList.isEmpty() ? groupList.get(0) : null;
+ DataObject groupInfo = actionGroupService.getGroupInfo(groupID);
boolean json = jsonResponse();
return new ModelAndView(json ? "jsonView" : "base/actionGroup/actionGroup-info")
.addObject("groupInfo", json ? groupInfo : toJson(groupInfo));
@@ -113,7 +112,7 @@ public class ActionGroupController extends AbstractController {
* @param group 기능 그룹
* @return jsonView
* {
- * "saved": true || false
+ * "saved": 저장됐으면 true, 그렇지 않으면 false
* }
*/
@PostMapping(name="기능 그룹 등록", value="/create.do")
@@ -127,7 +126,7 @@ public class ActionGroupController extends AbstractController {
* @param group 기능 그룹
* @return jsonView
* {
- * "saved": true || false
+ * "saved": 저장됐으면 true, 그렇지 않으면 false
* }
*/
@PostMapping(name="기능 그룹 수정", value="/update.do")
@@ -142,7 +141,7 @@ public class ActionGroupController extends AbstractController {
* @return jsonView
* {
* "affected": 저장된 정보수,
- * "saved": true || false
+ * "saved": 저장됐으면 true, 그렇지 않으면 false
* }
*/
@PostMapping(name="기능 그룹 삭제", value="/remove.do")
@@ -153,11 +152,15 @@ public class ActionGroupController extends AbstractController {
.addObject("saved", affected > 0);
}
- /**지정하는 그룹의 기능 목록을 조회한다.
- * @param groupID 기능 그룹 아이디
+ /**지정하는 그룹의 기능 목록을 조회한다.
+ * {@link ActionGroupService#getActionList(ActionQuery)} 참고
+ * @param req 기능 목록 조회 조건
* @return jsonView
* {
- * "actionList": [...]
+ * "actionList": [기능 목록],
+ * "actionStart": 페이지 목록 시작 인덱스,
+ * "actionFetch": 페이지 목록 건수,
+ * "actionTotal": 조회 결과 찾은 전체 기능 목록수
* }
*/
@RequestMapping(name="기능 그룹별 기능(URL) 조회", value="/action/list.do")
@@ -176,7 +179,7 @@ public class ActionGroupController extends AbstractController {
* @return jsonView
* {
* "affected": 저장된 정보수,
- * "saved": true || false
+ * "saved": 저장됐으면 true, 그렇지 않으면 false
* }
*/
@RequestMapping(name="기능 그룹별 기능(URL) 추가", value="/action/add.do")
@@ -193,7 +196,7 @@ public class ActionGroupController extends AbstractController {
* @return jsonView
* {
* "affected": 저장된 정보수,
- * "saved": true || false
+ * "saved": 저장됐으면 true, 그렇지 않으면 false
* }
*/
@RequestMapping(name="기능 그룹별 기능(URL) 삭제", value="/action/remove.do")
diff --git a/src/main/java/cokr/xit/base/security/access/web/AuthorityController.java b/src/main/java/cokr/xit/base/security/access/web/AuthorityController.java
index 80347b0..90850f4 100644
--- a/src/main/java/cokr/xit/base/security/access/web/AuthorityController.java
+++ b/src/main/java/cokr/xit/base/security/access/web/AuthorityController.java
@@ -1,7 +1,5 @@
package cokr.xit.base.security.access.web;
-import java.util.List;
-
import javax.annotation.Resource;
import org.springframework.web.bind.annotation.PostMapping;
@@ -32,7 +30,7 @@ public class AuthorityController extends AbstractController {
/**권한 관리 메인 화면을 연다.
* 이 때 권한 목록 정보를 같이 보낸다.
- * @return "authority/authority-main"
+ * @return base/authority/authority-main
*/
@RequestMapping(name="권한 메인", value="/main.do")
public ModelAndView main() {
@@ -41,16 +39,12 @@ public class AuthorityController extends AbstractController {
return mav.addObject("authorityList", toJson(mav.getModel().remove("authorityList")));
}
- /**주어진 조건의 권한 목록을 조회한다.
- * @param by 조건 필드 이름
- * - authID - 권한 아이디
- * - 그 외는 권한 이름
- *
- * @param term 조건 필드값
- * @param pageNum 시작 페이지 번호
+ /**주어진 조건의 권한 목록을 조회한다.
+ * {@link AuthorityService#getAuthorityList(AuthorityQuery)} 참고
+ * @param req 조회 조건
* @return jsonView
- * {
- * "authorityList": 권한 목록,
+ * {
+ * "authorityList": [권한 목록],
* "authorityStart": 권한 목록 시작 인덱스,
* "authorityFetch": 한 번에 가져오는 권한 정보수,
* "authorityTotal": 조회로 찾은 전체 권한수
@@ -69,8 +63,8 @@ public class AuthorityController extends AbstractController {
/**지정한 권한 아이디가 중복된 것인지 확인한다.
* @param authID 권한 아이디
* @return jsonView
- * {
- * "duplicate": true || false
+ * {
+ * "duplicate": 중복이면 true, 그렇지 않으면 false
* }
*/
@RequestMapping(name="중복 확인", value="/duplicate.do")
@@ -80,14 +74,17 @@ public class AuthorityController extends AbstractController {
.addObject("duplicate", authority != null);
}
+ /**주어진 아이디의 권한 정보를 반환한다.
+ * @param authID 권한 아이디
+ * @return base/authority/authority-info 또는 jsonView
+ * {
+ * "authorityInfo": 권한 정보
+ * }
+ */
@RequestMapping(name="권한 정보 조회", value="/info.do")
public ModelAndView getInfo(String authID) {
if (!isEmpty(authID)) {
- AuthorityQuery req = new AuthorityQuery()
- .setBy("authID")
- .setTerm(authID);
- List authList = authorityService.getAuthorityList(req);
- DataObject authInfo = !authList.isEmpty() ? authList.get(0) : null;
+ DataObject authInfo = authorityService.getAuthorityInfo(authID);
boolean json = jsonResponse();
return new ModelAndView(json ? "jsonView" : "base/authority/authority-info")
.addObject("authorityInfo", json ? authInfo : toJson(authInfo));
@@ -99,8 +96,8 @@ public class AuthorityController extends AbstractController {
/**권한을 등록한다.
* @param authority 권한
* @return jsonView
- * {
- * "saved": true || false
+ * {
+ * "saved": 저장됐으면 true, 그렇지 않으면 false
* }
*/
@PostMapping(name="권한 등록", value="/create.do")
@@ -113,8 +110,8 @@ public class AuthorityController extends AbstractController {
/**권한을 수정한다.
* @param authority 권한
* @return jsonView
- * {
- * "saved": true || false
+ * {
+ * "saved": 저장됐으면 true, 그렇지 않으면 false
* }
*/
@PostMapping(name="권한 수정", value="/update.do")
@@ -127,9 +124,9 @@ public class AuthorityController extends AbstractController {
/**지정하는 권한들을 삭제한다.
* @param authIDs 권한 아이디
* @return jsonView
- * {
+ * {
* "affected": 저장된 정보수,
- * "saved": true || false
+ * "saved": 저장됐으면 true, 그렇지 않으면 false
* }
*/
@PostMapping(name="권한 삭제", value="/remove.do")
@@ -140,11 +137,11 @@ public class AuthorityController extends AbstractController {
.addObject("saved", affected > 0);
}
- /**지정하는 권한의 기능 그룹 목록을 조회한다.
- * @param pageNum 시작 페이지 번호
- * @param authIDs 권한 아이디
+ /**지정하는 권한의 기능 그룹 목록을 조회한다.
+ * {@link AuthorityService#getActionGroupList(AuthorityQuery)} 참고
+ * @param req 조회 조건
* @return jsonView
- * {
+ * {
* "actionList": 기능 목록,
* "actionStart": 기능 목록 시작 인덱스,
* "actionFetch": 한 번에 가져오는 기능 정보수,
@@ -165,9 +162,9 @@ public class AuthorityController extends AbstractController {
* @param authID 권한 아이디
* @param groupIDs 기능 그룹 아이디
* @return jsonView
- * {
+ * {
* "affected": 저장된 정보수,
- * "saved": true || false
+ * "saved": 저장됐으면 true, 그렇지 않으면 false
* }
*/
@PostMapping(name="권한별 기능 추가", value="/action/add.do")
@@ -183,7 +180,7 @@ public class AuthorityController extends AbstractController {
* @param authID 권한 아이디
* @param groupIDs 기능 그룹 아이디
* @return jsonView
- * {
+ * {
* "affected": 저장된 정보수,
* "saved": true || false
* }
@@ -196,11 +193,11 @@ public class AuthorityController extends AbstractController {
.addObject("saved", affected > 0);
}
- /**지정하는 권한의 사용자 목록을 조회한다.
- * @param pageNum 시작 페이지 번호
- * @param authIDs 권한 아이디
+ /**지정하는 권한의 사용자 목록을 조회한다.
+ * {@link AuthorityService#getUserList(AuthorityQuery)} 참고
+ * @param req 조회 조건
* @return jsonView
- * {
+ * {
* "userList": 사용자 목록,
* "userStart": 사용자 목록 시작 인덱스,
* "userFetch": 한 번에 가져오는 사용자 정보수,
@@ -221,9 +218,9 @@ public class AuthorityController extends AbstractController {
* @param authID 권한 아이디
* @param userIDs 사용자 아이디
* @return jsonView
- * {
+ * {
* "affected": 저장된 정보수,
- * "saved": true || false
+ * "saved": 저장됐으면 true, 그렇지 않으면 false
* }
*/
@PostMapping(name="권한별 사용자 추가", value="/user/add.do")
@@ -239,9 +236,9 @@ public class AuthorityController extends AbstractController {
* @param authID 권한 아이디
* @param userIDs 사용자 아이디
* @return jsonView
- * {
+ * {
* "affected": 저장된 정보수,
- * "saved": true || false
+ * "saved": 저장됐으면 true, 그렇지 않으면 false
* }
*/
@PostMapping(name="권한별 사용자 삭제", value="/user/remove.do")
diff --git a/src/main/java/cokr/xit/base/security/authentication/dao/PolicyMapper.java b/src/main/java/cokr/xit/base/security/authentication/dao/PolicyMapper.java
index 949dcf2..d501eb9 100644
--- a/src/main/java/cokr/xit/base/security/authentication/dao/PolicyMapper.java
+++ b/src/main/java/cokr/xit/base/security/authentication/dao/PolicyMapper.java
@@ -15,20 +15,15 @@ import cokr.xit.foundation.data.DataObject;
*/
@Mapper("policyMapper")
public interface PolicyMapper extends AbstractMapper {
- /**주어진 조건의 사용자 인증 정책 목록을 반환한다.
- * @param by 조건 필드 이름
- * - userName - 사용자 이름
- * - 그 이외는 사용자 아이디
- *
- * @param term 조건 필드값
- * @param pageNum 페이지 이름
- * @param fetchSize 한 번에 가져올 인증 정책 갯수
+ /**주어진 조건의 사용자 인증 정책 목록을 반환한다.
+ * {@link cokr.xit.base.security.authentication.service.AuthenticationService#getPolicyList(QueryRequest)} 참고
+ * @param req 사용자 인증 정책 조회 조건
* @return 사용자 인증 정책 목록
*/
List getPolicyList(QueryRequest req);
/**지정한 사용자들의 인증 정책 목록을 가져온다.
- * @param userIDs 사용자 아이디
+ * @param params 파라미터
* @return 인증 정책 목록
*/
List getPolicies(Map params);
@@ -78,11 +73,8 @@ public interface PolicyMapper extends AbstractMapper {
}
/**인증 정책을 수정한다.
- * @param policy 인증 정책
- * @return 수정 여부
- * - 수정 되었으면 true
- * - 그렇지 않으면 false
- *
+ * @param params 파라미터
+ * @return 저장된 정보수
*/
int updatePolicy(Map params);
@@ -103,7 +95,7 @@ public interface PolicyMapper extends AbstractMapper {
}
/**지정한 사용자의 인증 정책을 제거한다.
- * @param userIDs 사용자 아이디
+ * @param params 파라미터
* @return 저장된 정보수
*/
int removePolicy(Map params);
diff --git a/src/main/java/cokr/xit/base/security/authentication/service/AuthenticationService.java b/src/main/java/cokr/xit/base/security/authentication/service/AuthenticationService.java
index 655ac99..30b17e4 100644
--- a/src/main/java/cokr/xit/base/security/authentication/service/AuthenticationService.java
+++ b/src/main/java/cokr/xit/base/security/authentication/service/AuthenticationService.java
@@ -12,7 +12,7 @@ import cokr.xit.foundation.data.DataObject;
/**사용자 인증 서비스를 제공한다.
* - 사용자 로그인 및 로그아웃 관련 핸들러 메소드
- * - {@link #getPolicyList(String, String, int, int) 사용자 인증 정책 조회}
+ * - {@link #getPolicyList(QueryRequest) 사용자 인증 정책 조회}
* - {@link #create(AuthenticationPolicy) 사용자 인증 정책 등록}
* - {@link #update(AuthenticationPolicy) 사용자 인증 정책 수정}
* - {@link #removePolicies(String...) 사용자 인증 정책 제거}
@@ -36,13 +36,16 @@ public interface AuthenticationService extends UserDetailsService {
void onLogout(Authentication authentication);
/**주어진 조건의 사용자 인증 정책 목록을 반환한다.
- * @param by 조건 필드 이름
- * - userName - 사용자 이름
- * - 그 이외는 사용자 아이디
+ * @param req 사용자 인증 정책 조회 조건
+ * - by: 조건 필드 이름
+ *
- userName - 사용자 이름
+ * - 그 외는 사용자 아이디
+ *
+ *
+ * - term: 조건 필드값
+ * - pageNum: 페이지 번호
+ * - fetchSize: 페이지 목록 건수
*
- * @param term 조건 필드값
- * @param pageNum 페이지 이름
- * @param fetchSize 한 번에 가져올 인증 정책 갯수
* @return 사용자 인증 정책 목록
*/
List getPolicyList(QueryRequest req);
diff --git a/src/main/java/cokr/xit/base/security/authentication/service/bean/AuthenticationBean.java b/src/main/java/cokr/xit/base/security/authentication/service/bean/AuthenticationBean.java
index ae66fc5..8acd7a1 100644
--- a/src/main/java/cokr/xit/base/security/authentication/service/bean/AuthenticationBean.java
+++ b/src/main/java/cokr/xit/base/security/authentication/service/bean/AuthenticationBean.java
@@ -17,7 +17,7 @@ import cokr.xit.foundation.User;
import cokr.xit.foundation.component.QueryRequest;
import cokr.xit.foundation.data.DataObject;
-/**사용자 인증 정보 DAO
+/**사용자 인증 정보 Bean
* @author mjkhan
*/
@Component("authenticationBean")
@@ -74,14 +74,9 @@ public class AuthenticationBean extends AbstractComponent {
return 0;
}
- /**주어진 조건의 사용자 인증 정책 목록을 반환한다.
- * @param by 조건 필드 이름
- * - userName - 사용자 이름
- * - 그 이외는 사용자 아이디
- *
- * @param term 조건 필드값
- * @param pageNum 페이지 이름
- * @param fetchSize 한 번에 가져올 인증 정책 갯수
+ /**주어진 조건의 사용자 인증 정책 목록을 반환한다.
+ * {@link cokr.xit.base.security.authentication.service.AuthenticationService#getPolicyList(QueryRequest)} 참고
+ * @param req 사용자 인증 정책 조회 조건
* @return 사용자 인증 정책 목록
*/
public List getPolicyList(QueryRequest req) {
diff --git a/src/main/java/cokr/xit/base/security/authentication/web/PolicyController.java b/src/main/java/cokr/xit/base/security/authentication/web/PolicyController.java
index aa089ca..730ca4c 100644
--- a/src/main/java/cokr/xit/base/security/authentication/web/PolicyController.java
+++ b/src/main/java/cokr/xit/base/security/authentication/web/PolicyController.java
@@ -28,13 +28,9 @@ public class PolicyController extends AbstractCo
return authenticationService;
}
- /**주어진 조건의 사용자 인증 정책 목록을 반환한다.
- * @param by 조건 필드 이름
- * - userName - 사용자 이름
- * - 그 이외는 사용자 아이디
- *
- * @param term 조건 필드값
- * @param pageNum 페이지 이름
+ /**주어진 조건의 사용자 인증 정책 목록을 반환한다.
+ * {@link AuthenticationService#getPolicyList(QueryRequest)} 참고
+ * @param req 사용자 인증 정책 조회 조건
* @return jsonView
* {
* "policyList": 정책 목록,
@@ -56,7 +52,7 @@ public class PolicyController extends AbstractCo
* @param policy 인증 정책
* @return jsonView
* {
- * "saved": true || false
+ * "saved": 등록됐으면 true, 그렇지 않으면 false
* }
*/
@PostMapping(name="인증 정책 등록", value="/created.do")
@@ -69,7 +65,7 @@ public class PolicyController extends AbstractCo
* @param policy 인증 정책
* @return jsonView
* {
- * "saved": true || false
+ * "saved": 수정됐으면 true, 그렇지 않으면 false
* }
*/
@PostMapping(name="인증 정책 수정", value="/update.do")
@@ -83,7 +79,7 @@ public class PolicyController extends AbstractCo
* @return jsonView
* {
* "affected": 저장된 정보수,
- * "saved": true || false
+ * "saved": 저장됐으면 true, 그렇지 않으면 false
* }
*/
@PostMapping(name="인증 정책 제거", value="/remove.do")