Skip navigation links

oracle.wsm.policymanager
Interface IQueryService

All Known Subinterfaces:

IQueryServiceLocal, IQueryServiceRemote

All Known Implementing Classes:

QueryService, QueryService, QueryServiceDelegate

public interface IQueryService

Nested Class Summary

static class

IQueryService.Attributes

Method Summary

boolean	areTransactionsSupported() This methods lets you know if transactionality is supported by the backed datastore used by the policymanager.
IAssertionTemplate	getAssertionTemplate(String assertionTemplateName) Retrives and returns an Assertiontemplate object with the supplied name
List<IAssertionTemplate>	getAssertionTemplates(String path) Returns a list of all Assertion Templates stored in the datastore
List<IAssertionTemplate>	getAssertionTemplatesByCategory(String path, String category) Return a list of assertion templates belonging to a specific category
List<IAssertionTemplate>	getAssertionTemplatesByQNameAndAttachTo(QName assertionQName, String appliesTo) Return all Assertion Templates that contain the assertion identified by its qname (assertionQName) and attachTo.
IAssertionTemplate	getAssertionTemplateVersion(String assertionTemplateName, long version) Returns a particular version of an assertionTemplate
List<IAssertionTemplate>	getAssertionTemplateVersionHistory(String templateName) Get a list of all previous version of a particular Assertion template
IPolicyAttachment	getAttachment(String attachmentName) Get a policy attachment object store in the store by the passed name
IPolicyAttachment	getAttachmentByPolicyName(String policyName) Returns a single policy attachment - given the name of the Policy.
List<IPolicyAttachment>	getAttachments(String path, String policyId) Get all Policy Attachment objects under a particular path and matching passed ID
List<IPolicy>	getPolicies(String path) Returns all policies in the Policy store
List<IPolicy>	getPoliciesByAttachTo(String path, List<String> attachToList) Return Policies in a specific Attachment Point
List<IPolicy>	getPoliciesByCategory(String path, String category) Returns a list of Policies belonging to the cateory passed
List<IPolicy>	getPoliciesByCategoryAndAttachTo(String path, String category, List<String> attachToList) Return a list of Policies in any of the supplied Attachment points and belonging to the passed category
List<IPolicy>	getPoliciesByID(String path, String policyID) Return a list of policies matching the supplied path and id This method can be use to restrict searching policies within a particular path If the complete path to a particular policy is know and only a single policy is to be fetched, the corresponding method should be used instead of this method
List<IPolicy>	getPoliciesByPolicyReferences(List<IPolicyReference> polRefs, boolean includeConfigs) Given a list of PolicyReferences returns the corresponding Policies.
Map<IPolicyReference,IPolicy>	getPoliciesByPolicyReferencesMap(List<IPolicyReference> polRefs, boolean includeConfigs) Given a list of PolicyReferences returns a Map of <IPolicyReference, IPolicy> if a PolicyReference is invalid then null is returned
List<IPolicy>	getPoliciesByPolicyStatus(String path, IPolicy.STATUS status) Return a list of Policies with supplied status
List<IPolicy>	getPoliciesForResource(String resourcePattern) Returns the Policies attached to a Policy Subject(Resource) identified by resourcePattern
IPolicy	getPolicy(String policyName) Get a policy for the given policy name
IPolicy	getPolicy(String policyName, boolean getConfig) Get a particular policy with options to include configuration information
IPolicy	getPolicyByID(String path, String policyID) Returns a policy corresponding to given policy path and ID This method will return a single policy with the name <path/id>.
Map<String,List<IPolicyReference>>	getPolicyReferencesForResource(List<String> policySubject) Finds all the policy references that are attached to the policy subject
List<IPolicyReference>	getPolicyReferencesForResource(String resourcePattern) Finds all the policies that are attached to a resource pattern
IPolicy	getPolicyVersion(String policyName, long version) Returns a particular version of a policy
List<IPolicy>	getPolicyVersionHistory(String policyName) Get a list of all previous version of a particular policy
Date	getStoreTimestamp() Returns the timestamp of the Policy store
List<IPolicy>	searchPolicies(SearchCriteria searchCriteria) Search and return a list of policies that meet the passed search Criteria
Map<IPolicy,List<IValidationError>>	validatePolicies(List<IPolicy> policies) Performs Policy Validation on each policy and return the list of errors.
Map<IPolicySubject,List<IValidationError>>	validatePolicySubjects(Map<IPolicySubject,List<IPolicyReference>> polSubjectsToValidate) Performs Policy Subject Validation - where each Policy Subject is represented by a IPolicySubject and the List of PolicyReference that are attached for the PolicySubject

