Skip navigation links

oracle.wsm.policymanager.internal
Interface IStringQueryService

All Known Subinterfaces:

IStringQueryServiceLocal, IStringQueryServiceRemote

All Known Implementing Classes:

QueryService, QueryService

public interface IStringQueryService

Method Summary

boolean	areTransactionsSupportedAsBooleanValue() This methods lets you know if transactionality is supported by the backed datastore used by the policymanager.
String	getAssertionTemplateAsString(String assertionTemplateName) Retrives and returns an Assertiontemplate object with the supplied name
List<String>	getAssertionTemplatesAsString(String path) Returns a list of all Assertion Templates stored in the datastore
List<String>	getAssertionTemplatesAsStringByCategory(String path, String category) Return a list of assertion templates belonging to a specific category
List<String>	getAssertionTemplatesAsStringByQNameAndAttachTo(QName assertionQName, String appliesTo) Return all Assertion Templates that contain the assertion identified by its qname (assertionQName) and attachTo.
String	getAssertionTemplateVersionAsString(String assertionTemplateName, long version) Returns a particular version of an assertionTemplate
List<String>	getAssertionTemplateVersionHistoryAsString(String templateName) Get a list of all previous version of a particular Assertion template
String	getAttachmentAsString(String attachmentName) Get a policy attachment object store in the store by the passed name
String	getAttachmentAsStringByPolicyName(String policyName) Returns a single policy attachment - given the name of the Policy.
List<String>	getAttachmentsAsString(String path, String policyId) Get all Policy Attachment objects under a particular path and matching passed ID
List<String>	getPoliciesAsString(String path) Returns all policies in the Policy store
List<String>	getPoliciesAsStringByAttachTo(String path, List<String> attachToList) Return Policies in a specific Attachment Point
List<String>	getPoliciesAsStringByCategory(String path, String category) Returns a list of Policies belonging to the cateory passed
List<String>	getPoliciesAsStringByCategoryAndAttachTo(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<String>	getPoliciesAsStringByID(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<String>	getPoliciesAsStringByPolicyReferences(List<String> polRefs, boolean includeConfigs) Given a list of PolicyReferences returns the corresponding Policies.
Map<String,String>	getPoliciesAsStringByPolicyReferencesMap(List<String> polRefs, boolean includeConfigs) Given a list of PolicyReferences returns a Map of <IPolicyReference, IPolicy> if a PolicyReference is invalid then null is returned
List<String>	getPoliciesAsStringByPolicyStatus(String path, IPolicy.STATUS status) Return a list of Policies with supplied status
List<String>	getPoliciesAsStringForResource(String resourcePattern) Returns the Policies attached to a Policy Subject(Resource) identified by resourcePattern
String	getPolicyAsString(String policyName) Get a policy for the given policy name
String	getPolicyAsString(String policyName, boolean getConfig) Get a particular policy with options to include configuration information
String	getPolicyAsStringByID(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>.
List<String>	getPolicyReferencesAsStringForResource(String resourcePattern) Finds all the policies that are attached to a resource pattern
Map<String,List<IPolicyReference>>	getPolicyReferencesForResource(List<String> policySubject) Finds all the policies that are attached to a policySubject
String	getPolicyVersionAsString(String policyName, long version) Returns a particular version of a policy
List<String>	getPolicyVersionHistoryAsString(String policyName) Get a list of all previous version of a particular policy
Date	getStoreTimestampAsDate() Returns the timestamp of the Policy store
List<String>	searchPoliciesAsString(SearchCriteria searchCriteria) Search and return a list of policies that meet the passed search Criteria
Map<String,List<IValidationError>>	validatePoliciesString(List<String> policyStrs)
Map<String,List<IValidationError>>	validatePolicySubjectsString(Map<String,List<String>> 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

getPolicyAsString

String getPolicyAsString(String policyName)
                         throws PolicyManagerException,
                                RemoteException

Get a policy for the given policy name

Parameters:

policyName -

Returns:

Throws:

PolicyManagerException

RemoteException

getPolicyAsString

String getPolicyAsString(String policyName,
                         boolean getConfig)
                         throws PolicyManagerException,
                                RemoteException

Get a particular policy with options to include configuration information

Parameters:

policyName -

getConfig -

Returns:

Throws:

PolicyManagerException

RemoteException

getPoliciesAsString

List<String> getPoliciesAsString(String path)
                                 throws PolicyManagerException,
                                        RemoteException

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

RemoteException

getPoliciesAsStringByCategory

List<String> getPoliciesAsStringByCategory(String path,
                                           String category)
                                           throws PolicyManagerException,
                                                  RemoteException

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

RemoteException

getPoliciesAsStringByPolicyStatus

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

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

RemoteException

getPolicyAsStringByID

String getPolicyAsStringByID(String path,
                             String policyID)
                             throws PolicyManagerException,
                                    RemoteException

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

RemoteException

getPoliciesAsStringByID

List<String> getPoliciesAsStringByID(String path,
                                     String policyID)
                                     throws PolicyManagerException,
                                            RemoteException

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

RemoteException

See Also:

IQueryService.getPolicyByID(String path, String policyID)

getPoliciesAsStringByCategoryAndAttachTo

List<String> getPoliciesAsStringByCategoryAndAttachTo(String path,
                                                      String category,
                                                      List<String> attachToList)
                                                      throws PolicyManagerException,
                                                             RemoteException

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

RemoteException

getPoliciesAsStringByAttachTo

List<String> getPoliciesAsStringByAttachTo(String path,
                                           List<String> attachToList)
                                           throws PolicyManagerException,
                                                  RemoteException

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

RemoteException

getPoliciesAsStringByPolicyReferences

List<String> getPoliciesAsStringByPolicyReferences(List<String> polRefs,
                                                   boolean includeConfigs)
                                                   throws PolicyManagerException,
                                                          RemoteException

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

RemoteException

getPoliciesAsStringByPolicyReferencesMap

Map<String,String> getPoliciesAsStringByPolicyReferencesMap(List<String> polRefs,
                                                            boolean includeConfigs)
                                                            throws PolicyManagerException,
                                                                   RemoteException

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

RemoteException

getAssertionTemplateAsString

String getAssertionTemplateAsString(String assertionTemplateName)
                                    throws PolicyManagerException,
                                           RemoteException

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:

RemoteException

PolicyManagerException

getAssertionTemplatesAsString

List<String> getAssertionTemplatesAsString(String path)
                                           throws PolicyManagerException,
                                                  RemoteException

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

RemoteException

getPolicyVersionHistoryAsString

List<String> getPolicyVersionHistoryAsString(String policyName)
                                             throws PolicyManagerException,
                                                    RemoteException

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

RemoteException

getAssertionTemplateVersionHistoryAsString

List<String> getAssertionTemplateVersionHistoryAsString(String templateName)
                                                        throws PolicyManagerException,
                                                               RemoteException

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

RemoteException

getAssertionTemplatesAsStringByCategory

List<String> getAssertionTemplatesAsStringByCategory(String path,
                                                     String category)
                                                     throws PolicyManagerException,
                                                            RemoteException

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

RemoteException

getPolicyVersionAsString

String getPolicyVersionAsString(String policyName,
                                long version)
                                throws PolicyManagerException,
                                       RemoteException

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

RemoteException

getAssertionTemplateVersionAsString

String getAssertionTemplateVersionAsString(String assertionTemplateName,
                                           long version)
                                           throws PolicyManagerException,
                                                  RemoteException

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

RemoteException

getAttachmentAsString

String getAttachmentAsString(String attachmentName)
                             throws PolicyManagerException,
                                    RemoteException

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

RemoteException

getAttachmentAsStringByPolicyName

String getAttachmentAsStringByPolicyName(String policyName)
                                         throws PolicyManagerException,
                                                RemoteException

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

RemoteException

getAttachmentsAsString

List<String> getAttachmentsAsString(String path,
                                    String policyId)
                                    throws PolicyManagerException,
                                           RemoteException

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

Parameters:

path -

policyId -

Returns:

Throws:

PolicyManagerException

RemoteException

getPoliciesAsStringForResource

List<String> getPoliciesAsStringForResource(String resourcePattern)
                                            throws PolicyManagerException,
                                                   RemoteException

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:

RemoteException

PolicyManagerException

getAssertionTemplatesAsStringByQNameAndAttachTo

List<String> getAssertionTemplatesAsStringByQNameAndAttachTo(QName assertionQName,
                                                             String appliesTo)
                                                             throws PolicyManagerException,
                                                                    RemoteException

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:

RemoteException

PolicyManagerException

searchPoliciesAsString

List<String> searchPoliciesAsString(SearchCriteria searchCriteria)
                                    throws PolicyManagerException,
                                           RemoteException

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:

RemoteException

PolicyManagerException

validatePolicySubjectsString

Map<String,List<IValidationError>> validatePolicySubjectsString(Map<String,List<String>> polSubjectsToValidate)
                                                                throws PolicyManagerException,
                                                                       RemoteException

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:

RemoteException

PolicyManagerException

validatePoliciesString

Map<String,List<IValidationError>> validatePoliciesString(List<String> policyStrs)
                                                          throws PolicyManagerException,
                                                                 RemoteException

Throws:

PolicyManagerException

RemoteException

getPolicyReferencesAsStringForResource

List<String> getPolicyReferencesAsStringForResource(String resourcePattern)
                                                    throws PolicyManagerException,
                                                           RemoteException

Finds all the policies that are attached to a resource pattern

Parameters:

resourcePattern -

Returns:

Throws:

RemoteException

PolicyManagerException

getPolicyReferencesForResource

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

Finds all the policies that are attached to a policySubject

Parameters:

policySubject - list of policysubject

Returns:

Throws:

RemoteException

PolicyManagerException

getStoreTimestampAsDate

Date getStoreTimestampAsDate()
                             throws RemoteException

Returns the timestamp of the Policy store

Returns:

Timestamp of the Policy store

Throws:

RemoteException

areTransactionsSupportedAsBooleanValue

boolean areTransactionsSupportedAsBooleanValue()
                                               throws PolicyManagerException,
                                                      RemoteException

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

RemoteException

Skip navigation links