* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
public interface AuthzService<NSS,PERMS,PERMKEY,ROLES,USERS,USERROLES,DELGS,CERTS,KEYS,REQUEST,HISTORY,ERR,APPROVALS> {
public Mapper<NSS,PERMS,PERMKEY,ROLES,USERS,USERROLES,DELGS,CERTS,KEYS,REQUEST,HISTORY,ERR,APPROVALS> mapper();
-
+
/***********************************
- * NAMESPACE
+ * NAMESPACE
***********************************/
/**
- *
+ *
* @param trans
* @param user
* @param ns
* @return
- * @throws DAOException
- * @throws
+ * @throws DAOException
+ * @throws
*/
public Result<Void> createNS(AuthzTrans trans, REQUEST request, NsType type);
/**
- *
+ *
* @param trans
* @param ns
* @return
*/
public Result<Void> addAdminNS(AuthzTrans trans, String ns, String id);
-
+
/**
- *
+ *
* @param trans
* @param ns
* @return
public Result<Void> delAdminNS(AuthzTrans trans, String ns, String id);
/**
- *
+ *
* @param trans
* @param ns
* @param id
public Result<Void> addResponsibleNS(AuthzTrans trans, String ns, String id);
/**
- *
+ *
* @param trans
* @param ns
* @param id
public Result<Void> delResponsibleNS(AuthzTrans trans, String ns, String id);
/**
- *
+ *
* @param trans
* @param ns
* @param key
public Result<Void> createNsAttrib(AuthzTrans trans, String ns, String key, String value);
/**
- *
+ *
* @param trans
* @param ns
* @param key
public Result<?> updateNsAttrib(AuthzTrans trans, String ns, String key, String value);
/**
- *
+ *
* @param trans
* @param ns
* @param key
public Result<Void> deleteNsAttrib(AuthzTrans trans, String ns, String key);
/**
- *
+ *
* @param trans
* @param ns
* @param key
/**
- *
+ *
* @param trans
* @param ns
* @return
*/
public Result<NSS> getNSbyName(AuthzTrans trans, String ns, boolean full);
-
+
/**
- *
+ *
* @param trans
* @param user
* @return
*/
public Result<NSS> getNSbyAdmin(AuthzTrans trans, String user, boolean full);
-
+
/**
- *
+ *
* @param trans
* @param user
* @return
public Result<NSS> getNSbyResponsible(AuthzTrans trans, String user, boolean full);
/**
- *
+ *
* @param trans
* @param user
* @return
public Result<NSS> getNSbyEither(AuthzTrans trans, String user, boolean full);
/**
- *
+ *
* @param trans
* @param parent
* @return
public Result<NSS> getNSsChildren(AuthzTrans trans, String parent);
/**
- *
+ *
* @param trans
* @param req
* @return
*/
public Result<Void> updateNsDescription(AuthzTrans trans, REQUEST req);
-
+
/**
- *
+ *
* @param trans
* @param ns
* @param user
public Result<Void> deleteNS(AuthzTrans trans, String ns);
/***********************************
- * PERM
+ * PERM
***********************************/
/**
- *
+ *
* @param trans
* @param rreq
* @return
- * @throws DAOException
+ * @throws DAOException
* @throws MappingException
*/
public Result<Void> createPerm(AuthzTrans trans, REQUEST rreq);
-
+
/**
- *
+ *
* @param trans
* @param childPerm
* @return
- * @throws DAOException
+ * @throws DAOException
*/
public Result<PERMS> getPermsByType(AuthzTrans trans, String perm);
-
+
/**
- *
+ *
* @param trans
* @param type
* @param instance
* Gets all the permissions for a user across all the roles it is assigned to
* @param userName
* @return
- * @throws Exception
+ * @throws Exception
* @throws Exception
*/
public Result<PERMS> getPermsByUser(AuthzTrans trans, String userName);
/**
* Gets all the permissions for a user across all the roles it is assigned to, filtered by NS (Scope)
- *
+ *
* @param trans
* @param user
* @param scopes
/**
* Gets all the permissions for a user across all the roles it is assigned to
- *
+ *
* Add AAF Perms representing the "MayUser" calls if
* 1) Allowed
* 2) User has equivalent permission
- *
+ *
* @param userName
* @return
- * @throws Exception
+ * @throws Exception
* @throws Exception
*/
public Result<PERMS> getPermsByUser(AuthzTrans trans, PERMS perms, String userName);
/**
- *
+ *
* Gets all the permissions for a user across all the roles it is assigned to
- *
+ *
* @param roleName
* @return
* @throws Exception
*/
public Result<PERMS> getPermsByRole(AuthzTrans trans, String roleName);
-
+
/**
- *
+ *
* @param trans
* @param ns
* @return
/**
* rename permission
- *
+ *
* @param trans
* @param rreq
* @param isRename
* @return
*/
public Result<Void> renamePerm(AuthzTrans trans, REQUEST rreq, String origType, String origInstance, String origAction);
-
+
/**
- *
+ *
* @param trans
* @param req
* @return
*/
public Result<Void> updatePermDescription(AuthzTrans trans, REQUEST req);
-
+
/**
- *
+ *
* @param trans
* @param from
* @return
*/
public Result<Void> resetPermRoles(AuthzTrans trans, REQUEST from);
-
+
/**
- *
+ *
* @param trans
* @param from
* @return
public Result<Void> deletePerm(AuthzTrans trans, REQUEST from);
/**
- *
+ *
* @param trans
* @param user
* @param perm
Result<Void> deletePerm(AuthzTrans trans, String perm, String type, String action);
/***********************************
- * ROLE
+ * ROLE
***********************************/
/**
- *
+ *
* @param trans
* @param user
* @param role
* @param approvers
* @return
- * @throws DAOException
+ * @throws DAOException
* @throws Exception
*/
public Result<Void> createRole(AuthzTrans trans, REQUEST req);
/**
- *
+ *
* @param trans
* @param role
* @return
public Result<ROLES> getRolesByName(AuthzTrans trans, String role);
/**
- *
+ *
* @param trans
* @param user
* @return
- * @throws DAOException
+ * @throws DAOException
*/
public Result<ROLES> getRolesByUser(AuthzTrans trans, String user);
/**
- *
+ *
* @param trans
* @param user
* @return
public Result<ROLES> getRolesByNS(AuthzTrans trans, String user);
/**
- *
+ *
* @param trans
* @param name
* @return
public Result<ROLES> getRolesByNameOnly(AuthzTrans trans, String name);
/**
- *
+ *
* @param trans
* @param type
* @param instance
public Result<ROLES> getRolesByPerm(AuthzTrans trans, String type, String instance, String action);
/**
- *
+ *
* @param trans
* @param req
* @return
*/
public Result<Void> updateRoleDescription(AuthzTrans trans, REQUEST req);
-
+
/**
- *
+ *
* @param trans
* @param rreq
* @return
* @throws DAOException
*/
public Result<Void> addPermToRole(AuthzTrans trans, REQUEST rreq);
-
-
+
+
/**
- *
+ *
* @param trans
* @param rreq
* @return
public Result<Void> delPermFromRole(AuthzTrans trans, String role, String type, String instance, String action);
/**
- *
+ *
* @param trans
* @param user
* @param role
* @return
- * @throws DAOException
- * @throws MappingException
+ * @throws DAOException
+ * @throws MappingException
*/
public Result<Void> deleteRole(AuthzTrans trans, String role);
/**
- *
+ *
* @param trans
* @param req
* @return
public Result<Void> deleteRole(AuthzTrans trans, REQUEST req);
/***********************************
- * CRED
+ * CRED
***********************************/
/**
- *
+ *
* @param trans
* @param from
* @return
Result<Void> createUserCred(AuthzTrans trans, REQUEST from);
/**
- *
+ *
* @param trans
* @param from
* @return
Result<Void> resetUserCred(AuthzTrans trans, REQUEST from);
/**
- *
+ *
* @param trans
* @param from
* @param days
Result<Void> extendUserCred(AuthzTrans trans, REQUEST from, String days);
/**
- *
+ *
* @param trans
* @param ns
* @return
*/
public Result<USERS> getCredsByNS(AuthzTrans trans, String ns);
-
+
/**
- *
+ *
* @param trans
* @param id
* @return
public Result<USERS> getCredsByID(AuthzTrans trans, String id);
/**
- *
+ *
* @param trans
* @param req
* @param id
public Result<CERTS> getCertInfoByID(AuthzTrans trans, HttpServletRequest req, String id);
/**
- *
+ *
* @param trans
* @param credReq
* @return
*/
public Result<Void> deleteUserCred(AuthzTrans trans, REQUEST credReq);
-
+
/**
- *
+ *
* @param trans
* @param user
* @return
public Result<Date> doesCredentialMatch(AuthzTrans trans, REQUEST credReq);
/**
- *
+ *
* @param trans
* @param basicAuth
* @return
*/
public Result<Date> validateBasicAuth(AuthzTrans trans, String basicAuth);
-
+
/**
- *
+ *
* @param trans
* @param role
* @return
public Result<USERS> getUsersByRole(AuthzTrans trans, String role);
/**
- *
+ *
* @param trans
* @param role
* @return
public Result<USERS> getUserInRole(AuthzTrans trans, String user, String role);
/**
- *
+ *
* @param trans
* @param type
* @param instance
* @return
*/
public Result<USERS> getUsersByPermission(AuthzTrans trans,String type, String instance, String action);
-
-
+
+
/***********************************
- * USER-ROLE
+ * USER-ROLE
***********************************/
/**
- *
+ *
* @param trans
* @param user
* @param request
public Result<Void> createUserRole(AuthzTrans trans, REQUEST request);
/**
- *
+ *
* @param trans
* @param role
* @return
public Result<USERROLES> getUserRolesByRole(AuthzTrans trans, String role);
/**
- *
+ *
* @param trans
* @param role
* @return
* Note: Removed "resetRolesForUsers" because it was too dangerous, and
* removed "resetUsersForRoles" because it was being misused.
*/
-
+
/**
- *
+ *
* @param trans
* @param user
* @param role
String role);
/**
- *
+ *
* @param trans
* @param user
* @param usr
* @param role
* @return
- * @throws DAOException
+ * @throws DAOException
*/
public Result<Void> deleteUserRole(AuthzTrans trans, String usr, String role);
/***********************************
- * HISTORY
- ***********************************/
+ * HISTORY
+ ***********************************/
/**
- *
+ *
* @param trans
* @param user
* @param yyyymm
public Result<HISTORY> getHistoryByUser(AuthzTrans trans, String user, int[] yyyymm, int sort);
/**
- *
+ *
* @param trans
* @param subj
* @param yyyymm
public Result<HISTORY> getHistoryByRole(AuthzTrans trans, String subj, int[] yyyymm, int sort);
/**
- *
+ *
* @param trans
* @param subj
* @param yyyymm
public Result<HISTORY> getHistoryByPerm(AuthzTrans trans, String subj, int[] yyyymm, int sort);
/**
- *
+ *
* @param trans
* @param subj
* @param yyyymm
public Result<HISTORY> getHistoryByNS(AuthzTrans trans, String subj, int[] yyyymm, int sort);
/**
- *
+ *
* @param trans
* @param target
* @param yyyymm
public Result<HISTORY> getHistoryBySubject(AuthzTrans trans, String subject, String target, int[] yyyymm, int sort);
/***********************************
- * DELEGATE
+ * DELEGATE
***********************************/
/**
- *
+ *
* @param trans
* @param delegates
* @return
* @throws Exception
*/
public Result<Void> createDelegate(AuthzTrans trans, REQUEST reqDelegate);
-
+
/**
- *
+ *
* @param trans
* @param delegates
* @return
* @throws Exception
*/
public Result<Void> updateDelegate(AuthzTrans trans, REQUEST reqDelegate);
-
+
/**
- *
+ *
* @param trans
* @param userName
* @param delegate
* @throws Exception
*/
public Result<Void> deleteDelegate(AuthzTrans trans, REQUEST reqDelegate);
-
+
/**
- *
+ *
* @param trans
* @param userName
* @return
public Result<Void> deleteDelegate(AuthzTrans trans, String userName);
/**
- *
+ *
* @param trans
* @param user
* @return
* @throws Exception
*/
public Result<DELGS> getDelegatesByUser(AuthzTrans trans, String user);
-
+
/**
- *
+ *
* @param trans
* @param delegate
* @return
public Result<DELGS> getDelegatesByDelegate(AuthzTrans trans, String delegate);
/***********************************
- * APPROVAL
+ * APPROVAL
***********************************/
/**
- *
+ *
* @param trans
* @param user
* @param approver
public Result<Void> updateApproval(AuthzTrans trans, APPROVALS approvals);
/**
- *
+ *
* @param trans
* @param user
* @return
public Result<APPROVALS> getApprovalsByUser(AuthzTrans trans, String user);
/**
- *
+ *
* @param trans
* @param ticket
* @return
public Result<APPROVALS> getApprovalsByTicket(AuthzTrans trans, String ticket);
/**
- *
+ *
* @param trans
* @param approver
* @return
public Result<APPROVALS> getApprovalsByApprover(AuthzTrans trans, String approver);
/**
- *
+ *
* @param trans
* @param cname
* @return
public Result<Void> cacheClear(AuthzTrans trans, String cname);
/**
- *
+ *
* @param trans
* @param cname
* @param segment
public Result<Void> cacheClear(AuthzTrans trans, String cname, int[] segment);
/**
- *
+ *
* @param trans
*/
public void dbReset(AuthzTrans trans);
Code Review / aaf / authz.git / blobdiff