|
Oracle Fusion Middleware Management Java API Reference for Oracle Entitlements Server 11g Release 1 (11.1.1) E22649-02 ESAPI |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface PolicyDomainManager
This class manages policy domains. It provides methods to create, delete, modify, and find policy domains.
Method Summary | |
---|---|
PolicyDomainEntry |
createPolicyDomain(java.lang.String name, java.lang.String displayName, java.lang.String description) Create a policy domain. |
void |
deletePolicyDomain(java.lang.String name) Remove the given policy domain. |
PolicyDomainEntry |
getParentPolicyDomain(PolicyDomainEntry policyDomain) Gets the parent policy domain of the given Policy domain, if it has no parent, return null. |
PolicyDomainEntry |
getPolicyDomain(java.lang.String name) Get PolicyDomain object by name. |
java.util.List<PolicyDomainEntry> |
getPolicyDomains(PolicyDomainSearchQuery query) Get PolicyDomain objects by query. |
java.util.List<PolicyDomainEntry> |
getPolicyDomains(PolicyDomainSearchQuery query, boolean onlyDirectDomains) Get PolicyDomain objects by query and a flag which decides to return only direct domains or all. |
void |
modifyPolicyDomain(PolicyDomainEntry policyDomain) Persist the PolicyDomain changes. |
Methods inherited from interface oracle.security.jps.service.policystore.entitymanager.EntityManager |
---|
resolveReference |
Method Detail |
---|
PolicyDomainEntry createPolicyDomain(java.lang.String name, java.lang.String displayName, java.lang.String description) throws InvalidArgumentException, PolicyObjectAlreadyExistsException, PolicyStoreException
name
- policy domain name, the name should not be null or empty string. A qualified name should start with a letter or underscore and consist of letter, digit and underscore.displayName
- policy domain display namedescription
- policy domain descriptionInvalidArgumentException
- if an invalid value is passed in, throws out InvalidArgumentException.PolicyObjectAlreadyExistsException
- if the same name policy domain exists, throws out PolicyObjectAlreadyExistsException.PolicyStoreException
- if any internal status error, throws out PolicyStoreException.void modifyPolicyDomain(PolicyDomainEntry policyDomain) throws InvalidArgumentException, PolicyStoreException
policyDomain
- policy domain entryInvalidArgumentException
- if null is passed in, throws out InvalidArgumentException.PolicyStoreException
- if any internal status error, throws out PolicyStoreException.PolicyDomainEntry getPolicyDomain(java.lang.String name) throws InvalidArgumentException, PolicyObjectNotFoundException, PolicyStoreException
name
- policy domain name, the name should not be null or empty string. A qualified name should start with a letter or underscore and consist of letter, digit and underscore.InvalidArgumentException
- if an invalid value is passed in, throws out InvalidArgumentException.PolicyObjectNotFoundException
- if the specified policy domain does not existPolicyStoreException
- if any internal status error, throws out PolicyStoreException.java.util.List<PolicyDomainEntry> getPolicyDomains(PolicyDomainSearchQuery query) throws InvalidArgumentException, PolicyStoreException
query
- the query criteria, null value is not accepted.InvalidArgumentException
PolicyStoreException
- if any internal status error, throws PolicyStoreException.java.util.List<PolicyDomainEntry> getPolicyDomains(PolicyDomainSearchQuery query, boolean onlyDirectDomains) throws InvalidArgumentException, PolicyStoreException
query
- the query criteria, null value is not accepted.onlyDirectDomains
- boolean flag, if true returns only the direct domains and if false returns all direct and indirect domains.InvalidArgumentException
PolicyStoreException
- if any internal status error, throws PolicyStoreException.void deletePolicyDomain(java.lang.String name) throws InvalidArgumentException, PolicyObjectNotFoundException, PolicyStoreException
name
- policy domain name, the name should not be null or empty string. A qualified name should start with a letter or underscore and consist of letter, digit and underscore.InvalidArgumentException
- if an invalid value is passed in, throws out InvalidArgumentException.PolicyObjectNotFoundException
- if no policy domain matches the name, throws out PolicyObjectNotFoundException.PolicyStoreException
- if any internal status error, throws out PolicyStoreException.PolicyDomainEntry getParentPolicyDomain(PolicyDomainEntry policyDomain) throws InvalidArgumentException, PolicyStoreException
policyDomain
- policy domain objectInvalidArgumentException
- if null is passed in or the policy domain is in wrong status, throws out InvalidArgumentException.PolicyStoreException
- if any internal status error, throws out PolicyStoreException.
|
Oracle Fusion Middleware Management Java API Reference for Oracle Entitlements Server 11g Release 1 (11.1.1) E22649-02 ESAPI |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |