|
Oracle Fusion Middleware Management Java API Reference for Oracle Entitlements Server 11g Release 2 (11.1.2) E27155-01 ESAPI |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface PermissionSetManager
An Entity Manager that offers create, read, update and delete of a PermissionSet in a persistent store.
Method Summary | |
---|---|
PermissionSetEntry |
createPermissionSet(java.lang.String name, java.lang.String displayName, java.lang.String description, java.util.List<ResourceActionsEntry> resActions) Creates a permission set. |
void |
deletePermissionSet(java.lang.String name, boolean cascade) Deletes the permission set, if cascade option is set to true, related policies are moved in the same time, otherwise, if related policies exist, throw out an PolicyStoreOperationNotAllowedException. |
PermissionSetEntry |
getPermissionSet(java.lang.String permissionSetName) Get a PermissionSet by Name. |
java.util.List<PermissionSetEntry> |
getPermissionSets(PermissionSetSearchQuery query) Query PermissionSets based upon a search criteria. |
void |
modifyPermissionSet(PermissionSetEntry permissionSet) Persists the changes on input PermissionSet object. |
Methods inherited from interface oracle.security.jps.service.policystore.entitymanager.EntityManager |
---|
resolveReference |
Method Detail |
---|
PermissionSetEntry getPermissionSet(java.lang.String permissionSetName) throws InvalidArgumentException, PolicyObjectNotFoundException, PolicyStoreException
permissionSetName
- name of the PermissionSet.If the resource is managed in an external store, it is possible the resource has been deleted without the PermissionSet being updated.
If the resoure is managed in the default store, it is also possible for the resource to have been deleted without the PermissionSet having been updated. This is possible in distributed policy environment.
InvalidArgumentException
- if permissionSetName is null or empty.PolicyObjectNotFoundException
- if PermissionSet with the name does not exist.PolicyStoreException
- if there was an error while searching for the PermissionSet.java.util.List<PermissionSetEntry> getPermissionSets(PermissionSetSearchQuery query) throws InvalidArgumentException, PolicyStoreException
query
- search criteria, must not be null.getPermissionSet(String)
which attempts to lookup the description and display name of the resource. Returns an empty list if no permisison set matching the query is found.
If no permissionSets are found, an empty list is returned.
InvalidArgumentException
- if query is null.PolicyStoreException
- if there was an error while querying.void modifyPermissionSet(PermissionSetEntry permissionSet) throws InvalidArgumentException, PolicyStoreException
permissionSet
- permissionSet objectInvalidArgumentException
- if the parameter permissionSet is null or its name is null or there is no resource actions or if ResourceAction(s) contain ResouceNameExpression have an invalid java regex.PolicyStoreException
- if there was an errorPolicyObjectNotFoundException
- if the permission set doesn't existPermissionSetEntry createPermissionSet(java.lang.String name, java.lang.String displayName, java.lang.String description, java.util.List<ResourceActionsEntry> resActions) throws InvalidArgumentException, PolicyStoreException
PolicyObjectNotFoundException
1. The resource type referenced in resAction
should exist at the application scope level, 2. The resource names referenced in resAction
should exist at the same level at which the permissionSet is being defined. For example, if creating an PermissionSet at the application scope, then resource must exist at the application scope, and if the permissionSet is being created at a PolicyDomain level, then resource must exist in the PolicyDomain.InvalidArgumentException
- if the parameter name is null or there is no resource actions or if ResourceAction(s) contain ResouceNameExpression have an invalid java regex.PolicyObjectNotFoundException
- if the resource type or resource name referenced in the resActions
do not already exist in policy storePolicyStoreException
- if there was an errorPolicyObjectAlreadyExistsException
- if the permission set already existsvoid deletePermissionSet(java.lang.String name, boolean cascade) throws InvalidArgumentException, PolicyStoreOperationNotAllowedException, PolicyStoreException
name
- permission set namecascade
- true means also removing related policies; otherwise falseInvalidArgumentException
- if the parameter name is nullPolicyStoreOperationNotAllowedException
- if there is no permissionPolicyStoreException
- if there was an errorPolicyObjectNotFoundException
- if the application role specified by name doesn't exist
|
Oracle Fusion Middleware Management Java API Reference for Oracle Entitlements Server 11g Release 2 (11.1.2) E27155-01 ESAPI |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |