|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface AuthorizationAdminAPI
Method Summary | |
---|---|
void |
addPrincipalsToRole(java.util.Set principals,
java.lang.String roleName)
Add the given set of principals to the given role. |
java.lang.Boolean |
containsPolicy(AuthorizationPolicyID policyID)
Return whether there is an existing policy with the specified ID. |
AuthorizationEditor |
createEditor()
Returns a AuthorizationObjectEditor to perform editing operations
on a entitlement type object. |
java.util.Set |
executeTransaction(java.util.List actions)
Execute as a single transaction with the specified actions, and return the set of IDs for the objects that were affected/modified by the action. |
java.util.Collection |
findAllPolicyIDs()
Locate the IDs of all of the policies that are accessible by the caller. |
AuthorizationPolicy |
getPolicy(AuthorizationPolicyID policyID)
Locate the policy that has the specified ID. |
java.util.Collection |
getPolicyIDsInRealm(AuthorizationRealm realm)
Returns a Collection of AuthorizationPolicyID s
in the given AuthorizationRealm . |
java.util.Collection |
getPrincipalsForRole(java.lang.String roleName)
Returns a collection MetaMatrixPrincipalName objects containing the name
of the principal along with its type which belong to the given role. |
java.util.Map |
getRoleDescriptions()
Obtain the names of all of the roles and their descriptions known to the system. |
java.util.Collection |
getRoleNamesForPrincipal(MetaMatrixPrincipalName principal)
Returns a Collection of String names of MetaMatrix roles to which the given principal is assigned. |
boolean |
isSuperUser(java.lang.String username)
Returns true if the given username matches the current membership security.membership.admin.username from the current config |
void |
removePrincipalsFromRole(java.util.Set principals,
java.lang.String roleName)
Remove the given set of principals from the given role. |
Method Detail |
---|
AuthorizationEditor createEditor() throws InvalidSessionException, AuthorizationException, MetaMatrixComponentException
AuthorizationObjectEditor
to perform editing operations
on a entitlement type object. The editing process will create actions for
each specific type of editing operation. Those actions are what need to be
submitted to the AuthorizationService
for actual updates to occur.
InvalidSessionException
AuthorizationException
MetaMatrixComponentException
java.util.Map getRoleDescriptions() throws AuthorizationException, InvalidSessionException, MetaMatrixComponentException
InvalidSessionException
- if the SessionToken
is not valid or is expired
AuthorizationException
- if the caller is unable to perform this operation
MetaMatrixComponentException
- if this service has trouble communicating.java.util.Collection getPrincipalsForRole(java.lang.String roleName) throws AuthorizationException, InvalidSessionException, MetaMatrixComponentException
MetaMatrixPrincipalName
objects containing the name
of the principal along with its type which belong to the given role.
com.metamatrix.security.api.MetaMatrixPrincipalName
roleName
- String name of MetaMatrix role for which principals
are sought
InvalidSessionException
- if the administrative session is invalid
AuthorizationException
- if admninistrator does not have the authority to perform the requested operation.
MetaMatrixComponentException
- if this service has trouble communicating.java.util.Collection getRoleNamesForPrincipal(MetaMatrixPrincipalName principal) throws AuthorizationException, InvalidSessionException, MetaMatrixComponentException
principal
- MetaMatrixPrincipalName
for which roles are soughtexplicitOnly
- If true, only return roles assigned directly to given principal.
If false, return all roles directly assigned and inherited.
Collection
of role names the principal is assigned.
InvalidSessionException
- if the administrative session is invalid
AuthorizationException
- if admninistrator does not have the authority to perform the requested operation.
MetaMatrixComponentException
- if this service has trouble communicating.void addPrincipalsToRole(java.util.Set principals, java.lang.String roleName) throws AuthorizationException, InvalidSessionException, MetaMatrixComponentException
principals
- Set of MetaMatrixPrincipalName
s to which to add.roleName
- The name of the role to which to add the principals.
InvalidSessionException
- if the administrative session is invalid
AuthorizationException
- if admninistrator does not have the authority to perform the requested operation.
MetaMatrixComponentException
- if this service has trouble communicating.boolean isSuperUser(java.lang.String username) throws MembershipServiceException, MetaMatrixComponentException
username
- the username to compare to the current super user
ServiceException
- for generic service errors
MembershipServiceException
- If there are issues within the membership service
MetaMatrixComponentException
- if this service has trouble communicating.void removePrincipalsFromRole(java.util.Set principals, java.lang.String roleName) throws AuthorizationException, InvalidSessionException, MetaMatrixComponentException
principals
- Set of MetaMatrixPrincipalName
s to remove.roleName
- The name of the role from which to remove the principals.
InvalidSessionException
- if the administrative session is invalid
AuthorizationException
- if admninistrator does not have the authority to perform the requested operation.
MetaMatrixComponentException
- if this service has trouble communicating.java.util.Collection findAllPolicyIDs() throws AuthorizationException, InvalidSessionException, MetaMatrixComponentException
caller
- the session token of the principal that is attempting to access the policies.
InvalidSessionException
- if the SessionToken
is not valid or is expired
AuthorizationException
- if the caller is unable to perform this operation
AuthorizationMgmtException
- if this service has trouble connecting to services it uses.
MetaMatrixComponentException
- if this service has trouble communicating.java.lang.Boolean containsPolicy(AuthorizationPolicyID policyID) throws AuthorizationException, InvalidSessionException, MetaMatrixComponentException
id
- the ID that is to be checked
InvalidSessionException
- if the SessionToken
is not valid or is expired
AuthorizationException
- if the caller is unable to perform this operation
MetaMatrixComponentException
- if this service has trouble communicating.AuthorizationPolicy getPolicy(AuthorizationPolicyID policyID) throws AuthorizationException, AuthorizationMgmtException, InvalidSessionException, MetaMatrixComponentException
policyID
- the ID of the policy to be obtained
InvalidSessionException
- if the SessionToken
is not valid or is expired
AuthorizationException
- if the caller is unable to perform this operation
MetaMatrixComponentException
- if this service has trouble communicating.
AuthorizationMgmtException
java.util.Set executeTransaction(java.util.List actions) throws AuthorizationException, AuthorizationMgmtException, InvalidSessionException, MetaMatrixComponentException
actions
- the ordered list of actions that are to be performed
on metamodel within the repository.
InvalidSessionException
- if the SessionToken
is not valid or has expired.
AuthorizationException
- if the caller is unable to perform this operation.
MetaMatrixComponentException
- if this service has trouble communicating.
AuthorizationMgmtException
java.util.Collection getPolicyIDsInRealm(AuthorizationRealm realm) throws AuthorizationException, AuthorizationMgmtException, InvalidSessionException, MetaMatrixComponentException
Collection
of AuthorizationPolicyID
s
in the given AuthorizationRealm
.
AuthorizationPolicy
's AuthorizationPermission
s
are actually in the given AuthorizationRealm
. The AuthorizationPolicy
may span AuthorizationRealm
s.
realm
- The realm in which to search for AuthorizationPermission
s.
AuthorizationPolicyID
s that have permissions
in the given realm - possibly empty but never null.
AuthorizationException
- if admninistrator does not have the authority to preform the action.
AuthorizationMgmtException
- if an error occurs in the Authorization store.
MetaMatrixComponentException
- if this service has trouble communicating.
InvalidSessionException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |