Add Java Documentation to rules docs

This commit is contained in:
tyler-mairose-sp
2023-05-03 23:14:09 -04:00
parent 3e0910cadf
commit 79ac11b8f2
142 changed files with 260339 additions and 0 deletions

View File

@@ -0,0 +1,561 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_322) on Wed Sep 21 11:32:21 EDT 2022 -->
<title>PersistenceManager.LockParameters</title>
<meta name="date" content="2022-09-21">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="PersistenceManager.LockParameters";
}
}
catch(err) {
}
//-->
var methods = {"i0":9,"i1":9,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-files/index-1.html">Index</a></li>
<li><a href="../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../sailpoint/api/PersistenceManager.html" title="interface in sailpoint.api"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../sailpoint/api/PersistenceManager.LockPhase.html" title="enum in sailpoint.api"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&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><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">sailpoint.api</div>
<h2 title="Class PersistenceManager.LockParameters" class="title">Class PersistenceManager.LockParameters</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>sailpoint.api.PersistenceManager.LockParameters</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>Enclosing interface:</dt>
<dd><a href="../../sailpoint/api/PersistenceManager.html" title="interface in sailpoint.api">PersistenceManager</a></dd>
</dl>
<hr>
<br>
<pre>public static class <span class="typeNameLabel">PersistenceManager.LockParameters</span>
extends java.lang.Object</pre>
<div class="block">Encapsulation of lock parameters.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<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/PersistenceManager.LockParameters.html#LockParameters--">LockParameters</a></span>()</code>
<div class="block">Constructor.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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>static <a href="../../sailpoint/api/PersistenceManager.LockParameters.html" title="class in sailpoint.api">PersistenceManager.LockParameters</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/api/PersistenceManager.LockParameters.html#createById-java.lang.String-java.lang.String-java.lang.String-">createById</a></span>(java.lang.String&nbsp;id,
java.lang.String&nbsp;lockType,
java.lang.String&nbsp;lockName)</code>
<div class="block">Convenience method to create default locking object that locks by ID
with the given ID, type and lockName.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static <a href="../../sailpoint/api/PersistenceManager.LockParameters.html" title="class in sailpoint.api">PersistenceManager.LockParameters</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/api/PersistenceManager.LockParameters.html#createByName-java.lang.String-java.lang.String-java.lang.String-">createByName</a></span>(java.lang.String&nbsp;name,
java.lang.String&nbsp;lockType,
java.lang.String&nbsp;lockName)</code>
<div class="block">Convenience method to create default locking object that locks by
name with the given name, type and lockName.</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/PersistenceManager.LockParameters.html#getColumn--">getColumn</a></span>()</code>
<div class="block">Return the column that is used to find the object to lock - typically
either name or id.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/api/PersistenceManager.LockParameters.html#getLockDuration--">getLockDuration</a></span>()</code>
<div class="block">Return the duration in minutes of the lock.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/api/PersistenceManager.LockParameters.html#getLockName--">getLockName</a></span>()</code>
<div class="block">Return the name of this lock.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="../../sailpoint/api/PersistenceManager.LockPhase.html" title="enum in sailpoint.api">PersistenceManager.LockPhase</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/api/PersistenceManager.LockParameters.html#getLockPhase--">getLockPhase</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/api/PersistenceManager.LockParameters.html#getLockTimeout--">getLockTimeout</a></span>()</code>
<div class="block">Return the timeout in seconds before trying to obtain a lock fails.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/api/PersistenceManager.LockParameters.html#getLockType--">getLockType</a></span>()</code>
<div class="block">Return the type of lock - one of <a href="../../sailpoint/api/PersistenceManager.html#LOCK_TYPE_PERSISTENT"><code>PersistenceManager.LOCK_TYPE_PERSISTENT</code></a>
or <a href="../../sailpoint/api/PersistenceManager.html#LOCK_TYPE_TRANSACTION"><code>PersistenceManager.LOCK_TYPE_TRANSACTION</code></a>.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/api/PersistenceManager.LockParameters.html#getValue--">getValue</a></span>()</code>
<div class="block">Return the value to use to look up the object to lock.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/api/PersistenceManager.LockParameters.html#isTransactionLock--">isTransactionLock</a></span>()</code>
<div class="block">Return whether this is a transaction lock.</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/PersistenceManager.LockParameters.html#setColumn-java.lang.String-">setColumn</a></span>(java.lang.String&nbsp;val)</code>&nbsp;</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/api/PersistenceManager.LockParameters.html#setId-java.lang.String-">setId</a></span>(java.lang.String&nbsp;id)</code>
<div class="block">Set the ID of the object to lock.</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/PersistenceManager.LockParameters.html#setLockDuration-int-">setLockDuration</a></span>(int&nbsp;val)</code>&nbsp;</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/PersistenceManager.LockParameters.html#setLockName-java.lang.String-">setLockName</a></span>(java.lang.String&nbsp;val)</code>&nbsp;</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/PersistenceManager.LockParameters.html#setLockPhase-sailpoint.api.PersistenceManager.LockPhase-">setLockPhase</a></span>(<a href="../../sailpoint/api/PersistenceManager.LockPhase.html" title="enum in sailpoint.api">PersistenceManager.LockPhase</a>&nbsp;lockPhase)</code>&nbsp;</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/PersistenceManager.LockParameters.html#setLockTimeout-int-">setLockTimeout</a></span>(int&nbsp;val)</code>&nbsp;</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/PersistenceManager.LockParameters.html#setLockType-java.lang.String-">setLockType</a></span>(java.lang.String&nbsp;val)</code>&nbsp;</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/api/PersistenceManager.LockParameters.html#setName-java.lang.String-">setName</a></span>(java.lang.String&nbsp;name)</code>
<div class="block">Set the name of the object to lock.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/api/PersistenceManager.LockParameters.html#setValue-java.lang.String-">setValue</a></span>(java.lang.String&nbsp;val)</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<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>
</li>
</ul>
</div>
<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="LockParameters--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>LockParameters</h4>
<pre>public&nbsp;LockParameters()</pre>
<div class="block">Constructor.</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getLockPhase--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLockPhase</h4>
<pre>public&nbsp;<a href="../../sailpoint/api/PersistenceManager.LockPhase.html" title="enum in sailpoint.api">PersistenceManager.LockPhase</a>&nbsp;getLockPhase()</pre>
</li>
</ul>
<a name="setLockPhase-sailpoint.api.PersistenceManager.LockPhase-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setLockPhase</h4>
<pre>public&nbsp;void&nbsp;setLockPhase(<a href="../../sailpoint/api/PersistenceManager.LockPhase.html" title="enum in sailpoint.api">PersistenceManager.LockPhase</a>&nbsp;lockPhase)</pre>
</li>
</ul>
<a name="getLockName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLockName</h4>
<pre>public&nbsp;java.lang.String&nbsp;getLockName()</pre>
<div class="block">Return the name of this lock.</div>
</li>
</ul>
<a name="setLockName-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setLockName</h4>
<pre>public&nbsp;void&nbsp;setLockName(java.lang.String&nbsp;val)</pre>
</li>
</ul>
<a name="getColumn--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getColumn</h4>
<pre>public&nbsp;java.lang.String&nbsp;getColumn()</pre>
<div class="block">Return the column that is used to find the object to lock - typically
either name or id.</div>
</li>
</ul>
<a name="setColumn-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setColumn</h4>
<pre>public&nbsp;void&nbsp;setColumn(java.lang.String&nbsp;val)</pre>
</li>
</ul>
<a name="getValue--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getValue</h4>
<pre>public&nbsp;java.lang.String&nbsp;getValue()</pre>
<div class="block">Return the value to use to look up the object to lock. The value is
typically an object ID or name depending on the getColumn().</div>
</li>
</ul>
<a name="setValue-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setValue</h4>
<pre>public&nbsp;void&nbsp;setValue(java.lang.String&nbsp;val)</pre>
</li>
</ul>
<a name="getLockType--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLockType</h4>
<pre>public&nbsp;java.lang.String&nbsp;getLockType()</pre>
<div class="block">Return the type of lock - one of <a href="../../sailpoint/api/PersistenceManager.html#LOCK_TYPE_PERSISTENT"><code>PersistenceManager.LOCK_TYPE_PERSISTENT</code></a>
or <a href="../../sailpoint/api/PersistenceManager.html#LOCK_TYPE_TRANSACTION"><code>PersistenceManager.LOCK_TYPE_TRANSACTION</code></a>.</div>
</li>
</ul>
<a name="setLockType-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setLockType</h4>
<pre>public&nbsp;void&nbsp;setLockType(java.lang.String&nbsp;val)</pre>
</li>
</ul>
<a name="getLockDuration--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLockDuration</h4>
<pre>public&nbsp;int&nbsp;getLockDuration()</pre>
<div class="block">Return the duration in minutes of the lock.</div>
</li>
</ul>
<a name="setLockDuration-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setLockDuration</h4>
<pre>public&nbsp;void&nbsp;setLockDuration(int&nbsp;val)</pre>
</li>
</ul>
<a name="getLockTimeout--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLockTimeout</h4>
<pre>public&nbsp;int&nbsp;getLockTimeout()</pre>
<div class="block">Return the timeout in seconds before trying to obtain a lock fails.</div>
</li>
</ul>
<a name="setLockTimeout-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setLockTimeout</h4>
<pre>public&nbsp;void&nbsp;setLockTimeout(int&nbsp;val)</pre>
</li>
</ul>
<a name="setId-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setId</h4>
<pre>public&nbsp;void&nbsp;setId(java.lang.String&nbsp;id)</pre>
<div class="block">Set the ID of the object to lock.</div>
</li>
</ul>
<a name="setName-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setName</h4>
<pre>public&nbsp;void&nbsp;setName(java.lang.String&nbsp;name)</pre>
<div class="block">Set the name of the object to lock.</div>
</li>
</ul>
<a name="createById-java.lang.String-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createById</h4>
<pre>public static&nbsp;<a href="../../sailpoint/api/PersistenceManager.LockParameters.html" title="class in sailpoint.api">PersistenceManager.LockParameters</a>&nbsp;createById(java.lang.String&nbsp;id,
java.lang.String&nbsp;lockType,
java.lang.String&nbsp;lockName)</pre>
<div class="block">Convenience method to create default locking object that locks by ID
with the given ID, type and lockName.</div>
</li>
</ul>
<a name="createByName-java.lang.String-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createByName</h4>
<pre>public static&nbsp;<a href="../../sailpoint/api/PersistenceManager.LockParameters.html" title="class in sailpoint.api">PersistenceManager.LockParameters</a>&nbsp;createByName(java.lang.String&nbsp;name,
java.lang.String&nbsp;lockType,
java.lang.String&nbsp;lockName)</pre>
<div class="block">Convenience method to create default locking object that locks by
name with the given name, type and lockName.</div>
</li>
</ul>
<a name="isTransactionLock--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>isTransactionLock</h4>
<pre>public&nbsp;boolean&nbsp;isTransactionLock()</pre>
<div class="block">Return whether this is a transaction lock.</div>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-files/index-1.html">Index</a></li>
<li><a href="../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../sailpoint/api/PersistenceManager.html" title="interface in sailpoint.api"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../sailpoint/api/PersistenceManager.LockPhase.html" title="enum in sailpoint.api"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&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><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>

