LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-09 12:27:47 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update to rule java docs: 5245247870

Browse Source
This commit is contained in:
GitHub Action Bot
2023-06-12 15:04:22 +00:00
parent 5ab4c57eee
commit 9c6d3c443e
116 changed files with 21883 additions and 13877 deletions
Download Patch File Download Diff File Expand all files Collapse all files

576
static/rule-java-docs/sailpoint/api/SailPointContext.html
View File

@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_322) on Wed Sep 21 11:32:21 EDT 2022 -->
<!-- Generated by javadoc (1.8.0_322) on Mon Jun 05 14:25:12 EDT 2023 -->
<title>SailPointContext</title>
<meta name="date" content="2022-09-21">
<meta name="date" content="2023-06-05">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../script.js"></script>
</head>
@@ -18,8 +18,8 @@
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":38,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],32:["t6","Deprecated Methods"]};
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
@@ -48,7 +48,7 @@ var activeTableTab = "activeTableTab";
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../sailpoint/api/PersistenceManager.LockPhase.html" title="enum in sailpoint.api"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Prev&nbsp;Class</li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
@@ -75,13 +75,13 @@ var activeTableTab = "activeTableTab";
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
@@ -92,56 +92,50 @@ var activeTableTab = "activeTableTab";
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">sailpoint.api</div>
<h2 title="Interface SailPointContext" class="title">Interface SailPointContext</h2>
<h2 title="Class SailPointContext" class="title">Class SailPointContext</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>sailpoint.api.SailPointContext</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="../../sailpoint/api/PersistenceManager.html" title="interface in sailpoint.api">PersistenceManager</a>, <a href="../../sailpoint/object/Resolver.html" title="interface in sailpoint.object">Resolver</a>, <a href="../../sailpoint/object/RuleRunner.html" title="interface in sailpoint.object">RuleRunner</a>, <a href="../../sailpoint/tools/xml/XMLReferenceResolver.html" title="interface in sailpoint.tools.xml">XMLReferenceResolver</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">SailPointContext</span>
extends <a href="../../sailpoint/api/PersistenceManager.html" title="interface in sailpoint.api">PersistenceManager</a>, <a href="../../sailpoint/object/RuleRunner.html" title="interface in sailpoint.object">RuleRunner</a>, <a href="../../sailpoint/tools/xml/XMLReferenceResolver.html" title="interface in sailpoint.tools.xml">XMLReferenceResolver</a></pre>
<div class="block">The primary API for accessing the persistent store and performing
core system operations.</div>
<pre>public class <span class="typeNameLabel">SailPointContext</span>
extends java.lang.Object</pre>
<div class="block">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`</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="nested.classes.inherited.from.class.sailpoint.api.PersistenceManager">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface&nbsp;sailpoint.api.<a href="../../sailpoint/api/PersistenceManager.html" title="interface in sailpoint.api">PersistenceManager</a></h3>
<code><a href="../../sailpoint/api/PersistenceManager.LockParameters.html" title="class in sailpoint.api">PersistenceManager.LockParameters</a>, <a href="../../sailpoint/api/PersistenceManager.LockPhase.html" title="enum in sailpoint.api">PersistenceManager.LockPhase</a></code></li>
</ul>
</li>
</ul>
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.sailpoint.api.PersistenceManager">
<!-- -->
</a>
<h3>Fields inherited from interface&nbsp;sailpoint.api.<a href="../../sailpoint/api/PersistenceManager.html" title="interface in sailpoint.api">PersistenceManager</a></h3>
<code><a href="../../sailpoint/api/PersistenceManager.html#LOCK_NAME">LOCK_NAME</a>, <a href="../../sailpoint/api/PersistenceManager.html#LOCK_TYPE">LOCK_TYPE</a>, <a href="../../sailpoint/api/PersistenceManager.html#LOCK_TYPE_PERSISTENT">LOCK_TYPE_PERSISTENT</a>, <a href="../../sailpoint/api/PersistenceManager.html#LOCK_TYPE_TRANSACTION">LOCK_TYPE_TRANSACTION</a></code></li>
</ul>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../sailpoint/api/SailPointContext.html#SailPointContext--">SailPointContext</a></span>()</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
@@ -151,150 +145,61 @@ extends <a href="../../sailpoint/api/PersistenceManager.html" title="interface i
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="../../sailpoint/object/Identity.html" title="interface in sailpoint.object">Identity</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/api/SailPointContext.html#authenticate-java.lang.String-java.lang.String-">authenticate</a></span>(java.lang.String&nbsp;accountId,
java.lang.String&nbsp;password)</code>
<div class="block">Authenticate a user with the given accountId and password.</div>
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/api/SailPointContext.html#countObjects-java.lang.Class-sailpoint.object.QueryOptions-">countObjects</a></span>(java.lang.Class&nbsp;className,
<a href="../../sailpoint/object/QueryOptions.html" title="class in sailpoint.object">QueryOptions</a>&nbsp;queryOptions)</code>
<div class="block">Query the context to get the number of objects for the given query</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/api/SailPointContext.html#decrypt-java.lang.String-">decrypt</a></span>(java.lang.String&nbsp;src)</code>
<div class="block">Decrypt an encrypted string.</div>
<td class="colFirst"><code>&lt;T&gt;&nbsp;java.lang.Object</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/api/SailPointContext.html#getObjectByName-java.lang.Class-java.lang.String-">getObjectByName</a></span>(java.lang.Class&nbsp;className,
java.lang.String&nbsp;name)</code>
<div class="block">Query the context to get an object by name</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/api/SailPointContext.html#encrypt-java.lang.String-">encrypt</a></span>(java.lang.String&nbsp;src)</code>
<div class="block">Encrypt a string.</div>
<td class="colFirst"><code>&lt;T&gt;&nbsp;java.util.List&lt;T&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/api/SailPointContext.html#getObjects-java.lang.Class-sailpoint.object.QueryOptions-">getObjects</a></span>(java.lang.Class&nbsp;className,
<a href="../../sailpoint/object/QueryOptions.html" title="class in sailpoint.object">QueryOptions</a>&nbsp;queryOptions)</code>
<div class="block">Query the context to get a list of objects for the given query</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../sailpoint/object/Configuration.html" title="interface in sailpoint.object">Configuration</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/api/SailPointContext.html#getConfiguration--">getConfiguration</a></span>()</code>
<div class="block">Retrieve the system configuration object.</div>
<td class="colFirst"><code>&lt;T&gt;&nbsp;java.lang.Object</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/api/SailPointContext.html#getUniqueObject-java.lang.Class-sailpoint.object.Filter...-">getUniqueObject</a></span>(java.lang.Class&nbsp;className,
<a href="../../sailpoint/object/Filter.html" title="class in sailpoint.object">Filter</a>...&nbsp;filters)</code>
<div class="block">Query the context to get a unique object with filters</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>java.sql.Connection</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/api/SailPointContext.html#getConnection--">getConnection</a></span>()</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">Use <a href="../../sailpoint/api/SailPointContext.html#getJdbcConnection--"><code>getJdbcConnection()</code></a></span></div>
</div>
<td class="colFirst"><code>java.util.Iterator&lt;java.lang.Object[]&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/api/SailPointContext.html#search-java.lang.Class-sailpoint.object.QueryOptions-">search</a></span>(java.lang.Class&nbsp;className,
<a href="../../sailpoint/object/QueryOptions.html" title="class in sailpoint.object">QueryOptions</a>&nbsp;queryOptions)</code>
<div class="block">Query the context to get a list of results that match the given query</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="../../sailpoint/api/SailPointContext.html" title="interface in sailpoint.api">SailPointContext</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/api/SailPointContext.html#getContext--">getContext</a></span>()</code>
<div class="block">Return a context derived from this one.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>java.sql.Connection</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/api/SailPointContext.html#getJdbcConnection--">getJdbcConnection</a></span>()</code>
<div class="block">Return a JDBC Connection to the underlying database.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/api/SailPointContext.html#getProperty-java.lang.String-">getProperty</a></span>(java.lang.String&nbsp;name)</code>
<div class="block">Return the property with the given name.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/api/SailPointContext.html#getScopeResults--">getScopeResults</a></span>()</code>
<div class="block">Returns true if query results are being scoped.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/api/SailPointContext.html#getUserName--">getUserName</a></span>()</code>
<div class="block">Return the name of the current user of this context.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/api/SailPointContext.html#impersonate-sailpoint.object.Identity-">impersonate</a></span>(<a href="../../sailpoint/object/Identity.html" title="interface in sailpoint.object">Identity</a>&nbsp;identity)</code>
<div class="block">This can be used to impersonate the given identity with respect to the
scoping that is applied.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/api/SailPointContext.html#isClosed--">isClosed</a></span>()</code>
<div class="block">Return true if this context has been closed and can no longer be used.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/api/SailPointContext.html#prepare--">prepare</a></span>()</code>
<div class="block">Method to be called by the SailPointFactory immediately after
creating a context from a prototype.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/api/SailPointContext.html#sendEmailNotification-sailpoint.object.EmailTemplate-sailpoint.object.EmailOptions-">sendEmailNotification</a></span>(<a href="../../sailpoint/object/EmailTemplate.html" title="interface in sailpoint.object">EmailTemplate</a>&nbsp;template,
<a href="../../sailpoint/object/EmailOptions.html" title="interface in sailpoint.object">EmailOptions</a>&nbsp;options)</code>
<div class="block">Send an email notification.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/api/SailPointContext.html#setProperty-java.lang.String-java.lang.Object-">setProperty</a></span>(java.lang.String&nbsp;name,
java.lang.Object&nbsp;value)</code>
<div class="block">Set a context property.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/api/SailPointContext.html#setScopeResults-boolean-">setScopeResults</a></span>(boolean&nbsp;scopeResults)</code>
<div class="block">Set whether the results from search and getObjects methods should
have scoping applied to them based on the controlled scopes of the
user set with <code>setUserName(String)</code>.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/api/SailPointContext.html#setUserName-java.lang.String-">setUserName</a></span>(java.lang.String&nbsp;name)</code>
<div class="block">Set the name of the current user of this context.</div>
<td class="colFirst"><code>java.util.Iterator&lt;java.lang.Object[]&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/api/SailPointContext.html#search-java.lang.Class-sailpoint.object.QueryOptions-java.lang.String-">search</a></span>(java.lang.Class&nbsp;className,
<a href="../../sailpoint/object/QueryOptions.html" title="class in sailpoint.object">QueryOptions</a>&nbsp;queryOptions,
java.lang.String&nbsp;attributes)</code>
<div class="block">Query the context to get a list of results only including the attributes provided that match the given query</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.sailpoint.api.PersistenceManager">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;sailpoint.api.<a href="../../sailpoint/api/PersistenceManager.html" title="interface in sailpoint.api">PersistenceManager</a></h3>
<code><a href="../../sailpoint/api/PersistenceManager.html#attach-sailpoint.object.SailPointObject-">attach</a>, <a href="../../sailpoint/api/PersistenceManager.html#clearHighLevelCache--">clearHighLevelCache</a>, <a href="../../sailpoint/api/PersistenceManager.html#clone--">clone</a>, <a href="../../sailpoint/api/PersistenceManager.html#close--">close</a>, <a href="../../sailpoint/api/PersistenceManager.html#commitTransaction--">commitTransaction</a>, <a href="../../sailpoint/api/PersistenceManager.html#commitTransaction-boolean-">commitTransaction</a>, <a href="../../sailpoint/api/PersistenceManager.html#countObjects-java.lang.Class-sailpoint.object.QueryOptions-">countObjects</a>, <a href="../../sailpoint/api/PersistenceManager.html#decache--">decache</a>, <a href="../../sailpoint/api/PersistenceManager.html#decache-sailpoint.object.SailPointObject-">decache</a>, <a href="../../sailpoint/api/PersistenceManager.html#enableStatistics-boolean-">enableStatistics</a>, <a href="../../sailpoint/api/PersistenceManager.html#getObjectById-java.lang.Class-java.lang.String-">getObjectById</a>, <a href="../../sailpoint/api/PersistenceManager.html#getObjectByName-java.lang.Class-java.lang.String-">getObjectByName</a>, <a href="../../sailpoint/api/PersistenceManager.html#getObjects-java.lang.Class-">getObjects</a>, <a href="../../sailpoint/api/PersistenceManager.html#getObjects-java.lang.Class-sailpoint.object.QueryOptions-">getObjects</a>, <a href="../../sailpoint/api/PersistenceManager.html#getPersistenceOptions--">getPersistenceOptions</a>, <a href="../../sailpoint/api/PersistenceManager.html#getPropertyIterator-java.lang.Class-sailpoint.object.QueryOptions-java.lang.String-">getPropertyIterator</a>, <a href="../../sailpoint/api/PersistenceManager.html#getPropertyList-java.lang.Class-sailpoint.object.QueryOptions-java.lang.String-">getPropertyList</a>, <a href="../../sailpoint/api/PersistenceManager.html#getUniqueObject-java.lang.Class-sailpoint.object.Filter-">getUniqueObject</a>, <a href="../../sailpoint/api/PersistenceManager.html#getUniqueObject-T-">getUniqueObject</a>, <a href="../../sailpoint/api/PersistenceManager.html#importObject-sailpoint.object.SailPointObject-">importObject</a>, <a href="../../sailpoint/api/PersistenceManager.html#lockObject-java.lang.Class-sailpoint.api.PersistenceManager.LockParameters-">lockObject</a>, <a href="../../sailpoint/api/PersistenceManager.html#lockObjectById-java.lang.Class-java.lang.String-java.util.Map-">lockObjectById</a>, <a href="../../sailpoint/api/PersistenceManager.html#lockObjectByName-java.lang.Class-java.lang.String-java.util.Map-">lockObjectByName</a>, <a href="../../sailpoint/api/PersistenceManager.html#printStatistics--">printStatistics</a>, <a href="../../sailpoint/api/PersistenceManager.html#reconnect--">reconnect</a>, <a href="../../sailpoint/api/PersistenceManager.html#releasePersistentLocks--">releasePersistentLocks</a>, <a href="../../sailpoint/api/PersistenceManager.html#removeObject-sailpoint.object.SailPointObject-">removeObject</a>, <a href="../../sailpoint/api/PersistenceManager.html#removeObjects-java.lang.Class-sailpoint.object.QueryOptions-">removeObjects</a>, <a href="../../sailpoint/api/PersistenceManager.html#requiresJoin-java.lang.Class-sailpoint.object.QueryOptions-java.util.List-">requiresJoin</a>, <a href="../../sailpoint/api/PersistenceManager.html#rollbackTransaction--">rollbackTransaction</a>, <a href="../../sailpoint/api/PersistenceManager.html#saveObject-sailpoint.object.SailPointObject-">saveObject</a>, <a href="../../sailpoint/api/PersistenceManager.html#search-java.lang.Class-sailpoint.object.QueryOptions-">search</a>, <a href="../../sailpoint/api/PersistenceManager.html#search-java.lang.Class-sailpoint.object.QueryOptions-java.util.List-">search</a>, <a href="../../sailpoint/api/PersistenceManager.html#search-java.lang.Class-sailpoint.object.QueryOptions-java.lang.String-">search</a>, <a href="../../sailpoint/api/PersistenceManager.html#search-java.lang.String-java.util.Map-sailpoint.object.QueryOptions-">search</a>, <a href="../../sailpoint/api/PersistenceManager.html#setPersistenceOptions-sailpoint.object.PersistenceOptions-">setPersistenceOptions</a>, <a href="../../sailpoint/api/PersistenceManager.html#startTransaction--">startTransaction</a>, <a href="../../sailpoint/api/PersistenceManager.html#unlockObject-T-">unlockObject</a>, <a href="../../sailpoint/api/PersistenceManager.html#update-java.lang.String-java.util.Map-">update</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.sailpoint.object.Resolver">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;sailpoint.object.<a href="../../sailpoint/object/Resolver.html" title="interface in sailpoint.object">Resolver</a></h3>
<code><a href="../../sailpoint/object/Resolver.html#getObject-java.lang.Class-java.lang.String-">getObject</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.sailpoint.object.RuleRunner">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;sailpoint.object.<a href="../../sailpoint/object/RuleRunner.html" title="interface in sailpoint.object">RuleRunner</a></h3>
<code><a href="../../sailpoint/object/RuleRunner.html#runRule-sailpoint.object.Rule-java.util.Map-">runRule</a>, <a href="../../sailpoint/object/RuleRunner.html#runRule-sailpoint.object.Rule-java.util.Map-java.util.List-">runRule</a>, <a href="../../sailpoint/object/RuleRunner.html#runScript-sailpoint.object.Script-java.util.Map-">runScript</a>, <a href="../../sailpoint/object/RuleRunner.html#runScript-sailpoint.object.Script-java.util.Map-java.util.List-">runScript</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.sailpoint.tools.xml.XMLReferenceResolver">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;sailpoint.tools.xml.<a href="../../sailpoint/tools/xml/XMLReferenceResolver.html" title="interface in sailpoint.tools.xml">XMLReferenceResolver</a></h3>
<code><a href="../../sailpoint/tools/xml/XMLReferenceResolver.html#getReferencedObject-java.lang.String-java.lang.String-java.lang.String-">getReferencedObject</a></code></li>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
@@ -304,275 +209,136 @@ extends <a href="../../sailpoint/api/PersistenceManager.html" title="interface i
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="SailPointContext--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>SailPointContext</h4>
<pre>public&nbsp;SailPointContext()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getContext--">
<a name="countObjects-java.lang.Class-sailpoint.object.QueryOptions-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getContext</h4>
<pre><a href="../../sailpoint/api/SailPointContext.html" title="interface in sailpoint.api">SailPointContext</a>&nbsp;getContext()</pre>
<div class="block">Return a context derived from this one.
A single prototype context can serve as a factory for
thread-specific contexts, depending on the implementation.
SailPointFactory will always call this when returning contexts.</div>
</li>
</ul>
<a name="prepare--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>prepare</h4>
<pre>void&nbsp;prepare()</pre>
<div class="block">Method to be called by the SailPointFactory immediately after
creating a context from a prototype. See comments
in InternalContext for the complex and unfortunate reason.</div>
</li>
</ul>
<a name="getJdbcConnection--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getJdbcConnection</h4>
<pre>java.sql.Connection&nbsp;getJdbcConnection()
throws <a href="../../sailpoint/tools/GeneralException.html" title="class in sailpoint.tools">GeneralException</a></pre>
<div class="block">Return a JDBC Connection to the underlying database.
This is used in a few places that need to run complex SQL
queries. It should be unnecessary now that you
can run SQL with <a href="../../sailpoint/api/PersistenceManager.html#search-java.lang.Class-sailpoint.object.QueryOptions-"><code>PersistenceManager.search(java.lang.Class&lt;T&gt;, sailpoint.object.QueryOptions)</code></a>.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../sailpoint/tools/GeneralException.html" title="class in sailpoint.tools">GeneralException</a></code></dd>
</dl>
</li>
</ul>
<a name="getConnection--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getConnection</h4>
<pre>@Deprecated
java.sql.Connection&nbsp;getConnection()
throws <a href="../../sailpoint/tools/GeneralException.html" title="class in sailpoint.tools">GeneralException</a></pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">Use <a href="../../sailpoint/api/SailPointContext.html#getJdbcConnection--"><code>getJdbcConnection()</code></a></span></div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../sailpoint/tools/GeneralException.html" title="class in sailpoint.tools">GeneralException</a></code></dd>
</dl>
</li>
</ul>
<a name="isClosed--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isClosed</h4>
<pre>boolean&nbsp;isClosed()</pre>
<div class="block">Return true if this context has been closed and can no longer be used.</div>
</li>
</ul>
<a name="setUserName-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setUserName</h4>
<pre>void&nbsp;setUserName(java.lang.String&nbsp;name)</pre>
<div class="block">Set the name of the current user of this context. This will
be used when generating audit events.</div>
</li>
</ul>
<a name="getUserName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUserName</h4>
<pre>java.lang.String&nbsp;getUserName()</pre>
<div class="block">Return the name of the current user of this context.
This will normally be the name of an Identity but
occasionally it might be an abstract name like "System"
or "Scheduler".</div>
</li>
</ul>
<a name="impersonate-sailpoint.object.Identity-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>impersonate</h4>
<pre>void&nbsp;impersonate(<a href="../../sailpoint/object/Identity.html" title="interface in sailpoint.object">Identity</a>&nbsp;identity)</pre>
<div class="block">This can be used to impersonate the given identity with respect to the
scoping that is applied. When impersonating, the given identity's
controlled scopes are used to scope results rather than the user
specified by setUserName(String). Note that this Identity does not have
to be persistent.</div>
<h4>countObjects</h4>
<pre>public&nbsp;int&nbsp;countObjects(java.lang.Class&nbsp;className,
<a href="../../sailpoint/object/QueryOptions.html" title="class in sailpoint.object">QueryOptions</a>&nbsp;queryOptions)</pre>
<div class="block">Query the context to get the number of objects for the given query</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>identity</code> - The Identity to impersonate for scoping.</dd>
</dl>
</li>
</ul>
<a name="setScopeResults-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setScopeResults</h4>
<pre>void&nbsp;setScopeResults(boolean&nbsp;scopeResults)</pre>
<div class="block">Set whether the results from search and getObjects methods should
have scoping applied to them based on the controlled scopes of the
user set with <code>setUserName(String)</code>. This can be
overridden by the QueryOptions that are passed into the searching
methods. Scoping results is disabled by default.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>scopeResults</code> - Whether results from the search methods should
be scoped.</dd>
</dl>
</li>
</ul>
<a name="getScopeResults--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getScopeResults</h4>
<pre>boolean&nbsp;getScopeResults()</pre>
<div class="block">Returns true if query results are being scoped.</div>
</li>
</ul>
<a name="getConfiguration--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getConfiguration</h4>
<pre><a href="../../sailpoint/object/Configuration.html" title="interface in sailpoint.object">Configuration</a>&nbsp;getConfiguration()
throws <a href="../../sailpoint/tools/GeneralException.html" title="class in sailpoint.tools">GeneralException</a></pre>
<div class="block">Retrieve the system configuration object.
You can also get this just by calling getObject() but
this method will use a static cache.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../sailpoint/tools/GeneralException.html" title="class in sailpoint.tools">GeneralException</a></code></dd>
</dl>
</li>
</ul>
<a name="encrypt-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>encrypt</h4>
<pre>java.lang.String&nbsp;encrypt(java.lang.String&nbsp;src)
throws <a href="../../sailpoint/tools/GeneralException.html" title="class in sailpoint.tools">GeneralException</a></pre>
<div class="block">Encrypt a string.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../sailpoint/tools/GeneralException.html" title="class in sailpoint.tools">GeneralException</a></code></dd>
</dl>
</li>
</ul>
<a name="decrypt-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>decrypt</h4>
<pre>java.lang.String&nbsp;decrypt(java.lang.String&nbsp;src)
throws <a href="../../sailpoint/tools/GeneralException.html" title="class in sailpoint.tools">GeneralException</a></pre>
<div class="block">Decrypt an encrypted string.
This can fail if the context does not have privileges
to perform decryption.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../sailpoint/tools/GeneralException.html" title="class in sailpoint.tools">GeneralException</a></code></dd>
</dl>
</li>
</ul>
<a name="sendEmailNotification-sailpoint.object.EmailTemplate-sailpoint.object.EmailOptions-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sendEmailNotification</h4>
<pre>void&nbsp;sendEmailNotification(<a href="../../sailpoint/object/EmailTemplate.html" title="interface in sailpoint.object">EmailTemplate</a>&nbsp;template,
<a href="../../sailpoint/object/EmailOptions.html" title="interface in sailpoint.object">EmailOptions</a>&nbsp;options)
throws <a href="../../sailpoint/tools/GeneralException.html" title="class in sailpoint.tools">GeneralException</a></pre>
<div class="block">Send an email notification.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../sailpoint/tools/EmailException.html" title="interface in sailpoint.tools">EmailException</a></code> - If there is a problem sending the email.</dd>
<dd><code><a href="../../sailpoint/tools/GeneralException.html" title="class in sailpoint.tools">GeneralException</a></code> - If there is a system error.</dd>
</dl>
</li>
</ul>
<a name="authenticate-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>authenticate</h4>
<pre><a href="../../sailpoint/object/Identity.html" title="interface in sailpoint.object">Identity</a>&nbsp;authenticate(java.lang.String&nbsp;accountId,
java.lang.String&nbsp;password)
throws <a href="../../sailpoint/tools/GeneralException.html" title="class in sailpoint.tools">GeneralException</a></pre>
<div class="block">Authenticate a user with the given accountId and password.
This should have the side-effect of creating a new <code>Identity</code> if
the following criteria are met:
<ol>
<li>Authentication is passed-through to another authentication source
and succeeds.</li>
<li>The account that was correlated on the pass-through authentication
source does not have a corresponding <code>Identity</code>.</li>
</ol></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>accountId</code> - A unique identifier for the user/account to
authenticate.</dd>
<dd><code>password</code> - The password to use in the authentication credentials.</dd>
<dd><code>className</code> - Identity or Link class</dd>
<dd><code>queryOptions</code> - options to filter results</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The authenticated or newly created user if authentication
succeeded.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../sailpoint/tools/GeneralException.html" title="class in sailpoint.tools">GeneralException</a></code> - Can be thrown if authentication fails for some
reason (invalid password, account locked), if
an account/user with the given accountId cannot
was not found, or a problem occurs when
auto-creating a user.</dd>
<dd>the number of objects found</dd>
</dl>
</li>
</ul>
<a name="setProperty-java.lang.String-java.lang.Object-">
<a name="getObjects-java.lang.Class-sailpoint.object.QueryOptions-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setProperty</h4>
<pre>void&nbsp;setProperty(java.lang.String&nbsp;name,
java.lang.Object&nbsp;value)</pre>
<div class="block">Set a context property. This is intended only for diagnostics,
currently there are not any publicly defined properties.</div>
<h4>getObjects</h4>
<pre>public&nbsp;&lt;T&gt;&nbsp;java.util.List&lt;T&gt;&nbsp;getObjects(java.lang.Class&nbsp;className,
<a href="../../sailpoint/object/QueryOptions.html" title="class in sailpoint.object">QueryOptions</a>&nbsp;queryOptions)</pre>
<div class="block">Query the context to get a list of objects for the given query</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>className</code> - Identity or Link class</dd>
<dd><code>queryOptions</code> - options to filter results</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the list of objects found</dd>
</dl>
</li>
</ul>
<a name="getProperty-java.lang.String-">
<a name="search-java.lang.Class-sailpoint.object.QueryOptions-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>search</h4>
<pre>public&nbsp;java.util.Iterator&lt;java.lang.Object[]&gt;&nbsp;search(java.lang.Class&nbsp;className,
<a href="../../sailpoint/object/QueryOptions.html" title="class in sailpoint.object">QueryOptions</a>&nbsp;queryOptions,
java.lang.String&nbsp;attributes)</pre>
<div class="block">Query the context to get a list of results only including the attributes provided that match the given query</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>className</code> - Identity or Link class</dd>
<dd><code>queryOptions</code> - options to filter results</dd>
<dd><code>attributes</code> - the attributes to return</dd>
<dt><span class="returnLabel">Returns:</span></dt>
</dl>
</li>
</ul>
<a name="search-java.lang.Class-sailpoint.object.QueryOptions-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>search</h4>
<pre>public&nbsp;java.util.Iterator&lt;java.lang.Object[]&gt;&nbsp;search(java.lang.Class&nbsp;className,
<a href="../../sailpoint/object/QueryOptions.html" title="class in sailpoint.object">QueryOptions</a>&nbsp;queryOptions)</pre>
<div class="block">Query the context to get a list of results that match the given query</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>className</code> - Identity or Link class</dd>
<dd><code>queryOptions</code> - options to filter results</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the results of the query</dd>
</dl>
</li>
</ul>
<a name="getObjectByName-java.lang.Class-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getObjectByName</h4>
<pre>public&nbsp;&lt;T&gt;&nbsp;java.lang.Object&nbsp;getObjectByName(java.lang.Class&nbsp;className,
java.lang.String&nbsp;name)</pre>
<div class="block">Query the context to get an object by name</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>className</code> - Identity or Link class</dd>
<dd><code>name</code> - the name of the object to fetch</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the result of the query</dd>
</dl>
</li>
</ul>
<a name="getUniqueObject-java.lang.Class-sailpoint.object.Filter...-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getProperty</h4>
<pre>java.lang.Object&nbsp;getProperty(java.lang.String&nbsp;name)</pre>
<div class="block">Return the property with the given name.</div>
<h4>getUniqueObject</h4>
<pre>public&nbsp;&lt;T&gt;&nbsp;java.lang.Object&nbsp;getUniqueObject(java.lang.Class&nbsp;className,
<a href="../../sailpoint/object/Filter.html" title="class in sailpoint.object">Filter</a>...&nbsp;filters)</pre>
<div class="block">Query the context to get a unique object with filters</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>className</code> - Identity or Link class</dd>
<dd><code>filters</code> - options to filter by</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the result of the query</dd>
</dl>
</li>
</ul>
</li>
@@ -602,7 +368,7 @@ java.sql.Connection&nbsp;getConnection()
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../sailpoint/api/PersistenceManager.LockPhase.html" title="enum in sailpoint.api"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Prev&nbsp;Class</li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
@@ -629,13 +395,13 @@ java.sql.Connection&nbsp;getConnection()
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>