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,836 @@
<!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 Tue Nov 08 10:19:03 EST 2022 -->
<title>Endpoint</title>
<meta name="date" content="2022-11-08">
<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="Endpoint";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6,"i19":6,"i20":6,"i21":6,"i22":6,"i23":6,"i24":6,"i25":6,"i26":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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>Prev&nbsp;Class</li>
<li><a href="../../../sailpoint/connector/webservices/WebServicesClient.html" title="interface in sailpoint.connector.webservices"><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>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.connector.webservices</div>
<h2 title="Interface Endpoint" class="title">Interface Endpoint</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public interface <span class="typeNameLabel">Endpoint</span></pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== 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></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>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../sailpoint/connector/webservices/Endpoint.html#addHeader-java.lang.String-java.lang.String-">addHeader</a></span>(java.lang.String&nbsp;entry,
java.lang.String&nbsp;value)</code>
<div class="block">Use this method to add a header value to the existing http header map for the request</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../sailpoint/connector/webservices/Endpoint.html#getAfterRule--">getAfterRule</a></span>()</code>
<div class="block">Use this method to get the name of the rule to run after the webservice request completes.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../sailpoint/connector/webservices/Endpoint.html#getAttribute-java.lang.String-">getAttribute</a></span>(java.lang.String&nbsp;name)</code>
<div class="block">Use this method to get the value of an attribute</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>sailpoint.object.Attributes</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../sailpoint/connector/webservices/Endpoint.html#getAttributes--">getAttributes</a></span>()</code>
<div class="block">Use this method to get all the available attributes</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../sailpoint/connector/webservices/Endpoint.html#getBaseUrl--">getBaseUrl</a></span>()</code>
<div class="block">Use this method to get the base url (endpoint) of the operation that is to be performed for the particular operation</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../sailpoint/connector/webservices/Endpoint.html#getBeforeRule--">getBeforeRule</a></span>()</code>
<div class="block">Use this method to get the name of the rule to run before the webservice request completes</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../sailpoint/connector/webservices/Endpoint.html#getBody--">getBody</a></span>()</code>
<div class="block">Use this method to get the http payload information as a map.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../sailpoint/connector/webservices/Endpoint.html#getContextUrl--">getContextUrl</a></span>()</code>
<div class="block">Use this method to get the context url for the particular operation (create user, update user, account aggregation, etc...)</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../sailpoint/connector/webservices/Endpoint.html#getFullUrl--">getFullUrl</a></span>()</code>
<div class="block">Use this method to get the complete url (endpoint) of the operation that is to be performed for the particular operation</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../sailpoint/connector/webservices/Endpoint.html#getHeader--">getHeader</a></span>()</code>
<div class="block">Use this method to get the header values for the request</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/connector/webservices/Endpoint.html#getHttpMethodType--">getHttpMethodType</a></span>()</code>
<div class="block">Use this method to get the http method type (put, post, get, patch, delete) for the particular operation (create user, update user, account aggregation, etc...)</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../sailpoint/connector/webservices/Endpoint.html#getOperationType--">getOperationType</a></span>()</code>
<div class="block">Use this method to get the operation type (Account Aggregation, Group Aggregation, Create Account, etc...) for the particular operation record (create user, update user, account aggregation, etc...)</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/connector/webservices/Endpoint.html#getResMappingObj--">getResMappingObj</a></span>()</code>
<div class="block">Use this method to get the response mapping for the response attributes returned from the JSON response of the managed source.</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/connector/webservices/Endpoint.html#getResponseCode--">getResponseCode</a></span>()</code>
<div class="block">Use this method to get the value of successful response codes as a list (200,201,299).</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/connector/webservices/Endpoint.html#getRootPath--">getRootPath</a></span>()</code>
<div class="block">Use this method to get the root of the JSON response returned from the managed source for the particular operation (create user, update user, account aggregation, etc...)
<br>
Example root path for the json below: <code>$.results </code></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/connector/webservices/Endpoint.html#getSequenceNumberForEndpoint--">getSequenceNumberForEndpoint</a></span>()</code>
<div class="block">Use this method to get the sequence number for the particular operation (create user, update user, account aggregation, etc...)</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/connector/webservices/Endpoint.html#getUniqueNameForEndPoint--">getUniqueNameForEndPoint</a></span>()</code>
<div class="block">Use this method to get the unique operation name for the particular operation (create user, update user, account aggregation, etc...)</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../sailpoint/connector/webservices/Endpoint.html#setBaseUrl-java.lang.String-">setBaseUrl</a></span>(java.lang.String&nbsp;value)</code>
<div class="block">Use this method to set the base url (endpoint) of the operation that is to be performed for the particular operation</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/connector/webservices/Endpoint.html#setBody-java.util.Map-">setBody</a></span>(java.util.Map&nbsp;value)</code>
<div class="block">Use this method to set the http payload information as a map.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../sailpoint/connector/webservices/Endpoint.html#setContextUrl-java.lang.String-">setContextUrl</a></span>(java.lang.String&nbsp;value)</code>
<div class="block">Use this method to set the context url for the particular operation (create user, update user, account aggregation, etc...)</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../sailpoint/connector/webservices/Endpoint.html#setFullUrl-java.lang.String-">setFullUrl</a></span>(java.lang.String&nbsp;value)</code>
<div class="block">Use this method to set the complete url (endpoint) of the operation that is to be performed for the particular operation</div>
</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../sailpoint/connector/webservices/Endpoint.html#setHeader-java.util.Map-">setHeader</a></span>(java.util.Map&nbsp;value)</code>
<div class="block">Use this method to set the header values for the request</div>
</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../sailpoint/connector/webservices/Endpoint.html#setHttpMethodType-java.lang.String-">setHttpMethodType</a></span>(java.lang.String&nbsp;value)</code>
<div class="block">Use this method to set the http method type (put, post, get, patch, delete) for the particular operation (create user, update user, account aggregation, etc...)</div>
</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../sailpoint/connector/webservices/Endpoint.html#setOperationType-java.lang.String-">setOperationType</a></span>(java.lang.String&nbsp;value)</code>
<div class="block">Use this method to set the operation type (Account Aggregation, Group Aggregation, Create Account, etc...) for the particular operation record (create user, update user, account aggregation, etc...)</div>
</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../sailpoint/connector/webservices/Endpoint.html#setResMappingObj-java.util.Map-">setResMappingObj</a></span>(java.util.Map&nbsp;value)</code>
<div class="block">Use this method to set the response mapping for the response attributes returned from the JSON response of the managed source.</div>
</td>
</tr>
<tr id="i25" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../sailpoint/connector/webservices/Endpoint.html#setResponseCode-java.util.List-">setResponseCode</a></span>(java.util.List&nbsp;value)</code>
<div class="block">Use this method to set the value of successful response codes as a list (200,201,299).</div>
</td>
</tr>
<tr id="i26" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../sailpoint/connector/webservices/Endpoint.html#setRootPath-java.lang.String-">setRootPath</a></span>(java.lang.String&nbsp;value)</code>
<div class="block">Use this method to set the root of the JSON response returned from the managed source for the particular operation (create user, update user, account aggregation, etc...)
<br>
Example root path for the json below: <code>$.results </code></div>
</td>
</tr>
</table>
</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="getAfterRule--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAfterRule</h4>
<pre>void&nbsp;getAfterRule()</pre>
<div class="block">Use this method to get the name of the rule to run after the webservice request completes.</div>
</li>
</ul>
<a name="getBeforeRule--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBeforeRule</h4>
<pre>void&nbsp;getBeforeRule()</pre>
<div class="block">Use this method to get the name of the rule to run before the webservice request completes</div>
</li>
</ul>
<a name="setContextUrl-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setContextUrl</h4>
<pre>void&nbsp;setContextUrl(java.lang.String&nbsp;value)</pre>
<div class="block">Use this method to set the context url for the particular operation (create user, update user, account aggregation, etc...)</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - the name of the context url</dd>
</dl>
</li>
</ul>
<a name="getContextUrl--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getContextUrl</h4>
<pre>void&nbsp;getContextUrl()</pre>
<div class="block">Use this method to get the context url for the particular operation (create user, update user, account aggregation, etc...)</div>
</li>
</ul>
<a name="setHttpMethodType-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setHttpMethodType</h4>
<pre>void&nbsp;setHttpMethodType(java.lang.String&nbsp;value)</pre>
<div class="block">Use this method to set the http method type (put, post, get, patch, delete) for the particular operation (create user, update user, account aggregation, etc...)</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - the name of the http method type [get, post, put, patch, delete]</dd>
</dl>
</li>
</ul>
<a name="getHttpMethodType--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHttpMethodType</h4>
<pre>void&nbsp;getHttpMethodType()</pre>
<div class="block">Use this method to get the http method type (put, post, get, patch, delete) for the particular operation (create user, update user, account aggregation, etc...)</div>
</li>
</ul>
<a name="setOperationType-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setOperationType</h4>
<pre>void&nbsp;setOperationType(java.lang.String&nbsp;value)</pre>
<div class="block">Use this method to set the operation type (Account Aggregation, Group Aggregation, Create Account, etc...) for the particular operation record (create user, update user, account aggregation, etc...)</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - the name of the operation type</dd>
</dl>
</li>
</ul>
<a name="getOperationType--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOperationType</h4>
<pre>void&nbsp;getOperationType()</pre>
<div class="block">Use this method to get the operation type (Account Aggregation, Group Aggregation, Create Account, etc...) for the particular operation record (create user, update user, account aggregation, etc...)</div>
</li>
</ul>
<a name="setRootPath-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setRootPath</h4>
<pre>void&nbsp;setRootPath(java.lang.String&nbsp;value)</pre>
<div class="block">Use this method to set the root of the JSON response returned from the managed source for the particular operation (create user, update user, account aggregation, etc...)
<br>
Example root path for the json below: <code>$.results </code>
<pre>
{
"results": [
{
"id": "12345",
"name": "John Doe"
"email": "john.doe@sailpoint.com"
},
{
"id": "54321",
"name": "Jane Doe",
"email": "jane.doe@sailpoint.com"
}
]
}
</pre></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - the name of the root of the JSON response results</dd>
</dl>
</li>
</ul>
<a name="getRootPath--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRootPath</h4>
<pre>void&nbsp;getRootPath()</pre>
<div class="block">Use this method to get the root of the JSON response returned from the managed source for the particular operation (create user, update user, account aggregation, etc...)
<br>
Example root path for the json below: <code>$.results </code>
<pre>
{
"results": [
{
"id": "12345",
"name": "John Doe"
"email": "john.doe@sailpoint.com"
},
{
"id": "54321",
"name": "Jane Doe",
"email": "jane.doe@sailpoint.com"
}
]
}
</pre></div>
</li>
</ul>
<a name="setFullUrl-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setFullUrl</h4>
<pre>void&nbsp;setFullUrl(java.lang.String&nbsp;value)</pre>
<div class="block">Use this method to set the complete url (endpoint) of the operation that is to be performed for the particular operation
<pre>
Example full url for Airtable Get Users call
ex: https://api.airtable.com/v0/appe0bVnLjyV97hyg/Users
</pre></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - the full url as a string</dd>
</dl>
</li>
</ul>
<a name="getFullUrl--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFullUrl</h4>
<pre>void&nbsp;getFullUrl()</pre>
<div class="block">Use this method to get the complete url (endpoint) of the operation that is to be performed for the particular operation
<pre>
Example full url for Airtable Get Users call
ex: https://api.airtable.com/v0/appe0bVnLjyV97hyg/Users
</pre></div>
</li>
</ul>
<a name="setBaseUrl-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setBaseUrl</h4>
<pre>void&nbsp;setBaseUrl(java.lang.String&nbsp;value)</pre>
<div class="block">Use this method to set the base url (endpoint) of the operation that is to be performed for the particular operation
<pre>
Example base url for Airtable Get Users call
ex: https://api.airtable.com/v0/appe0bVnLjyV97hyg
</pre></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - the base url as a string</dd>
</dl>
</li>
</ul>
<a name="getBaseUrl--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBaseUrl</h4>
<pre>void&nbsp;getBaseUrl()</pre>
<div class="block">Use this method to get the base url (endpoint) of the operation that is to be performed for the particular operation
<pre>
Example base url for Airtable Get Users call
ex: https://api.airtable.com/v0/appe0bVnLjyV97hyg
</pre></div>
</li>
</ul>
<a name="getSequenceNumberForEndpoint--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSequenceNumberForEndpoint</h4>
<pre>void&nbsp;getSequenceNumberForEndpoint()</pre>
<div class="block">Use this method to get the sequence number for the particular operation (create user, update user, account aggregation, etc...)</div>
</li>
</ul>
<a name="getUniqueNameForEndPoint--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUniqueNameForEndPoint</h4>
<pre>void&nbsp;getUniqueNameForEndPoint()</pre>
<div class="block">Use this method to get the unique operation name for the particular operation (create user, update user, account aggregation, etc...)</div>
</li>
</ul>
<a name="setResMappingObj-java.util.Map-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setResMappingObj</h4>
<pre>void&nbsp;setResMappingObj(java.util.Map&nbsp;value)</pre>
<div class="block">Use this method to set the response mapping for the response attributes returned from the JSON response of the managed source.
<br>
The key would be the attribute name from the source account schema and the value would be the JSON path after the root path.
<pre>
{
"results": [
{
"fields": {
"id": "12345",
"name": "John Doe"
"email": "john.doe@sailpoint.com"
}
},
{
"fields": {
"id": "54321",
"name": "Jane Doe",
"email": "jane.doe@sailpoint.com"
}
}
]
}
</pre>
Root path: $.results
<br>
Response Map
<pre>
{
"id": "fields.id",
"name": "fields.name",
"email": "fields.email"
}
</pre></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - the mapping of account schema attribute to the JSON path value in the JSON response</dd>
</dl>
</li>
</ul>
<a name="getResMappingObj--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getResMappingObj</h4>
<pre>void&nbsp;getResMappingObj()</pre>
<div class="block">Use this method to get the response mapping for the response attributes returned from the JSON response of the managed source.
<br>
The key would be the attribute name from the source account schema and the value would be the JSON path after the root path.
<pre>
{
"results": [
{
"fields": {
"id": "12345",
"name": "John Doe"
"email": "john.doe@sailpoint.com"
}
},
{
"fields": {
"id": "54321",
"name": "Jane Doe",
"email": "jane.doe@sailpoint.com"
}
}
]
}
</pre>
Root path: $.results
<br>
Response Map
<pre>
{
"id": "fields.id",
"name": "fields.name",
"email": "fields.email"
}
</pre></div>
</li>
</ul>
<a name="setHeader-java.util.Map-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setHeader</h4>
<pre>void&nbsp;setHeader(java.util.Map&nbsp;value)</pre>
<div class="block">Use this method to set the header values for the request
<pre>
//Set Header Content-Type
Map headerMap = requestEndPoint.getHeader();
headerMap.put("Content-Type", "application/json");
requestEndPoint.setHeader(headerMap);
</pre></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - the map of http headers to send with the request</dd>
</dl>
</li>
</ul>
<a name="getHeader--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHeader</h4>
<pre>void&nbsp;getHeader()</pre>
<div class="block">Use this method to get the header values for the request
<pre>
//Set Header Content-Type
Map headerMap = requestEndPoint.getHeader();
headerMap.put("Content-Type", "application/json");
requestEndPoint.setHeader(headerMap);
</pre></div>
</li>
</ul>
<a name="addHeader-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addHeader</h4>
<pre>void&nbsp;addHeader(java.lang.String&nbsp;entry,
java.lang.String&nbsp;value)</pre>
<div class="block">Use this method to add a header value to the existing http header map for the request
<pre>
requestEndPoint.addHeader("Authorization", "Bearer " + accessToken);
</pre></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>entry</code> - the key for the header</dd>
<dd><code>value</code> - the value for the header</dd>
</dl>
</li>
</ul>
<a name="setBody-java.util.Map-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setBody</h4>
<pre>void&nbsp;setBody(java.util.Map&nbsp;value)</pre>
<div class="block">Use this method to set the http payload information as a map.
<br>
The map must contain three keys <code>bodyFormat, bodyFormData, jsonBody</code>. The bodyFormat value can be <code>raw</code>
<br>
which means the user has provided values as a raw JSON string, otherwise the user has provided the value in the key,value format that must be converted into JSON</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - the http payload map</dd>
</dl>
</li>
</ul>
<a name="getBody--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBody</h4>
<pre>void&nbsp;getBody()</pre>
<div class="block">Use this method to get the http payload information as a map.
<br>
The map contains three keys <code>bodyFormat, bodyFormData, jsonBody</code>.</div>
</li>
</ul>
<a name="setResponseCode-java.util.List-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setResponseCode</h4>
<pre>void&nbsp;setResponseCode(java.util.List&nbsp;value)</pre>
<div class="block">Use this method to set the value of successful response codes as a list (200,201,299). This will be respected by the connector.
<br>
If any other response codes are returned this would be considered as a request failure.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - the list of successful response code values</dd>
</dl>
</li>
</ul>
<a name="getResponseCode--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getResponseCode</h4>
<pre>void&nbsp;getResponseCode()</pre>
<div class="block">Use this method to get the value of successful response codes as a list (200,201,299).</div>
</li>
</ul>
<a name="getAttributes--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAttributes</h4>
<pre>sailpoint.object.Attributes&nbsp;getAttributes()</pre>
<div class="block">Use this method to get all the available attributes</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
</dl>
</li>
</ul>
<a name="getAttribute-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getAttribute</h4>
<pre>java.lang.Object&nbsp;getAttribute(java.lang.String&nbsp;name)</pre>
<div class="block">Use this method to get the value of an attribute</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - the name of the attribute</dd>
<dt><span class="returnLabel">Returns:</span></dt>
</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>Prev&nbsp;Class</li>
<li><a href="../../../sailpoint/connector/webservices/WebServicesClient.html" title="interface in sailpoint.connector.webservices"><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>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,589 @@
<!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 Tue Nov 08 10:19:03 EST 2022 -->
<title>WebServicesClient</title>
<meta name="date" content="2022-11-08">
<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="WebServicesClient";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/connector/webservices/Endpoint.html" title="interface in sailpoint.connector.webservices"><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.connector.webservices</div>
<h2 title="Interface WebServicesClient" class="title">Interface WebServicesClient</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public interface <span class="typeNameLabel">WebServicesClient</span></pre>
<div class="block">Definition of a Web Services Client interface available to Rule implementors.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== 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></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>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../sailpoint/connector/webservices/WebServicesClient.html#configure-java.util.Map-">configure</a></span>(java.util.Map&nbsp;args)</code>
<div class="block">Configure connection parameters.</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/connector/webservices/WebServicesClient.html#executeDelete-java.lang.String-java.util.List-">executeDelete</a></span>(java.lang.String&nbsp;url,
java.util.List&lt;java.lang.String&gt;&nbsp;allowedStatuses)</code>
<div class="block">Use this method to execute a DELETE call specifying the url and allowed statuses.</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/connector/webservices/WebServicesClient.html#executeDelete-java.lang.String-java.util.Map-java.util.List-">executeDelete</a></span>(java.lang.String&nbsp;url,
java.util.Map&nbsp;headers,
java.util.List&lt;java.lang.String&gt;&nbsp;allowedStatuses)</code>
<div class="block">Use this method to execute a DELETE call specifying the url, header values and allowed statuses.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../sailpoint/connector/webservices/WebServicesClient.html#executeGet-java.util.Map-java.util.List-">executeGet</a></span>(java.util.Map&nbsp;headers,
java.util.List&lt;java.lang.String&gt;&nbsp;allowedStatuses)</code>
<div class="block">Use this method to execute a GET call with specifying header values and allowed statuses.</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/connector/webservices/WebServicesClient.html#executeGet-java.lang.String-java.util.Map-java.util.List-">executeGet</a></span>(java.lang.String&nbsp;url,
java.util.Map&nbsp;headers,
java.util.List&lt;java.lang.String&gt;&nbsp;allowedStatuses)</code>
<div class="block">Use this method to execute a GET call with specifying the url, header values and allowed statuses.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../sailpoint/connector/webservices/WebServicesClient.html#executePatch-java.lang.String-java.lang.Object-java.util.List-">executePatch</a></span>(java.lang.String&nbsp;url,
java.lang.Object&nbsp;payload,
java.util.List&lt;java.lang.String&gt;&nbsp;allowedStatuses)</code>
<div class="block">Use this method to execute a PATCH call with specifying the url, payload and allowed statuses.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../sailpoint/connector/webservices/WebServicesClient.html#executePatch-java.lang.String-java.lang.Object-java.util.Map-java.util.List-">executePatch</a></span>(java.lang.String&nbsp;url,
java.lang.Object&nbsp;payload,
java.util.Map&nbsp;headers,
java.util.List&lt;java.lang.String&gt;&nbsp;allowedStatuses)</code>
<div class="block">Use this method to execute a PATCH call with specifying the url, payload, header values and allowed statuses.</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/connector/webservices/WebServicesClient.html#executePost-java.lang.String-java.lang.Object-java.util.List-">executePost</a></span>(java.lang.String&nbsp;url,
java.lang.Object&nbsp;payload,
java.util.List&lt;java.lang.String&gt;&nbsp;allowedStatuses)</code>
<div class="block">Use this method to execute a POST call with specifying the url, payload, and allowed statuses.</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/connector/webservices/WebServicesClient.html#executePost-java.lang.String-java.lang.Object-java.util.Map-java.util.List-">executePost</a></span>(java.lang.String&nbsp;url,
java.lang.Object&nbsp;payload,
java.util.Map&nbsp;headers,
java.util.List&lt;java.lang.String&gt;&nbsp;allowedStatuses)</code>
<div class="block">Use this method to execute a POST call with specifying the url, payload, header values and allowed statuses.</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/connector/webservices/WebServicesClient.html#executePut-java.lang.String-java.lang.Object-java.util.List-">executePut</a></span>(java.lang.String&nbsp;url,
java.lang.Object&nbsp;payload,
java.util.List&lt;java.lang.String&gt;&nbsp;allowedStatuses)</code>
<div class="block">Use this method to execute a PUT call with specifying the url, payload, and allowed statuses.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../sailpoint/connector/webservices/WebServicesClient.html#executePut-java.lang.String-java.lang.Object-java.util.Map-java.util.List-">executePut</a></span>(java.lang.String&nbsp;url,
java.lang.Object&nbsp;payload,
java.util.Map&nbsp;headers,
java.util.List&lt;java.lang.String&gt;&nbsp;allowedStatuses)</code>
<div class="block">Use this method to execute a PUT call with specifying the url, payload, header values and allowed statuses.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>java.util.List</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../sailpoint/connector/webservices/WebServicesClient.html#getCookies--">getCookies</a></span>()</code>
<div class="block">Use this method to get a list of cookies associated with the request</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>java.util.Map&lt;java.lang.String,java.lang.String&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../sailpoint/connector/webservices/WebServicesClient.html#getResponseHeaders--">getResponseHeaders</a></span>()</code>
<div class="block">Get the last executed request's response headers.</div>
</td>
</tr>
</table>
</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="configure-java.util.Map-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>configure</h4>
<pre>void&nbsp;configure(java.util.Map&nbsp;args)
throws java.lang.Exception</pre>
<div class="block">Configure connection parameters. See the ARG_* constants.
<pre>
public static final String ARG_URL = "url";
public static final String ARG_USERNAME = "username";
public static final String ARG_PASSWORD = "password";
public static final String ARG_TIMEOUT = "timeoutInSeconds";
</pre></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>args</code> - map of the available configuration parameters, ARG_URL, ARG_USERNAME, ARG_PASSWORD, ARG_TIMEOUT</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code> - The exception thrown by the client</dd>
</dl>
</li>
</ul>
<a name="getCookies--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCookies</h4>
<pre>java.util.List&nbsp;getCookies()</pre>
<div class="block">Use this method to get a list of cookies associated with the request</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>List of cookies associated with the request</dd>
</dl>
</li>
</ul>
<a name="executeGet-java.util.Map-java.util.List-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>executeGet</h4>
<pre>java.lang.String&nbsp;executeGet(java.util.Map&nbsp;headers,
java.util.List&lt;java.lang.String&gt;&nbsp;allowedStatuses)
throws java.lang.Exception</pre>
<div class="block">Use this method to execute a GET call with specifying header values and allowed statuses.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>headers</code> - Any headers needed to authenticate or specify a content-type</dd>
<dd><code>allowedStatuses</code> - Allowed response statuses, ie: 200, 201, 400, etc...</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Get request response object</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code> - The exception thrown by the client</dd>
</dl>
</li>
</ul>
<a name="executeGet-java.lang.String-java.util.Map-java.util.List-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>executeGet</h4>
<pre>java.lang.String&nbsp;executeGet(java.lang.String&nbsp;url,
java.util.Map&nbsp;headers,
java.util.List&lt;java.lang.String&gt;&nbsp;allowedStatuses)
throws java.lang.Exception</pre>
<div class="block">Use this method to execute a GET call with specifying the url, header values and allowed statuses.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>url</code> - The url to execute the request against</dd>
<dd><code>headers</code> - Any headers needed to authenticate or specify a content-type</dd>
<dd><code>allowedStatuses</code> - Allowed response statuses, ie: 200, 201, 400, etc...</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Get request response object</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code> - The exception thrown by the client</dd>
</dl>
</li>
</ul>
<a name="executePost-java.lang.String-java.lang.Object-java.util.List-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>executePost</h4>
<pre>java.lang.String&nbsp;executePost(java.lang.String&nbsp;url,
java.lang.Object&nbsp;payload,
java.util.List&lt;java.lang.String&gt;&nbsp;allowedStatuses)
throws java.lang.Exception</pre>
<div class="block">Use this method to execute a POST call with specifying the url, payload, and allowed statuses.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>url</code> - The url to execute the request against</dd>
<dd><code>payload</code> - The payload to send to the request endpoint</dd>
<dd><code>allowedStatuses</code> - Allowed response statuses, ie: 200, 201, 400, etc...</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Post request response object</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code> - The exception thrown by the client</dd>
</dl>
</li>
</ul>
<a name="executePost-java.lang.String-java.lang.Object-java.util.Map-java.util.List-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>executePost</h4>
<pre>java.lang.String&nbsp;executePost(java.lang.String&nbsp;url,
java.lang.Object&nbsp;payload,
java.util.Map&nbsp;headers,
java.util.List&lt;java.lang.String&gt;&nbsp;allowedStatuses)
throws java.lang.Exception</pre>
<div class="block">Use this method to execute a POST call with specifying the url, payload, header values and allowed statuses.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>url</code> - The url to execute the request against</dd>
<dd><code>payload</code> - The payload to send to the request endpoint</dd>
<dd><code>headers</code> - Any headers needed to authenticate or specify a content-type</dd>
<dd><code>allowedStatuses</code> - Allowed response statuses, ie: 200, 201, 400, etc...</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Post request response object</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code> - The exception thrown by the client</dd>
</dl>
</li>
</ul>
<a name="executePut-java.lang.String-java.lang.Object-java.util.List-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>executePut</h4>
<pre>java.lang.String&nbsp;executePut(java.lang.String&nbsp;url,
java.lang.Object&nbsp;payload,
java.util.List&lt;java.lang.String&gt;&nbsp;allowedStatuses)
throws java.lang.Exception</pre>
<div class="block">Use this method to execute a PUT call with specifying the url, payload, and allowed statuses.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>url</code> - The url to execute the request against</dd>
<dd><code>payload</code> - The payload to send to the request endpoint</dd>
<dd><code>allowedStatuses</code> - Allowed response statuses, ie: 200, 201, 400, etc...</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Put request response object</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code> - The exception thrown by the client</dd>
</dl>
</li>
</ul>
<a name="executePut-java.lang.String-java.lang.Object-java.util.Map-java.util.List-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>executePut</h4>
<pre>java.lang.String&nbsp;executePut(java.lang.String&nbsp;url,
java.lang.Object&nbsp;payload,
java.util.Map&nbsp;headers,
java.util.List&lt;java.lang.String&gt;&nbsp;allowedStatuses)
throws java.lang.Exception</pre>
<div class="block">Use this method to execute a PUT call with specifying the url, payload, header values and allowed statuses.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>url</code> - The url to execute the request against</dd>
<dd><code>payload</code> - The payload to send to the request endpoint</dd>
<dd><code>headers</code> - Any headers needed to authenticate or specify a content-type</dd>
<dd><code>allowedStatuses</code> - Allowed response statuses, ie: 200, 201, 400, etc...</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Put request response object</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code> - The exception thrown by the client</dd>
</dl>
</li>
</ul>
<a name="executePatch-java.lang.String-java.lang.Object-java.util.List-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>executePatch</h4>
<pre>java.lang.String&nbsp;executePatch(java.lang.String&nbsp;url,
java.lang.Object&nbsp;payload,
java.util.List&lt;java.lang.String&gt;&nbsp;allowedStatuses)
throws java.lang.Exception</pre>
<div class="block">Use this method to execute a PATCH call with specifying the url, payload and allowed statuses.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>url</code> - The url to execute the request against</dd>
<dd><code>payload</code> - The payload to send to the request endpoint</dd>
<dd><code>allowedStatuses</code> - Allowed response statuses, ie: 200, 201, 400, etc...</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Patch request response object</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code> - The exception thrown by the client</dd>
</dl>
</li>
</ul>
<a name="executePatch-java.lang.String-java.lang.Object-java.util.Map-java.util.List-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>executePatch</h4>
<pre>java.lang.String&nbsp;executePatch(java.lang.String&nbsp;url,
java.lang.Object&nbsp;payload,
java.util.Map&nbsp;headers,
java.util.List&lt;java.lang.String&gt;&nbsp;allowedStatuses)
throws java.lang.Exception</pre>
<div class="block">Use this method to execute a PATCH call with specifying the url, payload, header values and allowed statuses.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>url</code> - The url to execute the request against</dd>
<dd><code>payload</code> - The payload to send to the request endpoint</dd>
<dd><code>headers</code> - Any headers needed to authenticate or specify a content-type</dd>
<dd><code>allowedStatuses</code> - Allowed response statuses, ie: 200, 201, 400, etc...</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Patch request response object</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code> - The exception thrown by the client</dd>
</dl>
</li>
</ul>
<a name="getResponseHeaders--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getResponseHeaders</h4>
<pre>java.util.Map&lt;java.lang.String,java.lang.String&gt;&nbsp;getResponseHeaders()</pre>
<div class="block">Get the last executed request's response headers.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Map of response headers</dd>
</dl>
</li>
</ul>
<a name="executeDelete-java.lang.String-java.util.List-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>executeDelete</h4>
<pre>java.lang.String&nbsp;executeDelete(java.lang.String&nbsp;url,
java.util.List&lt;java.lang.String&gt;&nbsp;allowedStatuses)
throws java.lang.Exception</pre>
<div class="block">Use this method to execute a DELETE call specifying the url and allowed statuses.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>url</code> - The url to execute the request against</dd>
<dd><code>allowedStatuses</code> - Allowed response statuses, ie: 200, 201, 400, etc...</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Delete request response object</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code> - The exception thrown by the client</dd>
</dl>
</li>
</ul>
<a name="executeDelete-java.lang.String-java.util.Map-java.util.List-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>executeDelete</h4>
<pre>java.lang.String&nbsp;executeDelete(java.lang.String&nbsp;url,
java.util.Map&nbsp;headers,
java.util.List&lt;java.lang.String&gt;&nbsp;allowedStatuses)
throws java.lang.Exception</pre>
<div class="block">Use this method to execute a DELETE call specifying the url, header values and allowed statuses.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>url</code> - The url to execute the request against</dd>
<dd><code>headers</code> - Any headers needed to authenticate or specify a content-type</dd>
<dd><code>allowedStatuses</code> - Allowed response statuses, ie: 200, 201, 400, etc...</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Delete request response object</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code> - The exception thrown by the client</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/connector/webservices/Endpoint.html" title="interface in sailpoint.connector.webservices"><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,21 @@
<!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 Tue Nov 08 10:19:04 EST 2022 -->
<title>sailpoint.connector.webservices</title>
<meta name="date" content="2022-11-08">
<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/connector/webservices/package-summary.html" target="classFrame">sailpoint.connector.webservices</a></h1>
<div class="indexContainer">
<h2 title="Interfaces">Interfaces</h2>
<ul title="Interfaces">
<li><a href="Endpoint.html" title="interface in sailpoint.connector.webservices" target="classFrame"><span class="interfaceName">Endpoint</span></a></li>
<li><a href="WebServicesClient.html" title="interface in sailpoint.connector.webservices" target="classFrame"><span class="interfaceName">WebServicesClient</span></a></li>
</ul>
</div>
</body>
</html>

