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

Class RASResourceSearchQuery

java.lang.Object

oracle.security.jps.search.SearchQuery

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

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

public class RASResourceSearchQuery
extends BaseSearchQuery

A Class to build search criteria to query RAS Resources- data realms.

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

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

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

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

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

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

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

Please note that you must specify a RAS resource type query if you want to use oracle.security.jps.service.policystore.entitymanager.RASResourceManager.getRASResources(oracle.security.jps.service.policystore.search.RASResourceSearchQuery)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RASResourceSearchQuery.SEARCH_PROPERTY Criteria to search a Resource By

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

SearchQuery.MATCHER

Constructor Summary

Constructors

Constructor and Description
RASResourceSearchQuery(java.util.List<RASResourceSearchQuery> childQueries, boolean negation, boolean isORMatch) Constructor for a complex Resource Search Query
RASResourceSearchQuery(RASResourceSearchQuery.SEARCH_PROPERTY property, boolean negation, ComparatorType operator, java.lang.Object value, SearchQuery.MATCHER m) Protected constructor (off limits to clients).

Method Summary

Methods

Modifier and Type	Method and Description
RASResourceSearchQuery.SEARCH_PROPERTY	getSearchByProperty() Get the search property to use in the search.
RASResourceSearchQuery[]	getSearchQueryInOrder() Get all added queries in the order they were added.

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

RASResourceSearchQuery

public RASResourceSearchQuery(java.util.List<RASResourceSearchQuery> childQueries,
                      boolean negation,
                      boolean isORMatch)

Constructor for a complex Resource Search Query

Parameters:

childQueries -

negation -

isORMatch -

RASResourceSearchQuery

public RASResourceSearchQuery(RASResourceSearchQuery.SEARCH_PROPERTY property,
                      boolean negation,
                      ComparatorType operator,
                      java.lang.Object value,
                      SearchQuery.MATCHER m)

Protected constructor (off limits to clients).

Parameters:

property - -- search property, See RASResourceSearchQuery.SEARCH_PROPERTY for list of valid values

negation - -- negate the search?

operator - -- Type of comparison

value - -- value to search for

m - -- matching to be performed.

Method Detail

getSearchByProperty

public RASResourceSearchQuery.SEARCH_PROPERTY getSearchByProperty()

Get the search property to use in the search.

Returns:

SEARCH_PROPERTY object if this query does not have any other queries added otherwise null.

getSearchQueryInOrder

public RASResourceSearchQuery[] getSearchQueryInOrder()

Get all added queries in the order they were added.

Returns:

Array of RASResourceSearchQuery objects