mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-06 04:19:31 +00:00
590 lines
26 KiB
HTML
590 lines
26 KiB
HTML
<!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 Thu May 04 14:44:34 EDT 2023 -->
|
|
<title>WebServicesClient</title>
|
|
<meta name="date" content="2023-05-04">
|
|
<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 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.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"> </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></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 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 url,
|
|
java.util.List<java.lang.String> 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 url,
|
|
java.util.Map headers,
|
|
java.util.List<java.lang.String> 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 headers,
|
|
java.util.List<java.lang.String> 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 url,
|
|
java.util.Map headers,
|
|
java.util.List<java.lang.String> 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 url,
|
|
java.lang.Object payload,
|
|
java.util.List<java.lang.String> 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 url,
|
|
java.lang.Object payload,
|
|
java.util.Map headers,
|
|
java.util.List<java.lang.String> 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 url,
|
|
java.lang.Object payload,
|
|
java.util.List<java.lang.String> 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 url,
|
|
java.lang.Object payload,
|
|
java.util.Map headers,
|
|
java.util.List<java.lang.String> 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 url,
|
|
java.lang.Object payload,
|
|
java.util.List<java.lang.String> 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 url,
|
|
java.lang.Object payload,
|
|
java.util.Map headers,
|
|
java.util.List<java.lang.String> 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<java.lang.String,java.lang.String></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 configure(java.util.Map 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 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 executeGet(java.util.Map headers,
|
|
java.util.List<java.lang.String> 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 executeGet(java.lang.String url,
|
|
java.util.Map headers,
|
|
java.util.List<java.lang.String> 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 executePost(java.lang.String url,
|
|
java.lang.Object payload,
|
|
java.util.List<java.lang.String> 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 executePost(java.lang.String url,
|
|
java.lang.Object payload,
|
|
java.util.Map headers,
|
|
java.util.List<java.lang.String> 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 executePut(java.lang.String url,
|
|
java.lang.Object payload,
|
|
java.util.List<java.lang.String> 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 executePut(java.lang.String url,
|
|
java.lang.Object payload,
|
|
java.util.Map headers,
|
|
java.util.List<java.lang.String> 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 executePatch(java.lang.String url,
|
|
java.lang.Object payload,
|
|
java.util.List<java.lang.String> 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 executePatch(java.lang.String url,
|
|
java.lang.Object payload,
|
|
java.util.Map headers,
|
|
java.util.List<java.lang.String> 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<java.lang.String,java.lang.String> 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 executeDelete(java.lang.String url,
|
|
java.util.List<java.lang.String> 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 executeDelete(java.lang.String url,
|
|
java.util.Map headers,
|
|
java.util.List<java.lang.String> 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 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>
|