View File

@@ -0,0 +1,367 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_322) on Wed Sep 21 11:32:21 EDT 2022 -->
<title>PersistenceManager.LockPhase</title>
<meta name="date" content="2022-09-21">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="PersistenceManager.LockPhase";
}
}
catch(err) {
}
//-->
var methods = {"i0":9,"i1":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-files/index-1.html">Index</a></li>
<li><a href="../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../sailpoint/api/PersistenceManager.LockParameters.html" title="class in sailpoint.api"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../sailpoint/api/SailPointContext.html" title="interface in sailpoint.api"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#enum.constant.summary">Enum Constants</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#enum.constant.detail">Enum Constants</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">sailpoint.api</div>
<h2 title="Enum PersistenceManager.LockPhase" class="title">Enum PersistenceManager.LockPhase</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>java.lang.Enum&lt;<a href="../../sailpoint/api/PersistenceManager.LockPhase.html" title="enum in sailpoint.api">PersistenceManager.LockPhase</a>&gt;</li>
<li>
<ul class="inheritance">
<li>sailpoint.api.PersistenceManager.LockPhase</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.io.Serializable, java.lang.Comparable&lt;<a href="../../sailpoint/api/PersistenceManager.LockPhase.html" title="enum in sailpoint.api">PersistenceManager.LockPhase</a>&gt;</dd>
</dl>
<dl>
<dt>Enclosing interface:</dt>
<dd><a href="../../sailpoint/api/PersistenceManager.html" title="interface in sailpoint.api">PersistenceManager</a></dd>
</dl>
<hr>
<br>
<pre>public static enum <span class="typeNameLabel">PersistenceManager.LockPhase</span>
extends java.lang.Enum&lt;<a href="../../sailpoint/api/PersistenceManager.LockPhase.html" title="enum in sailpoint.api">PersistenceManager.LockPhase</a>&gt;</pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== ENUM CONSTANT SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="enum.constant.summary">
<!-- -->
</a>
<h3>Enum Constant Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Constant Summary table, listing enum constants, and an explanation">
<caption><span>Enum Constants</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Enum Constant and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../sailpoint/api/PersistenceManager.LockPhase.html#GOV_LOCK_CIS">GOV_LOCK_CIS</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../sailpoint/api/PersistenceManager.LockPhase.html#GOV_LOCK_CIS_TO_REDIS_TRANSITION">GOV_LOCK_CIS_TO_REDIS_TRANSITION</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../sailpoint/api/PersistenceManager.LockPhase.html#GOV_LOCK_REDIS">GOV_LOCK_REDIS</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../sailpoint/api/PersistenceManager.LockPhase.html#GOV_LOCK_REDIS_TO_CIS_ROLLBACK">GOV_LOCK_REDIS_TO_CIS_ROLLBACK</a></span></code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</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="t1" class="tableTab"><span><a href="javascript:show(1);">Static 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>static <a href="../../sailpoint/api/PersistenceManager.LockPhase.html" title="enum in sailpoint.api">PersistenceManager.LockPhase</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/api/PersistenceManager.LockPhase.html#valueOf-java.lang.String-">valueOf</a></span>(java.lang.String&nbsp;name)</code>
<div class="block">Returns the enum constant of this type with the specified name.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static <a href="../../sailpoint/api/PersistenceManager.LockPhase.html" title="enum in sailpoint.api">PersistenceManager.LockPhase</a>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/api/PersistenceManager.LockPhase.html#values--">values</a></span>()</code>
<div class="block">Returns an array containing the constants of this enum type, in
the order they are declared.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Enum">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Enum</h3>
<code>clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>getClass, notify, notifyAll, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ ENUM CONSTANT DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="enum.constant.detail">
<!-- -->
</a>
<h3>Enum Constant Detail</h3>
<a name="GOV_LOCK_CIS">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>GOV_LOCK_CIS</h4>
<pre>public static final&nbsp;<a href="../../sailpoint/api/PersistenceManager.LockPhase.html" title="enum in sailpoint.api">PersistenceManager.LockPhase</a> GOV_LOCK_CIS</pre>
</li>
</ul>
<a name="GOV_LOCK_CIS_TO_REDIS_TRANSITION">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>GOV_LOCK_CIS_TO_REDIS_TRANSITION</h4>
<pre>public static final&nbsp;<a href="../../sailpoint/api/PersistenceManager.LockPhase.html" title="enum in sailpoint.api">PersistenceManager.LockPhase</a> GOV_LOCK_CIS_TO_REDIS_TRANSITION</pre>
</li>
</ul>
<a name="GOV_LOCK_REDIS">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>GOV_LOCK_REDIS</h4>
<pre>public static final&nbsp;<a href="../../sailpoint/api/PersistenceManager.LockPhase.html" title="enum in sailpoint.api">PersistenceManager.LockPhase</a> GOV_LOCK_REDIS</pre>
</li>
</ul>
<a name="GOV_LOCK_REDIS_TO_CIS_ROLLBACK">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>GOV_LOCK_REDIS_TO_CIS_ROLLBACK</h4>
<pre>public static final&nbsp;<a href="../../sailpoint/api/PersistenceManager.LockPhase.html" title="enum in sailpoint.api">PersistenceManager.LockPhase</a> GOV_LOCK_REDIS_TO_CIS_ROLLBACK</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="values--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>values</h4>
<pre>public static&nbsp;<a href="../../sailpoint/api/PersistenceManager.LockPhase.html" title="enum in sailpoint.api">PersistenceManager.LockPhase</a>[]&nbsp;values()</pre>
<div class="block">Returns an array containing the constants of this enum type, in
the order they are declared. This method may be used to iterate
over the constants as follows:
<pre>
for (PersistenceManager.LockPhase c : PersistenceManager.LockPhase.values())
&nbsp; System.out.println(c);
</pre></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an array containing the constants of this enum type, in the order they are declared</dd>
</dl>
</li>
</ul>
<a name="valueOf-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>valueOf</h4>
<pre>public static&nbsp;<a href="../../sailpoint/api/PersistenceManager.LockPhase.html" title="enum in sailpoint.api">PersistenceManager.LockPhase</a>&nbsp;valueOf(java.lang.String&nbsp;name)</pre>
<div class="block">Returns the enum constant of this type with the specified name.
The string must match <i>exactly</i> an identifier used to declare an
enum constant in this type. (Extraneous whitespace characters are
not permitted.)</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - the name of the enum constant to be returned.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the enum constant with the specified name</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if this enum type has no constant with the specified name</dd>
<dd><code>java.lang.NullPointerException</code> - if the argument is null</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-files/index-1.html">Index</a></li>
<li><a href="../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../sailpoint/api/PersistenceManager.LockParameters.html" title="class in sailpoint.api"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../sailpoint/api/SailPointContext.html" title="interface in sailpoint.api"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#enum.constant.summary">Enum Constants</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#enum.constant.detail">Enum Constants</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>

File diff suppressed because it is too large Load Diff

View File

@@ -0,0 +1,647 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_322) on Wed Sep 21 11:32:21 EDT 2022 -->
<title>SailPointContext</title>
<meta name="date" content="2022-09-21">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="SailPointContext";
}
}
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 altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-files/index-1.html">Index</a></li>
<li><a href="../../help-doc.html">Help</a></li>
</ul>
</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>Next&nbsp;Class</li>
</ul>
<ul class="navList">
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&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="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">sailpoint.api</div>
<h2 title="Interface SailPointContext" class="title">Interface SailPointContext</h2>
</div>
<div class="contentContainer">
<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>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.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>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</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>
<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>
</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>
</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>
</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>
</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>
</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>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.sailpoint.api.PersistenceManager">
<!-- -->
</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>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getContext--">
<!-- -->
</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>
<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>
<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>
</dl>
</li>
</ul>
<a name="setProperty-java.lang.String-java.lang.Object-">
<!-- -->
</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>
</li>
</ul>
<a name="getProperty-java.lang.String-">
<!-- -->
</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>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-files/index-1.html">Index</a></li>
<li><a href="../../help-doc.html">Help</a></li>
</ul>
</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>Next&nbsp;Class</li>
</ul>
<ul class="navList">
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&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="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>

