mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-07 04:19:34 +00:00
Add Java Documentation to rules docs
This commit is contained in:
tyler-mairose-sp
647
static/rule-java-docs/sailpoint/api/SailPointContext.html
Normal file
647
static/rule-java-docs/sailpoint/api/SailPointContext.html
Normal 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 Class</span></a></li>
|
||||
<li>Next Class</li>
|
||||
</ul>
|
||||
<ul class="navList">
|
||||
|
||||
|
||||
</ul>
|
||||
<ul class="navList" id="allclasses_navbar_top">
|
||||
<li><a href="../../allclasses-noframe.html">All 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: </li>
|
||||
<li>Nested | </li>
|
||||
<li>Field | </li>
|
||||
<li>Constr | </li>
|
||||
<li><a href="#method.summary">Method</a></li>
|
||||
</ul>
|
||||
<ul class="subNavList">
|
||||
<li>Detail: </li>
|
||||
<li>Field | </li>
|
||||
<li>Constr | </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 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 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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd"> </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 accountId,
|
||||
java.lang.String 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 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 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>
|
||||
<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 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> 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> template,
|
||||
<a href="../../sailpoint/object/EmailOptions.html" title="interface in sailpoint.object">EmailOptions</a> 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 name,
|
||||
java.lang.Object 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 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 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 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 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 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 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> 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 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 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<T>, 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 getConnection()
|
||||
throws <a href="../../sailpoint/tools/GeneralException.html" title="class in sailpoint.tools">GeneralException</a></pre>
|
||||
<div class="block"><span class="deprecatedLabel">Deprecated.</span> <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 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 setUserName(java.lang.String 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 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 impersonate(<a href="../../sailpoint/object/Identity.html" title="interface in sailpoint.object">Identity</a> 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 setScopeResults(boolean 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 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> 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 encrypt(java.lang.String 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 decrypt(java.lang.String 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 sendEmailNotification(<a href="../../sailpoint/object/EmailTemplate.html" title="interface in sailpoint.object">EmailTemplate</a> template,
|
||||
<a href="../../sailpoint/object/EmailOptions.html" title="interface in sailpoint.object">EmailOptions</a> 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> authenticate(java.lang.String accountId,
|
||||
java.lang.String 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 setProperty(java.lang.String name,
|
||||
java.lang.Object 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 getProperty(java.lang.String 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 Class</span></a></li>
|
||||
<li>Next Class</li>
|
||||
</ul>
|
||||
<ul class="navList">
|
||||
|
||||
|
||||
</ul>
|
||||
<ul class="navList" id="allclasses_navbar_bottom">
|
||||
<li><a href="../../allclasses-noframe.html">All 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: </li>
|
||||
<li>Nested | </li>
|
||||
<li>Field | </li>
|
||||
<li>Constr | </li>
|
||||
<li><a href="#method.summary">Method</a></li>
|
||||
</ul>
|
||||
<ul class="subNavList">
|
||||
<li>Detail: </li>
|
||||
<li>Field | </li>
|
||||
<li>Constr | </li>
|
||||
<li><a href="#method.detail">Method</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<a name="skip.navbar.bottom">
|
||||
<!-- -->
|
||||
</a></div>
|
||||
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
||||
</body>
|
||||
</html>
|
||||
Reference in New Issue
Block a user