Skip navigation links

oracle.security.jps.service.policystore.entitymanager
Interface PolicyDomainManager

All Superinterfaces:

EntityManager

public interface PolicyDomainManager

extends EntityManager

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

createPolicyDomain

PolicyDomainEntry createPolicyDomain(java.lang.String name,
                                     java.lang.String displayName,
                                     java.lang.String description)
                                     throws InvalidArgumentException,
                                            PolicyObjectAlreadyExistsException,
                                            PolicyStoreException

Create a policy domain.

Parameters:

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 name

description - policy domain description

Returns:

a policy domain entry

Throws:

InvalidArgumentException - 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.

modifyPolicyDomain

void modifyPolicyDomain(PolicyDomainEntry policyDomain)
                        throws InvalidArgumentException,
                               PolicyStoreException

Persist the PolicyDomain changes.

Parameters:

policyDomain - policy domain entry

Throws:

InvalidArgumentException - if null is passed in, throws out InvalidArgumentException.

PolicyStoreException - if any internal status error, throws out PolicyStoreException.

getPolicyDomain

PolicyDomainEntry getPolicyDomain(java.lang.String name)
                                  throws InvalidArgumentException,
                                         PolicyObjectNotFoundException,
                                         PolicyStoreException

Get PolicyDomain object by name.

Parameters:

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.

Returns:

an policy domain entry object

Throws:

InvalidArgumentException - if an invalid value is passed in, throws out InvalidArgumentException.

PolicyObjectNotFoundException - if the specified policy domain does not exist

PolicyStoreException - if any internal status error, throws out PolicyStoreException.

getPolicyDomains

java.util.List<PolicyDomainEntry> getPolicyDomains(PolicyDomainSearchQuery query)
                                                   throws InvalidArgumentException,
                                                          PolicyStoreException

Get PolicyDomain objects by query.

Parameters:

query - the query criteria, null value is not accepted.

Returns:

a list of policy domain entry objects, if nothing found, returns an empty list.

Throws:

InvalidArgumentException

PolicyStoreException - if any internal status error, throws PolicyStoreException.

getPolicyDomains

java.util.List<PolicyDomainEntry> getPolicyDomains(PolicyDomainSearchQuery query,
                                                   boolean onlyDirectDomains)
                                                   throws InvalidArgumentException,
                                                          PolicyStoreException

Get PolicyDomain objects by query and a flag which decides to return only direct domains or all.

Parameters:

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.

Returns:

a list of policy domain entry objects, if nothing found, returns an empty list.

Throws:

InvalidArgumentException

PolicyStoreException - if any internal status error, throws PolicyStoreException.

deletePolicyDomain

void deletePolicyDomain(java.lang.String name)
                        throws InvalidArgumentException,
                               PolicyObjectNotFoundException,
                               PolicyStoreException

Remove the given policy domain.

Parameters:

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.

Throws:

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.

getParentPolicyDomain

PolicyDomainEntry getParentPolicyDomain(PolicyDomainEntry policyDomain)
                                        throws InvalidArgumentException,
                                               PolicyStoreException

Gets the parent policy domain of the given Policy domain, if it has no parent, return null.

Parameters:

policyDomain - policy domain object

Returns:

the parent policy domain objects

Throws:

InvalidArgumentException - 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.

Skip navigation links