View File

@@ -0,0 +1,146 @@
<!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 Tue Nov 08 10:19:04 EST 2022 -->
<title>sailpoint.connector.webservices</title>
<meta name="date" content="2022-11-08">
<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.connector.webservices";
}
}
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/object/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.connector.webservices</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/connector/webservices/Endpoint.html" title="interface in sailpoint.connector.webservices">Endpoint</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../sailpoint/connector/webservices/WebServicesClient.html" title="interface in sailpoint.connector.webservices">WebServicesClient</a></td>
<td class="colLast">
<div class="block">Definition of a Web Services Client interface available to Rule implementors.</div>
</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/object/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,132 @@
<!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 Tue Nov 08 10:19:04 EST 2022 -->
<title>sailpoint.connector.webservices Class Hierarchy</title>
<meta name="date" content="2022-11-08">
<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.connector.webservices 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/object/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.connector.webservices</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="Interface Hierarchy">Interface Hierarchy</h2>
<ul>
<li type="circle">sailpoint.connector.webservices.<a href="../../../sailpoint/connector/webservices/Endpoint.html" title="interface in sailpoint.connector.webservices"><span class="typeNameLink">Endpoint</span></a></li>
<li type="circle">sailpoint.connector.webservices.<a href="../../../sailpoint/connector/webservices/WebServicesClient.html" title="interface in sailpoint.connector.webservices"><span class="typeNameLink">WebServicesClient</span></a></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/object/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>