View File

@@ -0,0 +1,29 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_322) on Wed Sep 21 11:32:21 EDT 2022 -->
<title>sailpoint.api</title>
<meta name="date" content="2022-09-21">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../script.js"></script>
</head>
<body>
<h1 class="bar"><a href="../../sailpoint/api/package-summary.html" target="classFrame">sailpoint.api</a></h1>
<div class="indexContainer">
<h2 title="Interfaces">Interfaces</h2>
<ul title="Interfaces">
<li><a href="PersistenceManager.html" title="interface in sailpoint.api" target="classFrame"><span class="interfaceName">PersistenceManager</span></a></li>
<li><a href="SailPointContext.html" title="interface in sailpoint.api" target="classFrame"><span class="interfaceName">SailPointContext</span></a></li>
</ul>
<h2 title="Classes">Classes</h2>
<ul title="Classes">
<li><a href="PersistenceManager.LockParameters.html" title="class in sailpoint.api" target="classFrame">PersistenceManager.LockParameters</a></li>
</ul>
<h2 title="Enums">Enums</h2>
<ul title="Enums">
<li><a href="PersistenceManager.LockPhase.html" title="enum in sailpoint.api" target="classFrame">PersistenceManager.LockPhase</a></li>
</ul>
</div>
</body>
</html>

View File

@@ -0,0 +1,181 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_322) on Wed Sep 21 11:32:21 EDT 2022 -->
<title>sailpoint.api</title>
<meta name="date" content="2022-09-21">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="sailpoint.api";
}
}
catch(err) {
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../overview-summary.html">Overview</a></li>
<li class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-files/index-1.html">Index</a></li>
<li><a href="../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev&nbsp;Package</li>
<li><a href="../../sailpoint/connector/webservices/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 title="Package" class="title">Package&nbsp;sailpoint.api</h1>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation">
<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../sailpoint/api/PersistenceManager.html" title="interface in sailpoint.api">PersistenceManager</a></td>
<td class="colLast">
<div class="block">Interface implemented by classes that provide persistence services.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../sailpoint/api/SailPointContext.html" title="interface in sailpoint.api">SailPointContext</a></td>
<td class="colLast">
<div class="block">The primary API for accessing the persistent store and performing
core system operations.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../sailpoint/api/PersistenceManager.LockParameters.html" title="class in sailpoint.api">PersistenceManager.LockParameters</a></td>
<td class="colLast">
<div class="block">Encapsulation of lock parameters.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation">
<caption><span>Enum Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Enum</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../sailpoint/api/PersistenceManager.LockPhase.html" title="enum in sailpoint.api">PersistenceManager.LockPhase</a></td>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</li>
</ul>
</div>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../overview-summary.html">Overview</a></li>
<li class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-files/index-1.html">Index</a></li>
<li><a href="../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev&nbsp;Package</li>
<li><a href="../../sailpoint/connector/webservices/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>

View File

@@ -0,0 +1,169 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_322) on Wed Sep 21 11:32:21 EDT 2022 -->
<title>sailpoint.api Class Hierarchy</title>
<meta name="date" content="2022-09-21">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="sailpoint.api Class Hierarchy";
}
}
catch(err) {
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li>Class</li>
<li class="navBarCell1Rev">Tree</li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-files/index-1.html">Index</a></li>
<li><a href="../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev</li>
<li><a href="../../sailpoint/connector/webservices/package-tree.html">Next</a></li>
</ul>
<ul class="navList">
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 class="title">Hierarchy For Package sailpoint.api</h1>
<span class="packageHierarchyLabel">Package Hierarchies:</span>
<ul class="horizontal">
<li><a href="../../overview-tree.html">All Packages</a></li>
</ul>
</div>
<div class="contentContainer">
<h2 title="Class Hierarchy">Class Hierarchy</h2>
<ul>
<li type="circle">java.lang.Object
<ul>
<li type="circle">sailpoint.api.<a href="../../sailpoint/api/PersistenceManager.LockParameters.html" title="class in sailpoint.api"><span class="typeNameLink">PersistenceManager.LockParameters</span></a></li>
</ul>
</li>
</ul>
<h2 title="Interface Hierarchy">Interface Hierarchy</h2>
<ul>
<li type="circle">sailpoint.object.<a href="../../sailpoint/object/Resolver.html" title="interface in sailpoint.object"><span class="typeNameLink">Resolver</span></a>
<ul>
<li type="circle">sailpoint.api.<a href="../../sailpoint/api/PersistenceManager.html" title="interface in sailpoint.api"><span class="typeNameLink">PersistenceManager</span></a>
<ul>
<li type="circle">sailpoint.api.<a href="../../sailpoint/api/SailPointContext.html" title="interface in sailpoint.api"><span class="typeNameLink">SailPointContext</span></a> (also extends sailpoint.object.<a href="../../sailpoint/object/RuleRunner.html" title="interface in sailpoint.object">RuleRunner</a>, sailpoint.tools.xml.<a href="../../sailpoint/tools/xml/XMLReferenceResolver.html" title="interface in sailpoint.tools.xml">XMLReferenceResolver</a>)</li>
</ul>
</li>
</ul>
</li>
<li type="circle">sailpoint.object.<a href="../../sailpoint/object/RuleRunner.html" title="interface in sailpoint.object"><span class="typeNameLink">RuleRunner</span></a>
<ul>
<li type="circle">sailpoint.api.<a href="../../sailpoint/api/SailPointContext.html" title="interface in sailpoint.api"><span class="typeNameLink">SailPointContext</span></a> (also extends sailpoint.api.<a href="../../sailpoint/api/PersistenceManager.html" title="interface in sailpoint.api">PersistenceManager</a>, sailpoint.tools.xml.<a href="../../sailpoint/tools/xml/XMLReferenceResolver.html" title="interface in sailpoint.tools.xml">XMLReferenceResolver</a>)</li>
</ul>
</li>
<li type="circle">sailpoint.tools.xml.<a href="../../sailpoint/tools/xml/XMLReferenceResolver.html" title="interface in sailpoint.tools.xml"><span class="typeNameLink">XMLReferenceResolver</span></a>
<ul>
<li type="circle">sailpoint.api.<a href="../../sailpoint/api/SailPointContext.html" title="interface in sailpoint.api"><span class="typeNameLink">SailPointContext</span></a> (also extends sailpoint.api.<a href="../../sailpoint/api/PersistenceManager.html" title="interface in sailpoint.api">PersistenceManager</a>, sailpoint.object.<a href="../../sailpoint/object/RuleRunner.html" title="interface in sailpoint.object">RuleRunner</a>)</li>
</ul>
</li>
</ul>
<h2 title="Enum Hierarchy">Enum Hierarchy</h2>
<ul>
<li type="circle">java.lang.Object
<ul>
<li type="circle">java.lang.Enum&lt;E&gt; (implements java.lang.Comparable&lt;T&gt;, java.io.Serializable)
<ul>
<li type="circle">sailpoint.api.<a href="../../sailpoint/api/PersistenceManager.LockPhase.html" title="enum in sailpoint.api"><span class="typeNameLink">PersistenceManager.LockPhase</span></a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li>Class</li>
<li class="navBarCell1Rev">Tree</li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-files/index-1.html">Index</a></li>
<li><a href="../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev</li>
<li><a href="../../sailpoint/connector/webservices/package-tree.html">Next</a></li>
</ul>
<ul class="navList">
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>