Skip navigation links

oracle.wsm.policymanager.client
Class QueryServiceDelegate

java.lang.Object
oracle.wsm.policymanager.client.QueryServiceDelegate

All Implemented Interfaces:

IQueryService

public class QueryServiceDelegate

extends Object

implements IQueryService

Nested Class Summary

Nested classes/interfaces inherited from interface oracle.wsm.policymanager.IQueryService

IQueryService.Attributes

Constructor Summary

QueryServiceDelegate(IStringQueryService queryServiceForDelegate)

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
Subject	getSubject()
List<IPolicy>	searchPolicies(SearchCriteria searchCriteria) Search and return a list of policies that meet the passed search Criteria
void	setSubject(Subject subject)
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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

QueryServiceDelegate

public QueryServiceDelegate(IStringQueryService queryServiceForDelegate)

Method Detail

getPolicy

public IPolicy getPolicy(String policyName)
                  throws PolicyManagerException

Get a policy for the given policy name

Specified by:

getPolicy in interface IQueryService

Returns:

Throws:

PolicyManagerException

getPolicy

public IPolicy getPolicy(String policyName,
                         boolean getConfig)
                  throws PolicyManagerException

Get a particular policy with options to include configuration information

Specified by:

getPolicy in interface IQueryService

Returns:

Throws:

PolicyManagerException

getPolicies

public List<IPolicy> getPolicies(String path)
                          throws PolicyManagerException

Returns all policies in the Policy store

Specified by:

getPolicies in interface IQueryService

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

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

Returns a list of Policies belonging to the cateory passed

Specified by:

getPoliciesByCategory in interface IQueryService

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

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

Return a list of Policies with supplied status

Specified by:

getPoliciesByPolicyStatus in interface IQueryService

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

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

Specified by:

getPolicyByID in interface IQueryService

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

public 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

Specified by:

getPoliciesByID in interface IQueryService

Parameters:

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

Returns:

Throws:

PolicyManagerException

See Also:

IQueryService.getPolicyByID(String path, String policyID)

getPoliciesByCategoryAndAttachTo

public 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

Specified by:

getPoliciesByCategoryAndAttachTo in interface IQueryService

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

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

Return Policies in a specific Attachment Point

Specified by:

getPoliciesByAttachTo in interface IQueryService

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

public 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

Specified by:

getPoliciesByPolicyReferences in interface IQueryService

Parameters:

polRefs - - List of IPolicyReference

Returns:

Throws:

PolicyManagerException

getPoliciesByPolicyReferencesMap

public 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

Specified by:

getPoliciesByPolicyReferencesMap in interface IQueryService

Parameters:

polRefs - - List of IPolicyReference

Returns:

Map

Throws:

PolicyManagerException

getPolicyVersionHistory

public List<IPolicy> getPolicyVersionHistory(String policyName)
                                      throws PolicyManagerException

Get a list of all previous version of a particular policy

Specified by:

getPolicyVersionHistory in interface IQueryService

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

getPolicyVersion

public IPolicy getPolicyVersion(String policyName,
                                long version)
                         throws PolicyManagerException

Returns a particular version of a policy

Specified by:

getPolicyVersion in interface IQueryService

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

getPoliciesForResource

public List<IPolicy> getPoliciesForResource(String resourcePattern)
                                     throws PolicyManagerException

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

Specified by:

getPoliciesForResource in interface IQueryService

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

searchPolicies

public List<IPolicy> searchPolicies(SearchCriteria searchCriteria)
                             throws PolicyManagerException

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

Specified by:

searchPolicies in interface IQueryService

Parameters:

searchCriteria - Condition for the search

Returns:

List of Policies meeting the search Criteria

Throws:

PolicyManagerException

getAssertionTemplate

public IAssertionTemplate getAssertionTemplate(String assertionTemplateName)
                                        throws PolicyManagerException

Retrives and returns an Assertiontemplate object with the supplied name

Specified by:

getAssertionTemplate in interface IQueryService

Parameters:

assertionTemplateName - Name of the assertion Template object to be fetched

Returns:

IAssertionTemplate object matching the passed name

Throws:

PolicyManagerException

getAssertionTemplates

public List<IAssertionTemplate> getAssertionTemplates(String path)
                                               throws PolicyManagerException

Returns a list of all Assertion Templates stored in the datastore

Specified by:

getAssertionTemplates in interface IQueryService

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

getAssertionTemplateVersionHistory

public List<IAssertionTemplate> getAssertionTemplateVersionHistory(String templateName)
                                                            throws PolicyManagerException

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

Specified by:

getAssertionTemplateVersionHistory in interface IQueryService

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

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

Return a list of assertion templates belonging to a specific category

Specified by:

getAssertionTemplatesByCategory in interface IQueryService

Parameters:

path - Path to restrict the search to

category - Category to search for

Returns:

List of Assertion templates matching the given category

Throws:

PolicyManagerException

getAssertionTemplatesByQNameAndAttachTo

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

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

Specified by:

getAssertionTemplatesByQNameAndAttachTo in interface IQueryService

Parameters:

assertionQName - - cannot be null

Returns:

Throws:

PolicyManagerException

getAssertionTemplateVersion

public IAssertionTemplate getAssertionTemplateVersion(String assertionTemplateName,
                                                      long version)
                                               throws PolicyManagerException

Returns a particular version of an assertionTemplate

Specified by:

getAssertionTemplateVersion in interface IQueryService

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

public IPolicyAttachment getAttachment(String attachmentName)
                                throws PolicyManagerException

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

Specified by:

getAttachment in interface IQueryService

Parameters:

attachmentName - Name of the Policy attachment to be looked up

Returns:

Query Policy Attachment

Throws:

PolicyManagerException

getAttachmentByPolicyName

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

Specified by:

getAttachmentByPolicyName in interface IQueryService

Returns:

IPolicyAttachment

Throws:

PolicyManagerException

getAttachments

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

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

Specified by:

getAttachments in interface IQueryService

Returns:

Throws:

PolicyManagerException

validatePolicySubjects

public 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

Specified by:

validatePolicySubjects in interface IQueryService

Returns:

Map<IPolicySubject, List>IValidationError>>

Throws:

PolicyManagerException

validatePolicies

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

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

Specified by:

validatePolicies in interface IQueryService

Parameters:

policies - - List of IPolicy to be validated

Returns:

List<IValidationError>>

Throws:

PolicyManagerException

getPolicyReferencesForResource

public List<IPolicyReference> getPolicyReferencesForResource(String resourcePattern)
                                                      throws PolicyManagerException

Finds all the policies that are attached to a resource pattern

Specified by:

getPolicyReferencesForResource in interface IQueryService

Returns:

Throws:

PolicyManagerException

getPolicyReferencesForResource

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

Description copied from interface: IQueryService

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

Specified by:

getPolicyReferencesForResource in interface IQueryService

Returns:

Throws:

PolicyManagerException

getStoreTimestamp

public Date getStoreTimestamp()

Description copied from interface: IQueryService

Returns the timestamp of the Policy store

Specified by:

getStoreTimestamp in interface IQueryService

Returns:

Timestamp of the Policy store

areTransactionsSupported

public 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)

Specified by:

areTransactionsSupported in interface IQueryService

Returns:

True if the back end datastore supports transactions, false otherwise

Throws:

PolicyManagerException

getSubject

public Subject getSubject()

setSubject

public void setSubject(Subject subject)

Skip navigation links