Method Detail

getPolicy

IPolicy getPolicy(String policyName)
                  throws PolicyManagerException

Get a policy for the given policy name

Parameters:

policyName -

Returns:

Throws:

PolicyManagerException

getPolicy

IPolicy getPolicy(String policyName,
                  boolean getConfig)
                  throws PolicyManagerException

Get a particular policy with options to include configuration information

Parameters:

policyName -

getConfig -

Returns:

Throws:

PolicyManagerException

getPolicies

List<IPolicy> getPolicies(String path)
                          throws PolicyManagerException

Returns all policies in the Policy store

Parameters:

path - The path to search within the data store If path is null, the entire datastore will be searched

Returns:

A List of all policies of type IPolicy

Throws:

PolicyManagerException

getPoliciesByCategory

List<IPolicy> getPoliciesByCategory(String path,
                                    String category)
                                    throws PolicyManagerException

Returns a list of Policies belonging to the cateory passed

Parameters:

path - The path to search within the data store If path is null, the entire datastore will be searched

category - The catergory to search policies on

Returns:

A List of IPolicy objects belonging to the cateogry search for

Throws:

PolicyManagerException

getPoliciesByPolicyStatus

List<IPolicy> getPoliciesByPolicyStatus(String path,
                                        IPolicy.STATUS status)
                                        throws PolicyManagerException

Return a list of Policies with supplied status

Parameters:

path - The path to search within the data store If path is null, the entire datastore will be searched

status - Policy enums tatus to lookup

Returns:

List of policies with the status value matching the passed status

Throws:

PolicyManagerException

getPolicyByID

IPolicy getPolicyByID(String path,
                      String policyID)
                      throws PolicyManagerException

Returns a policy corresponding to given policy path and ID This method will return a single policy with the name <path/id>.

Parameters:

path - The path to search within the data store If path is null, the entire datastore will be searched

policyID - Name of the Policy to be looked up

Returns:

Policy object corresponding to the passed policyName null is returned if passed policy ID is null or empty

Throws:

PolicyManagerException

getPoliciesByID

List<IPolicy> getPoliciesByID(String path,
                              String policyID)
                              throws PolicyManagerException

Return a list of policies matching the supplied path and id This method can be use to restrict searching policies within a particular path If the complete path to a particular policy is know and only a single policy is to be fetched, the corresponding method should be used instead of this method

Parameters:

path - The path to search within the data store If path is null, the entire datastore will be searched

policyID -

Returns:

Throws:

PolicyManagerException

See Also:

IQueryService.getPolicyByID(String path, String policyID)

getPoliciesByCategoryAndAttachTo

List<IPolicy> getPoliciesByCategoryAndAttachTo(String path,
                                               String category,
                                               List<String> attachToList)
                                               throws PolicyManagerException

Return a list of Policies in any of the supplied Attachment points and belonging to the passed category

Parameters:

path - The path to search within the data store If path is null, the entire datastore will be searched

category - Policy Category to search under

attachToList - List of attachment points to look at

Returns:

List of policies matching the passed criteria

Throws:

PolicyManagerException

getPoliciesByAttachTo

List<IPolicy> getPoliciesByAttachTo(String path,
                                    List<String> attachToList)
                                    throws PolicyManagerException

Return Policies in a specific Attachment Point

Parameters:

path - The path to search within the data store If path is null, the entire datastore will be searched

