oracle.security.jps.service.policystore.search.ras

Class RASPolicySearchQuery

java.lang.Object

oracle.security.jps.search.SearchQuery

oracle.security.jps.service.policystore.search.BaseSearchQuery

oracle.security.jps.service.policystore.search.ras.RASPolicySearchQuery

public class RASPolicySearchQuery
extends BaseSearchQuery

A Class to build search criteria to query RAS Policies.

Following code snippet illustrates how to build a search criteria to search by the DisplayName

  RASPolicySearchQuery query = new RASPolicySearchQuery(RASPolicySearchQuery.SEARCH_PROPERTY.DISPLAY_NAME,
    false, ComparatorType.EQUALITY, "DisplayName Value to searchBy", BaseSearchQuery.MATCHER.EXACT);
 getRASPolycies ( query );
 

To build more complex search criteria, use the Constructor for complex search query.

Consider the following example to search AttributeCollections by a specific description and display name. Obviously, the two criteria (below) have to be AND-ed.

  List<RASPolicySearchQuery> list = new ArrayList<RASPolicySearchQuery>();
  list.add(new RASPolicySearchQuery( RASPolicySearchQuery.SEARCH_PROPERTY.DISPLAY_NAME,
    false, ComparatorType.EQUALITY, "The Display Name", BaseSearchQuery.MATCHER.EXACT));
  
  list.add(new RASPolicySearchQuery( RASPolicySearchQuery.SEARCH_PROPERTY.DESCRIPTION,
    false, ComparatorType.EQUALITY, "The Description", BaseSearchQuery.MATCHER.EXACT));
 
  RASPolicySearchQuery query = new RASPolicySearchQuery(list, false, false);
 

Similarly, we can have two criteria OR-ed as below.

  List<RASPolicySearchQuery> list = new ArrayList<RASPolicySearchQuery>();
  list.add(new RASPolicySearchQuery( RASPolicySearchQuery.SEARCH_PROPERTY.DISPLAY_NAME,
    false, ComparatorType.EQUALITY, "The Display Name", BaseSearchQuery.MATCHER.EXACT));
  
  list.add(new RASPolicySearchQuery( RASPolicySearchQuery.SEARCH_PROPERTY.DESCRIPTION,
    false, ComparatorType.EQUALITY, "The Description", BaseSearchQuery.MATCHER.EXACT));
 
  RASPolicySearchQuery query = new RASPolicySearchQuery(list, false, true);
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RASPolicySearchQuery.SEARCH_PROPERTY Criteria to search policies By

Nested classes/interfaces inherited from class oracle.security.jps.search.SearchQuery

SearchQuery.MATCHER

Constructor Summary

Constructors

Constructor and Description
RASPolicySearchQuery(java.util.List<RASPolicySearchQuery> queries, boolean negation, boolean isORMatch) Constructor for a complex RAS Policy Search Query
RASPolicySearchQuery(RASPolicySearchQuery.SEARCH_PROPERTY property, boolean negation, ComparatorType operator, java.lang.Object valueObject, SearchQuery.MATCHER match) Constructor

Method Summary

Methods

Modifier and Type	Method and Description
RASPolicySearchQuery.SEARCH_PROPERTY	getSearchByProperty() get the search by property in this search query
RASPolicySearchQuery[]	getSearchQueryInOrder() Get the child search query in this search query.
boolean	isPolicyObjectBasedOnly() if the search query is based on the Policy object based properties, namely - Name, Display Name, Description, RAS_PARAMETERVALUE and ACL_MATCH_TYPE only

Methods inherited from class oracle.security.jps.service.policystore.search.BaseSearchQuery

getBaseSearchQueryInOrder, getComparator, getEntityType, getQueries, toString

Methods inherited from class oracle.security.jps.search.SearchQuery

addBaseQuery, getPageInfo, getPreparedQueryId, getSearchByPropertyString, getSearchByValue, getSearchByValueObject, getSearchComparator, getSearchQueries, getSearchValueMatch, hasPageInfo, isANDMatch, isComplexQuery, isNegativeMatch, isORMatch, setPageInfo, setPreparedQueryId, unsetPageInfo

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

RASPolicySearchQuery

public RASPolicySearchQuery(RASPolicySearchQuery.SEARCH_PROPERTY property,
                    boolean negation,
                    ComparatorType operator,
                    java.lang.Object valueObject,
                    SearchQuery.MATCHER match)
                     throws InvalidArgumentException

Constructor

Parameters:

property - search property

negation - whether the query result must be negated

operator - comparison operator, See ComparatorType for list of valid values.

valueObject - the search object

match - matcher type, please refer to SearchQuery.MATCHER for details.

Throws:

InvalidArgumentException

RASPolicySearchQuery

public RASPolicySearchQuery(java.util.List<RASPolicySearchQuery> queries,
                    boolean negation,
                    boolean isORMatch)

Constructor for a complex RAS Policy Search Query

Parameters:

childQueries - child queries for the complex query.

negation - whether the query result must be negated.

isORMatch - whether the child queries are an OR match.

Method Detail

getSearchByProperty

public RASPolicySearchQuery.SEARCH_PROPERTY getSearchByProperty()

get the search by property in this search query

Returns:

SEARCH_PROPERTY , null if this is a complex search query

getSearchQueryInOrder

public RASPolicySearchQuery[] getSearchQueryInOrder()

Get the child search query in this search query. Return child queries for a complex query, return empty array for a simple query

Returns:

Array of child queries for a complex query, return empty array for a simple query

isPolicyObjectBasedOnly

public boolean isPolicyObjectBasedOnly()

if the search query is based on the Policy object based properties, namely - Name, Display Name, Description, RAS_PARAMETERVALUE and ACL_MATCH_TYPE only

Returns: