Package sailpoint.api
Class SailPointContext
java.lang.Object
sailpoint.api.SailPointContext
A context object class used to query for data
This class is for old rules using SailPointContext. Any new rules submitted using the following methods will be blocked and
asked to migrate to the replacement methods available in IDNRuleUtil
These methods allow you to pass a class name to query on. The two classes supported are `Identity.class` and `Link.class`
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionintcountObjects(Class className, QueryOptions queryOptions) Query the context to get the number of objects for the given querysailpoint.object.ObjectConfiggetObjectById(Class<Identity> identityClass, String id) <T> ObjectgetObjectByName(Class className, String name) Query the context to get an object by name<T> List<T>getObjects(Class className, QueryOptions queryOptions) Query the context to get a list of objects for the given query<T> ObjectgetUniqueObject(Class className, Filter... filters) Query the context to get a unique object with filters<T> Iterator<T>search(Class className, QueryOptions queryOptions) Query the context to get a list of results that match the given querysearch(Class className, QueryOptions queryOptions, String attributes) Query the context to get a list of results only including the attributes provided that match the given query
-
Constructor Details
-
SailPointContext
public SailPointContext()
-
-
Method Details
-
countObjects
public int countObjects(Class className, QueryOptions queryOptions) throws sailpoint.tools.GeneralException Query the context to get the number of objects for the given query- Parameters:
className- Identity or Link classqueryOptions- options to filter results- Returns:
- the number of objects found
- Throws:
sailpoint.tools.GeneralException
-
getObjects
Query the context to get a list of objects for the given query- Parameters:
className- Identity or Link classqueryOptions- options to filter results- Returns:
- the list of objects found
-
search
Query the context to get a list of results only including the attributes provided that match the given query- Parameters:
className- Identity or Link classqueryOptions- options to filter resultsattributes- the attributes to return- Returns:
-
search
public <T> Iterator<T> search(Class className, QueryOptions queryOptions) throws sailpoint.tools.GeneralException Query the context to get a list of results that match the given query- Parameters:
className- Identity or Link classqueryOptions- options to filter results- Returns:
- the results of the query
- Throws:
sailpoint.tools.GeneralException
-
getObjectByName
Query the context to get an object by name- Parameters:
className- Identity or Link classname- the name of the object to fetch- Returns:
- the result of the query
-
getUniqueObject
Query the context to get a unique object with filters- Parameters:
className- Identity or Link classfilters- options to filter by- Returns:
- the result of the query
-
getObjectById
public Identity getObjectById(Class<Identity> identityClass, String id) throws sailpoint.tools.GeneralException - Throws:
sailpoint.tools.GeneralException
-
getObject
public sailpoint.object.ObjectConfig getObject(Class className, String identity) throws sailpoint.tools.GeneralException - Throws:
sailpoint.tools.GeneralException
-