attachToList - List to attachement points to look for

Returns:

List of Policies in given attachement points

Throws:

PolicyManagerException

getPoliciesByPolicyReferences

List<IPolicy> getPoliciesByPolicyReferences(List<IPolicyReference> polRefs,
                                            boolean includeConfigs)
                                            throws PolicyManagerException

Given a list of PolicyReferences returns the corresponding Policies. an Invalid PolicyReference results in an exception

Parameters:

polRefs - - List of IPolicyReference

includeConfigs -

Returns:

Throws:

PolicyManagerException

getPoliciesByPolicyReferencesMap

Map<IPolicyReference,IPolicy> getPoliciesByPolicyReferencesMap(List<IPolicyReference> polRefs,
                                                               boolean includeConfigs)
                                                               throws PolicyManagerException

Given a list of PolicyReferences returns a Map of <IPolicyReference, IPolicy> if a PolicyReference is invalid then null is returned

Parameters:

polRefs - - List of IPolicyReference

includeConfigs -

Returns:

Map

Throws:

PolicyManagerException

getAssertionTemplate

IAssertionTemplate getAssertionTemplate(String assertionTemplateName)
                                        throws PolicyManagerException

Retrives and returns an Assertiontemplate object with the supplied name

Parameters:

assertionTemplateName - Name of the assertion Template object to be fetched

Returns:

IAssertionTemplate object matching the passed name

Throws:

PolicyManagerException

getAssertionTemplates

List<IAssertionTemplate> getAssertionTemplates(String path)
                                               throws PolicyManagerException

Returns a list of all Assertion Templates stored in the datastore

Parameters:

path - The path to search within the data store If path is null, the entire datastore will be searched

Returns:

List of IAssertionTemplate objects

Throws:

PolicyManagerException

getPolicyVersionHistory

List<IPolicy> getPolicyVersionHistory(String policyName)
                                      throws PolicyManagerException

Get a list of all previous version of a particular policy

Parameters:

polName - Name of the policy whos versions need to be fetched

Returns:

List of IPolicies representing the versions of the search policy The list is empty if a null or empty policy name is specified If versioning support is not available (e.g. if using file base MDS) then an emtpy list will be returned

Throws:

PolicyManagerException

getAssertionTemplateVersionHistory

List<IAssertionTemplate> getAssertionTemplateVersionHistory(String templateName)
                                                            throws PolicyManagerException

Get a list of all previous version of a particular Assertion template

Parameters:

templateName - Name of the Assertion template versions of which need to be fetched

Returns:

List of IAssertionTemplate representing the versions of the search Assertion template The list is empty if a null or empty Assertion template name is specified Also, if versioning support is not available (e.g. if using file base MDS) then an emtpy list will be returned

Throws:

PolicyManagerException

getAssertionTemplatesByCategory

List<IAssertionTemplate> getAssertionTemplatesByCategory(String path,
                                                         String category)
                                                         throws PolicyManagerException

Return a list of assertion templates belonging to a specific category

Parameters:

path - Path to restrict the search to

category - Category to search for

Returns:

List of Assertion templates matching the given category

Throws:

PolicyManagerException

getPolicyVersion

IPolicy getPolicyVersion(String policyName,
                         long version)
                         throws PolicyManagerException

Returns a particular version of a policy

Parameters:

policyName - Name a policy to look up

version - The version number to be fetched

Returns:

IPolicy object corresponding the the searched policy versions

Throws:

PolicyManagerException - If the particular version or the policy doesn't exist

getAssertionTemplateVersion

IAssertionTemplate getAssertionTemplateVersion(String assertionTemplateName,
                                               long version)
                                               throws PolicyManagerException

Returns a particular version of an assertionTemplate

Parameters:

assertionTemplateName - Name of the assertiontemplate to be look up

version - The version number to be fetched

Returns:

IAssertionTemplate object corresponding the the searched Assertion template versions

Throws:

PolicyManagerException - If the particular version or the Assertion template doesn't exist

getAttachment

IPolicyAttachment getAttachment(String attachmentName)
                                throws PolicyManagerException

Get a policy attachment object store in the store by the passed name

Parameters:

attachmentName - Name of the Policy attachment to be looked up

Returns:

Query Policy Attachment

Throws:

PolicyManagerException

getAttachmentByPolicyName

IPolicyAttachment getAttachmentByPolicyName(String policyName)
                                            throws PolicyManagerException

Returns a single policy attachment - given the name of the Policy. Returns null if no policy attachment for the Policy exists.

Parameters:

attachmentName - Name of the Policy attachment to be looked up

Returns:

IPolicyAttachment

Throws:

PolicyManagerException

getAttachments

List<IPolicyAttachment> getAttachments(String path,
                                       String policyId)
                                       throws PolicyManagerException

Get all Policy Attachment objects under a particular path and matching passed ID

Parameters:

path -

policyId -

Returns:

Throws:

PolicyManagerException

getPoliciesForResource

List<IPolicy> getPoliciesForResource(String resourcePattern)
                                     throws PolicyManagerException

Returns the Policies attached to a Policy Subject(Resource) identified by resourcePattern

Parameters:

resourcePattern - - String representation of a Policy Subject or Resource

Returns:

List<IPolicy> - list of Policies - returns empty list if the Resource is not associated with Policies

Throws:

PolicyManagerException

getAssertionTemplatesByQNameAndAttachTo

List<IAssertionTemplate> getAssertionTemplatesByQNameAndAttachTo(QName assertionQName,
                                                                 String appliesTo)
                                                                 throws PolicyManagerException

Return all Assertion Templates that contain the assertion identified by its qname (assertionQName) and attachTo.

Parameters:

assertionQName - - cannot be null

attachTo - - can be null - in which case it is ignored completely

Returns:

Throws:

PolicyManagerException

validatePolicySubjects

Map<IPolicySubject,List<IValidationError>> validatePolicySubjects(Map<IPolicySubject,List<IPolicyReference>> polSubjectsToValidate)
                                                                  throws PolicyManagerException

Performs Policy Subject Validation - where each Policy Subject is represented by a IPolicySubject and the List of PolicyReference that are attached for the PolicySubject

Returns:

Map<IPolicySubject, List>IValidationError>>

Throws:

PolicyManagerException

validatePolicies

Map<IPolicy,List<IValidationError>> validatePolicies(List<IPolicy> policies)
                                                     throws PolicyManagerException

Performs Policy Validation on each policy and return the list of errors.

Parameters:

policies - - List of IPolicy to be validated

Returns:

List<IValidationError>>

Throws:

PolicyManagerException

searchPolicies

List<IPolicy> searchPolicies(SearchCriteria searchCriteria)
                             throws PolicyManagerException

Search and return a list of policies that meet the passed search Criteria

Parameters:

searchCriteria - Condition for the search

Returns:

List of Policies meeting the search Criteria

Throws:

PolicyManagerException

getPolicyReferencesForResource

List<IPolicyReference> getPolicyReferencesForResource(String resourcePattern)
                                                      throws PolicyManagerException

Finds all the policies that are attached to a resource pattern

Parameters:

resourcePattern -

Returns:

Throws:

PolicyManagerException

getPolicyReferencesForResource

Map<String,List<IPolicyReference>> getPolicyReferencesForResource(List<String> policySubject)
                                                                  throws PolicyManagerException

Finds all the policy references that are attached to the policy subject

Parameters:

policySubject -

Returns:

Throws:

PolicyManagerException

getStoreTimestamp

Date getStoreTimestamp()

Returns the timestamp of the Policy store

Returns:

Timestamp of the Policy store

areTransactionsSupported

boolean areTransactionsSupported()
                                 throws PolicyManagerException

This methods lets you know if transactionality is supported by the backed datastore used by the policymanager. This method should be consulted before making any method calls that call any APIs dealing with bulk operations (create/update/delete)

Returns:

True if the back end datastore supports transactions, false otherwise

Throws:

PolicyManagerException

Skip navigation links