http://git-wip-us.apache.org/repos/asf/incubator-trafodion-site/blob/645fc344/docs/2.1.0/dcs_reference/apidocs/org/trafodion/dcs/rest/client/Client.html ---------------------------------------------------------------------- diff --git a/docs/2.1.0/dcs_reference/apidocs/org/trafodion/dcs/rest/client/Client.html b/docs/2.1.0/dcs_reference/apidocs/org/trafodion/dcs/rest/client/Client.html new file mode 100644 index 0000000..9389664 --- /dev/null +++ b/docs/2.1.0/dcs_reference/apidocs/org/trafodion/dcs/rest/client/Client.html @@ -0,0 +1,956 @@ +<!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 (version 1.7.0_91) on Thu Mar 03 20:15:36 UTC 2016 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Client (Trafodion Database Connectivity Services 2.0.0 API)</title> +<meta name="date" content="2016-03-03"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="Client (Trafodion Database Connectivity Services 2.0.0 API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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="class-use/Client.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev Class</li> +<li><a href="../../../../../org/trafodion/dcs/rest/client/Cluster.html" title="class in org.trafodion.dcs.rest.client"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/trafodion/dcs/rest/client/Client.html" target="_top">Frames</a></li> +<li><a href="Client.html" target="_top">No Frames</a></li> +</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><a href="#field_summary">Field</a> | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field_detail">Field</a> | </li> +<li><a href="#constructor_detail">Constr</a> | </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">org.trafodion.dcs.rest.client</div> +<h2 title="Class Client" class="title">Class Client</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li>org.trafodion.dcs.rest.client.Client</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">Client</span> +extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></pre> +<div class="block">A wrapper around HttpClient which provides some useful function and + semantics for interacting with the REST gateway.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<caption><span>Fields</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Field and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static org.apache.commons.httpclient.Header[]</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/trafodion/dcs/rest/client/Client.html#EMPTY_HEADER_ARRAY">EMPTY_HEADER_ARRAY</a></strong></code> </td> +</tr> +</table> +</li> +</ul> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../../org/trafodion/dcs/rest/client/Client.html#Client()">Client</a></strong>()</code> +<div class="block">Default Constructor</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../../org/trafodion/dcs/rest/client/Client.html#Client(org.trafodion.dcs.rest.client.Cluster)">Client</a></strong>(<a href="../../../../../org/trafodion/dcs/rest/client/Cluster.html" title="class in org.trafodion.dcs.rest.client">Cluster</a> cluster)</code> +<div class="block">Constructor</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/trafodion/dcs/rest/client/Client.html#addExtraHeader(java.lang.String,%20java.lang.String)">addExtraHeader</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> value)</code> +<div class="block">Add extra headers.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/trafodion/dcs/rest/client/Response.html" title="class in org.trafodion.dcs.rest.client">Response</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/trafodion/dcs/rest/client/Client.html#delete(org.trafodion.dcs.rest.client.Cluster,%20java.lang.String)">delete</a></strong>(<a href="../../../../../org/trafodion/dcs/rest/client/Cluster.html" title="class in org.trafodion.dcs.rest.client">Cluster</a> cluster, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> path)</code> +<div class="block">Send a DELETE request</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/trafodion/dcs/rest/client/Response.html" title="class in org.trafodion.dcs.rest.client">Response</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/trafodion/dcs/rest/client/Client.html#delete(java.lang.String)">delete</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> path)</code> +<div class="block">Send a DELETE request</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/trafodion/dcs/rest/client/Client.html#execute(org.trafodion.dcs.rest.client.Cluster,%20org.apache.commons.httpclient.HttpMethod,%20org.apache.commons.httpclient.Header[],%20java.lang.String)">execute</a></strong>(<a href="../../../../../org/trafodion/dcs/rest/client/Cluster.html" title="class in org.trafodion.dcs.rest.client">Cluster</a> cluster, + org.apache.commons.httpclient.HttpMethod method, + org.apache.commons.httpclient.Header[] headers, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> path)</code> +<div class="block">Execute a transaction method.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/trafodion/dcs/rest/client/Client.html#executePathOnly(org.trafodion.dcs.rest.client.Cluster,%20org.apache.commons.httpclient.HttpMethod,%20org.apache.commons.httpclient.Header[],%20java.lang.String)">executePathOnly</a></strong>(<a href="../../../../../org/trafodion/dcs/rest/client/Cluster.html" title="class in org.trafodion.dcs.rest.client">Cluster</a> cluster, + org.apache.commons.httpclient.HttpMethod method, + org.apache.commons.httpclient.Header[] headers, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> path)</code> +<div class="block">Execute a transaction method given only the path.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/trafodion/dcs/rest/client/Client.html#executeURI(org.apache.commons.httpclient.HttpMethod,%20org.apache.commons.httpclient.Header[],%20java.lang.String)">executeURI</a></strong>(org.apache.commons.httpclient.HttpMethod method, + org.apache.commons.httpclient.Header[] headers, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> uri)</code> +<div class="block">Execute a transaction method given a complete URI.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/trafodion/dcs/rest/client/Response.html" title="class in org.trafodion.dcs.rest.client">Response</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/trafodion/dcs/rest/client/Client.html#get(org.trafodion.dcs.rest.client.Cluster,%20java.lang.String)">get</a></strong>(<a href="../../../../../org/trafodion/dcs/rest/client/Cluster.html" title="class in org.trafodion.dcs.rest.client">Cluster</a> cluster, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> path)</code> +<div class="block">Send a GET request</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/trafodion/dcs/rest/client/Response.html" title="class in org.trafodion.dcs.rest.client">Response</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/trafodion/dcs/rest/client/Client.html#get(org.trafodion.dcs.rest.client.Cluster,%20java.lang.String,%20org.apache.commons.httpclient.Header[])">get</a></strong>(<a href="../../../../../org/trafodion/dcs/rest/client/Cluster.html" title="class in org.trafodion.dcs.rest.client">Cluster</a> c, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> path, + org.apache.commons.httpclient.Header[] headers)</code> +<div class="block">Send a GET request</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/trafodion/dcs/rest/client/Response.html" title="class in org.trafodion.dcs.rest.client">Response</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/trafodion/dcs/rest/client/Client.html#get(org.trafodion.dcs.rest.client.Cluster,%20java.lang.String,%20java.lang.String)">get</a></strong>(<a href="../../../../../org/trafodion/dcs/rest/client/Cluster.html" title="class in org.trafodion.dcs.rest.client">Cluster</a> cluster, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> path, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> accept)</code> +<div class="block">Send a GET request</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/trafodion/dcs/rest/client/Response.html" title="class in org.trafodion.dcs.rest.client">Response</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/trafodion/dcs/rest/client/Client.html#get(java.lang.String)">get</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> path)</code> +<div class="block">Send a GET request</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/trafodion/dcs/rest/client/Response.html" title="class in org.trafodion.dcs.rest.client">Response</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/trafodion/dcs/rest/client/Client.html#get(java.lang.String,%20org.apache.commons.httpclient.Header[])">get</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> path, + org.apache.commons.httpclient.Header[] headers)</code> +<div class="block">Send a GET request</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/trafodion/dcs/rest/client/Response.html" title="class in org.trafodion.dcs.rest.client">Response</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/trafodion/dcs/rest/client/Client.html#get(java.lang.String,%20java.lang.String)">get</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> path, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> accept)</code> +<div class="block">Send a GET request</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/trafodion/dcs/rest/client/Cluster.html" title="class in org.trafodion.dcs.rest.client">Cluster</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/trafodion/dcs/rest/client/Client.html#getCluster()">getCluster</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/trafodion/dcs/rest/client/Client.html#getExtraHeader(java.lang.String)">getExtraHeader</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name)</code> +<div class="block">Get an extra header value.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/trafodion/dcs/rest/client/Client.html#getExtraHeaders()">getExtraHeaders</a></strong>()</code> +<div class="block">Get all extra headers (read-only).</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>org.apache.commons.httpclient.HttpClient</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/trafodion/dcs/rest/client/Client.html#getHttpClient()">getHttpClient</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/trafodion/dcs/rest/client/Response.html" title="class in org.trafodion.dcs.rest.client">Response</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/trafodion/dcs/rest/client/Client.html#head(org.trafodion.dcs.rest.client.Cluster,%20java.lang.String,%20org.apache.commons.httpclient.Header[])">head</a></strong>(<a href="../../../../../org/trafodion/dcs/rest/client/Cluster.html" title="class in org.trafodion.dcs.rest.client">Cluster</a> cluster, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> path, + org.apache.commons.httpclient.Header[] headers)</code> +<div class="block">Send a HEAD request</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/trafodion/dcs/rest/client/Response.html" title="class in org.trafodion.dcs.rest.client">Response</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/trafodion/dcs/rest/client/Client.html#head(java.lang.String)">head</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> path)</code> +<div class="block">Send a HEAD request</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/trafodion/dcs/rest/client/Response.html" title="class in org.trafodion.dcs.rest.client">Response</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/trafodion/dcs/rest/client/Client.html#post(org.trafodion.dcs.rest.client.Cluster,%20java.lang.String,%20org.apache.commons.httpclient.Header[],%20byte[])">post</a></strong>(<a href="../../../../../org/trafodion/dcs/rest/client/Cluster.html" title="class in org.trafodion.dcs.rest.client">Cluster</a> cluster, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> path, + org.apache.commons.httpclient.Header[] headers, + byte[] content)</code> +<div class="block">Send a POST request</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/trafodion/dcs/rest/client/Response.html" title="class in org.trafodion.dcs.rest.client">Response</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/trafodion/dcs/rest/client/Client.html#post(org.trafodion.dcs.rest.client.Cluster,%20java.lang.String,%20java.lang.String,%20byte[])">post</a></strong>(<a href="../../../../../org/trafodion/dcs/rest/client/Cluster.html" title="class in org.trafodion.dcs.rest.client">Cluster</a> cluster, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> path, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> contentType, + byte[] content)</code> +<div class="block">Send a POST request</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/trafodion/dcs/rest/client/Response.html" title="class in org.trafodion.dcs.rest.client">Response</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/trafodion/dcs/rest/client/Client.html#post(java.lang.String,%20org.apache.commons.httpclient.Header[],%20byte[])">post</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> path, + org.apache.commons.httpclient.Header[] headers, + byte[] content)</code> +<div class="block">Send a POST request</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/trafodion/dcs/rest/client/Response.html" title="class in org.trafodion.dcs.rest.client">Response</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/trafodion/dcs/rest/client/Client.html#post(java.lang.String,%20java.lang.String,%20byte[])">post</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> path, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> contentType, + byte[] content)</code> +<div class="block">Send a POST request</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/trafodion/dcs/rest/client/Response.html" title="class in org.trafodion.dcs.rest.client">Response</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/trafodion/dcs/rest/client/Client.html#put(org.trafodion.dcs.rest.client.Cluster,%20java.lang.String,%20org.apache.commons.httpclient.Header[],%20byte[])">put</a></strong>(<a href="../../../../../org/trafodion/dcs/rest/client/Cluster.html" title="class in org.trafodion.dcs.rest.client">Cluster</a> cluster, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> path, + org.apache.commons.httpclient.Header[] headers, + byte[] content)</code> +<div class="block">Send a PUT request</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/trafodion/dcs/rest/client/Response.html" title="class in org.trafodion.dcs.rest.client">Response</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/trafodion/dcs/rest/client/Client.html#put(org.trafodion.dcs.rest.client.Cluster,%20java.lang.String,%20java.lang.String,%20byte[])">put</a></strong>(<a href="../../../../../org/trafodion/dcs/rest/client/Cluster.html" title="class in org.trafodion.dcs.rest.client">Cluster</a> cluster, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> path, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> contentType, + byte[] content)</code> +<div class="block">Send a PUT request</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/trafodion/dcs/rest/client/Response.html" title="class in org.trafodion.dcs.rest.client">Response</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/trafodion/dcs/rest/client/Client.html#put(java.lang.String,%20org.apache.commons.httpclient.Header[],%20byte[])">put</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> path, + org.apache.commons.httpclient.Header[] headers, + byte[] content)</code> +<div class="block">Send a PUT request</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/trafodion/dcs/rest/client/Response.html" title="class in org.trafodion.dcs.rest.client">Response</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/trafodion/dcs/rest/client/Client.html#put(java.lang.String,%20java.lang.String,%20byte[])">put</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> path, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> contentType, + byte[] content)</code> +<div class="block">Send a PUT request</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/trafodion/dcs/rest/client/Client.html#removeExtraHeader(java.lang.String)">removeExtraHeader</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name)</code> +<div class="block">Remove an extra header.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/trafodion/dcs/rest/client/Client.html#setCluster(org.trafodion.dcs.rest.client.Cluster)">setCluster</a></strong>(<a href="../../../../../org/trafodion/dcs/rest/client/Cluster.html" title="class in org.trafodion.dcs.rest.client">Cluster</a> cluster)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/trafodion/dcs/rest/client/Client.html#shutdown()">shutdown</a></strong>()</code> +<div class="block">Shut down the client.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang /Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="EMPTY_HEADER_ARRAY"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>EMPTY_HEADER_ARRAY</h4> +<pre>public static final org.apache.commons.httpclient.Header[] EMPTY_HEADER_ARRAY</pre> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="Client()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>Client</h4> +<pre>public Client()</pre> +<div class="block">Default Constructor</div> +</li> +</ul> +<a name="Client(org.trafodion.dcs.rest.client.Cluster)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>Client</h4> +<pre>public Client(<a href="../../../../../org/trafodion/dcs/rest/client/Cluster.html" title="class in org.trafodion.dcs.rest.client">Cluster</a> cluster)</pre> +<div class="block">Constructor</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cluster</code> - the cluster definition</dd></dl> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="shutdown()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>shutdown</h4> +<pre>public void shutdown()</pre> +<div class="block">Shut down the client. Close any open persistent connections.</div> +</li> +</ul> +<a name="getHttpClient()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getHttpClient</h4> +<pre>public org.apache.commons.httpclient.HttpClient getHttpClient()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>the wrapped HttpClient</dd></dl> +</li> +</ul> +<a name="addExtraHeader(java.lang.String, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addExtraHeader</h4> +<pre>public void addExtraHeader(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> value)</pre> +<div class="block">Add extra headers. These extra headers will be applied to all http + methods before they are removed. If any header is not used any more, + client needs to remove it explicitly.</div> +</li> +</ul> +<a name="getExtraHeader(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getExtraHeader</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> getExtraHeader(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name)</pre> +<div class="block">Get an extra header value.</div> +</li> +</ul> +<a name="getExtraHeaders()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getExtraHeaders</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>> getExtraHeaders()</pre> +<div class="block">Get all extra headers (read-only).</div> +</li> +</ul> +<a name="removeExtraHeader(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>removeExtraHeader</h4> +<pre>public void removeExtraHeader(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name)</pre> +<div class="block">Remove an extra header.</div> +</li> +</ul> +<a name="executePathOnly(org.trafodion.dcs.rest.client.Cluster, org.apache.commons.httpclient.HttpMethod, org.apache.commons.httpclient.Header[], java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>executePathOnly</h4> +<pre>public int executePathOnly(<a href="../../../../../org/trafodion/dcs/rest/client/Cluster.html" title="class in org.trafodion.dcs.rest.client">Cluster</a> cluster, + org.apache.commons.httpclient.HttpMethod method, + org.apache.commons.httpclient.Header[] headers, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> path) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<div class="block">Execute a transaction method given only the path. Will select at random + one of the members of the supplied cluster definition and iterate through + the list until a transaction can be successfully completed. The + definition of success here is a complete HTTP transaction, irrespective + of result code.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cluster</code> - the cluster definition</dd><dd><code>method</code> - the transaction method</dd><dd><code>headers</code> - HTTP header values to send</dd><dd><code>path</code> - the properly urlencoded path</dd> +<dt><span class="strong">Returns:</span></dt><dd>the HTTP response code</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code></dd></dl> +</li> +</ul> +<a name="executeURI(org.apache.commons.httpclient.HttpMethod, org.apache.commons.httpclient.Header[], java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>executeURI</h4> +<pre>public int executeURI(org.apache.commons.httpclient.HttpMethod method, + org.apache.commons.httpclient.Header[] headers, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> uri) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<div class="block">Execute a transaction method given a complete URI.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>method</code> - the transaction method</dd><dd><code>headers</code> - HTTP header values to send</dd><dd><code>uri</code> - a properly urlencoded URI</dd> +<dt><span class="strong">Returns:</span></dt><dd>the HTTP response code</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code></dd></dl> +</li> +</ul> +<a name="execute(org.trafodion.dcs.rest.client.Cluster, org.apache.commons.httpclient.HttpMethod, org.apache.commons.httpclient.Header[], java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>execute</h4> +<pre>public int execute(<a href="../../../../../org/trafodion/dcs/rest/client/Cluster.html" title="class in org.trafodion.dcs.rest.client">Cluster</a> cluster, + org.apache.commons.httpclient.HttpMethod method, + org.apache.commons.httpclient.Header[] headers, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> path) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<div class="block">Execute a transaction method. Will call either <tt>executePathOnly</tt> + or <tt>executeURI</tt> depending on whether a path only is supplied in + 'path', or if a complete URI is passed instead, respectively.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cluster</code> - the cluster definition</dd><dd><code>method</code> - the HTTP method</dd><dd><code>headers</code> - HTTP header values to send</dd><dd><code>path</code> - the properly urlencoded path or URI</dd> +<dt><span class="strong">Returns:</span></dt><dd>the HTTP response code</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code></dd></dl> +</li> +</ul> +<a name="getCluster()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCluster</h4> +<pre>public <a href="../../../../../org/trafodion/dcs/rest/client/Cluster.html" title="class in org.trafodion.dcs.rest.client">Cluster</a> getCluster()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>the cluster definition</dd></dl> +</li> +</ul> +<a name="setCluster(org.trafodion.dcs.rest.client.Cluster)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setCluster</h4> +<pre>public void setCluster(<a href="../../../../../org/trafodion/dcs/rest/client/Cluster.html" title="class in org.trafodion.dcs.rest.client">Cluster</a> cluster)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cluster</code> - the cluster definition</dd></dl> +</li> +</ul> +<a name="head(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>head</h4> +<pre>public <a href="../../../../../org/trafodion/dcs/rest/client/Response.html" title="class in org.trafodion.dcs.rest.client">Response</a> head(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> path) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<div class="block">Send a HEAD request</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>path</code> - the path or URI</dd> +<dt><span class="strong">Returns:</span></dt><dd>a Response object with response detail</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code></dd></dl> +</li> +</ul> +<a name="head(org.trafodion.dcs.rest.client.Cluster, java.lang.String, org.apache.commons.httpclient.Header[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>head</h4> +<pre>public <a href="../../../../../org/trafodion/dcs/rest/client/Response.html" title="class in org.trafodion.dcs.rest.client">Response</a> head(<a href="../../../../../org/trafodion/dcs/rest/client/Cluster.html" title="class in org.trafodion.dcs.rest.client">Cluster</a> cluster, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> path, + org.apache.commons.httpclient.Header[] headers) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<div class="block">Send a HEAD request</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cluster</code> - the cluster definition</dd><dd><code>path</code> - the path or URI</dd><dd><code>headers</code> - the HTTP headers to include in the request</dd> +<dt><span class="strong">Returns:</span></dt><dd>a Response object with response detail</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code></dd></dl> +</li> +</ul> +<a name="get(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre>public <a href="../../../../../org/trafodion/dcs/rest/client/Response.html" title="class in org.trafodion.dcs.rest.client">Response</a> get(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> path) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<div class="block">Send a GET request</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>path</code> - the path or URI</dd> +<dt><span class="strong">Returns:</span></dt><dd>a Response object with response detail</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code></dd></dl> +</li> +</ul> +<a name="get(org.trafodion.dcs.rest.client.Cluster, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre>public <a href="../../../../../org/trafodion/dcs/rest/client/Response.html" title="class in org.trafodion.dcs.rest.client">Response</a> get(<a href="../../../../../org/trafodion/dcs/rest/client/Cluster.html" title="class in org.trafodion.dcs.rest.client">Cluster</a> cluster, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> path) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<div class="block">Send a GET request</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cluster</code> - the cluster definition</dd><dd><code>path</code> - the path or URI</dd> +<dt><span class="strong">Returns:</span></dt><dd>a Response object with response detail</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code></dd></dl> +</li> +</ul> +<a name="get(java.lang.String, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre>public <a href="../../../../../org/trafodion/dcs/rest/client/Response.html" title="class in org.trafodion.dcs.rest.client">Response</a> get(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> path, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> accept) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<div class="block">Send a GET request</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>path</code> - the path or URI</dd><dd><code>accept</code> - Accept header value</dd> +<dt><span class="strong">Returns:</span></dt><dd>a Response object with response detail</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code></dd></dl> +</li> +</ul> +<a name="get(org.trafodion.dcs.rest.client.Cluster, java.lang.String, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre>public <a href="../../../../../org/trafodion/dcs/rest/client/Response.html" title="class in org.trafodion.dcs.rest.client">Response</a> get(<a href="../../../../../org/trafodion/dcs/rest/client/Cluster.html" title="class in org.trafodion.dcs.rest.client">Cluster</a> cluster, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> path, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> accept) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<div class="block">Send a GET request</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cluster</code> - the cluster definition</dd><dd><code>path</code> - the path or URI</dd><dd><code>accept</code> - Accept header value</dd> +<dt><span class="strong">Returns:</span></dt><dd>a Response object with response detail</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code></dd></dl> +</li> +</ul> +<a name="get(java.lang.String, org.apache.commons.httpclient.Header[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre>public <a href="../../../../../org/trafodion/dcs/rest/client/Response.html" title="class in org.trafodion.dcs.rest.client">Response</a> get(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> path, + org.apache.commons.httpclient.Header[] headers) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<div class="block">Send a GET request</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>path</code> - the path or URI</dd><dd><code>headers</code> - the HTTP headers to include in the request, + <tt>Accept</tt> must be supplied</dd> +<dt><span class="strong">Returns:</span></dt><dd>a Response object with response detail</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code></dd></dl> +</li> +</ul> +<a name="get(org.trafodion.dcs.rest.client.Cluster, java.lang.String, org.apache.commons.httpclient.Header[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre>public <a href="../../../../../org/trafodion/dcs/rest/client/Response.html" title="class in org.trafodion.dcs.rest.client">Response</a> get(<a href="../../../../../org/trafodion/dcs/rest/client/Cluster.html" title="class in org.trafodion.dcs.rest.client">Cluster</a> c, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> path, + org.apache.commons.httpclient.Header[] headers) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<div class="block">Send a GET request</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>c</code> - the cluster definition</dd><dd><code>path</code> - the path or URI</dd><dd><code>headers</code> - the HTTP headers to include in the request</dd> +<dt><span class="strong">Returns:</span></dt><dd>a Response object with response detail</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code></dd></dl> +</li> +</ul> +<a name="put(java.lang.String, java.lang.String, byte[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>put</h4> +<pre>public <a href="../../../../../org/trafodion/dcs/rest/client/Response.html" title="class in org.trafodion.dcs.rest.client">Response</a> put(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> path, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> contentType, + byte[] content) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<div class="block">Send a PUT request</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>path</code> - the path or URI</dd><dd><code>contentType</code> - the content MIME type</dd><dd><code>content</code> - the content bytes</dd> +<dt><span class="strong">Returns:</span></dt><dd>a Response object with response detail</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code></dd></dl> +</li> +</ul> +<a name="put(org.trafodion.dcs.rest.client.Cluster, java.lang.String, java.lang.String, byte[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>put</h4> +<pre>public <a href="../../../../../org/trafodion/dcs/rest/client/Response.html" title="class in org.trafodion.dcs.rest.client">Response</a> put(<a href="../../../../../org/trafodion/dcs/rest/client/Cluster.html" title="class in org.trafodion.dcs.rest.client">Cluster</a> cluster, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> path, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> contentType, + byte[] content) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<div class="block">Send a PUT request</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cluster</code> - the cluster definition</dd><dd><code>path</code> - the path or URI</dd><dd><code>contentType</code> - the content MIME type</dd><dd><code>content</code> - the content bytes</dd> +<dt><span class="strong">Returns:</span></dt><dd>a Response object with response detail</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code></dd></dl> +</li> +</ul> +<a name="put(java.lang.String, org.apache.commons.httpclient.Header[], byte[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>put</h4> +<pre>public <a href="../../../../../org/trafodion/dcs/rest/client/Response.html" title="class in org.trafodion.dcs.rest.client">Response</a> put(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> path, + org.apache.commons.httpclient.Header[] headers, + byte[] content) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<div class="block">Send a PUT request</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>path</code> - the path or URI</dd><dd><code>headers</code> - the HTTP headers to include, <tt>Content-Type</tt> must be + supplied</dd><dd><code>content</code> - the content bytes</dd> +<dt><span class="strong">Returns:</span></dt><dd>a Response object with response detail</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code></dd></dl> +</li> +</ul> +<a name="put(org.trafodion.dcs.rest.client.Cluster, java.lang.String, org.apache.commons.httpclient.Header[], byte[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>put</h4> +<pre>public <a href="../../../../../org/trafodion/dcs/rest/client/Response.html" title="class in org.trafodion.dcs.rest.client">Response</a> put(<a href="../../../../../org/trafodion/dcs/rest/client/Cluster.html" title="class in org.trafodion.dcs.rest.client">Cluster</a> cluster, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> path, + org.apache.commons.httpclient.Header[] headers, + byte[] content) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<div class="block">Send a PUT request</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cluster</code> - the cluster definition</dd><dd><code>path</code> - the path or URI</dd><dd><code>headers</code> - the HTTP headers to include, <tt>Content-Type</tt> must be + supplied</dd><dd><code>content</code> - the content bytes</dd> +<dt><span class="strong">Returns:</span></dt><dd>a Response object with response detail</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code></dd></dl> +</li> +</ul> +<a name="post(java.lang.String, java.lang.String, byte[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>post</h4> +<pre>public <a href="../../../../../org/trafodion/dcs/rest/client/Response.html" title="class in org.trafodion.dcs.rest.client">Response</a> post(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> path, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> contentType, + byte[] content) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<div class="block">Send a POST request</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>path</code> - the path or URI</dd><dd><code>contentType</code> - the content MIME type</dd><dd><code>content</code> - the content bytes</dd> +<dt><span class="strong">Returns:</span></dt><dd>a Response object with response detail</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code></dd></dl> +</li> +</ul> +<a name="post(org.trafodion.dcs.rest.client.Cluster, java.lang.String, java.lang.String, byte[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>post</h4> +<pre>public <a href="../../../../../org/trafodion/dcs/rest/client/Response.html" title="class in org.trafodion.dcs.rest.client">Response</a> post(<a href="../../../../../org/trafodion/dcs/rest/client/Cluster.html" title="class in org.trafodion.dcs.rest.client">Cluster</a> cluster, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> path, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> contentType, + byte[] content) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<div class="block">Send a POST request</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cluster</code> - the cluster definition</dd><dd><code>path</code> - the path or URI</dd><dd><code>contentType</code> - the content MIME type</dd><dd><code>content</code> - the content bytes</dd> +<dt><span class="strong">Returns:</span></dt><dd>a Response object with response detail</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code></dd></dl> +</li> +</ul> +<a name="post(java.lang.String, org.apache.commons.httpclient.Header[], byte[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>post</h4> +<pre>public <a href="../../../../../org/trafodion/dcs/rest/client/Response.html" title="class in org.trafodion.dcs.rest.client">Response</a> post(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> path, + org.apache.commons.httpclient.Header[] headers, + byte[] content) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<div class="block">Send a POST request</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>path</code> - the path or URI</dd><dd><code>headers</code> - the HTTP headers to include, <tt>Content-Type</tt> must be + supplied</dd><dd><code>content</code> - the content bytes</dd> +<dt><span class="strong">Returns:</span></dt><dd>a Response object with response detail</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code></dd></dl> +</li> +</ul> +<a name="post(org.trafodion.dcs.rest.client.Cluster, java.lang.String, org.apache.commons.httpclient.Header[], byte[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>post</h4> +<pre>public <a href="../../../../../org/trafodion/dcs/rest/client/Response.html" title="class in org.trafodion.dcs.rest.client">Response</a> post(<a href="../../../../../org/trafodion/dcs/rest/client/Cluster.html" title="class in org.trafodion.dcs.rest.client">Cluster</a> cluster, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> path, + org.apache.commons.httpclient.Header[] headers, + byte[] content) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<div class="block">Send a POST request</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cluster</code> - the cluster definition</dd><dd><code>path</code> - the path or URI</dd><dd><code>headers</code> - the HTTP headers to include, <tt>Content-Type</tt> must be + supplied</dd><dd><code>content</code> - the content bytes</dd> +<dt><span class="strong">Returns:</span></dt><dd>a Response object with response detail</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code></dd></dl> +</li> +</ul> +<a name="delete(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>delete</h4> +<pre>public <a href="../../../../../org/trafodion/dcs/rest/client/Response.html" title="class in org.trafodion.dcs.rest.client">Response</a> delete(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> path) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<div class="block">Send a DELETE request</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>path</code> - the path or URI</dd> +<dt><span class="strong">Returns:</span></dt><dd>a Response object with response detail</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code></dd></dl> +</li> +</ul> +<a name="delete(org.trafodion.dcs.rest.client.Cluster, java.lang.String)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>delete</h4> +<pre>public <a href="../../../../../org/trafodion/dcs/rest/client/Response.html" title="class in org.trafodion.dcs.rest.client">Response</a> delete(<a href="../../../../../org/trafodion/dcs/rest/client/Cluster.html" title="class in org.trafodion.dcs.rest.client">Cluster</a> cluster, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> path) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<div class="block">Send a DELETE request</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cluster</code> - the cluster definition</dd><dd><code>path</code> - the path or URI</dd> +<dt><span class="strong">Returns:</span></dt><dd>a Response object with response detail</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code></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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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="class-use/Client.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev Class</li> +<li><a href="../../../../../org/trafodion/dcs/rest/client/Cluster.html" title="class in org.trafodion.dcs.rest.client"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/trafodion/dcs/rest/client/Client.html" target="_top">Frames</a></li> +<li><a href="Client.html" target="_top">No Frames</a></li> +</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><a href="#field_summary">Field</a> | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field_detail">Field</a> | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2016. All rights reserved.</small></p> +</body> +</html>
http://git-wip-us.apache.org/repos/asf/incubator-trafodion-site/blob/645fc344/docs/2.1.0/dcs_reference/apidocs/org/trafodion/dcs/rest/client/Cluster.html ---------------------------------------------------------------------- diff --git a/docs/2.1.0/dcs_reference/apidocs/org/trafodion/dcs/rest/client/Cluster.html b/docs/2.1.0/dcs_reference/apidocs/org/trafodion/dcs/rest/client/Cluster.html new file mode 100644 index 0000000..09237ef --- /dev/null +++ b/docs/2.1.0/dcs_reference/apidocs/org/trafodion/dcs/rest/client/Cluster.html @@ -0,0 +1,401 @@ +<!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 (version 1.7.0_91) on Thu Mar 03 20:15:36 UTC 2016 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Cluster (Trafodion Database Connectivity Services 2.0.0 API)</title> +<meta name="date" content="2016-03-03"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="Cluster (Trafodion Database Connectivity Services 2.0.0 API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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="class-use/Cluster.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../org/trafodion/dcs/rest/client/Client.html" title="class in org.trafodion.dcs.rest.client"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/trafodion/dcs/rest/client/Response.html" title="class in org.trafodion.dcs.rest.client"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/trafodion/dcs/rest/client/Cluster.html" target="_top">Frames</a></li> +<li><a href="Cluster.html" target="_top">No Frames</a></li> +</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><a href="#field_summary">Field</a> | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field_detail">Field</a> | </li> +<li><a href="#constructor_detail">Constr</a> | </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">org.trafodion.dcs.rest.client</div> +<h2 title="Class Cluster" class="title">Class Cluster</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li>org.trafodion.dcs.rest.client.Cluster</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">Cluster</span> +extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></pre> +<div class="block">A list of 'host:port' addresses of HTTP servers operating as a single + entity, for example multiple redundant web service gateways.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<caption><span>Fields</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Field and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/trafodion/dcs/rest/client/Cluster.html#lastHost">lastHost</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/trafodion/dcs/rest/client/Cluster.html#nodes">nodes</a></strong></code> </td> +</tr> +</table> +</li> +</ul> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../../org/trafodion/dcs/rest/client/Cluster.html#Cluster()">Cluster</a></strong>()</code> +<div class="block">Constructor</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../../org/trafodion/dcs/rest/client/Cluster.html#Cluster(java.util.List)">Cluster</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>> nodes)</code> +<div class="block">Constructor</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/trafodion/dcs/rest/client/Cluster.html" title="class in org.trafodion.dcs.rest.client">Cluster</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/trafodion/dcs/rest/client/Cluster.html#add(java.lang.String)">add</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> node)</code> +<div class="block">Add a node to the cluster</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/trafodion/dcs/rest/client/Cluster.html" title="class in org.trafodion.dcs.rest.client">Cluster</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/trafodion/dcs/rest/client/Cluster.html#add(java.lang.String,%20int)">add</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name, + int port)</code> +<div class="block">Add a node to the cluster</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/trafodion/dcs/rest/client/Cluster.html#isEmpty()">isEmpty</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/trafodion/dcs/rest/client/Cluster.html" title="class in org.trafodion.dcs.rest.client">Cluster</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/trafodion/dcs/rest/client/Cluster.html#remove(java.lang.String)">remove</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> node)</code> +<div class="block">Remove a node from the cluster</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/trafodion/dcs/rest/client/Cluster.html" title="class in org.trafodion.dcs.rest.client">Cluster</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/trafodion/dcs/rest/client/Cluster.html#remove(java.lang.String,%20int)">remove</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name, + int port)</code> +<div class="block">Remove a node from the cluster</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang /Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="nodes"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>nodes</h4> +<pre>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>> nodes</pre> +</li> +</ul> +<a name="lastHost"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>lastHost</h4> +<pre>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> lastHost</pre> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="Cluster()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>Cluster</h4> +<pre>public Cluster()</pre> +<div class="block">Constructor</div> +</li> +</ul> +<a name="Cluster(java.util.List)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>Cluster</h4> +<pre>public Cluster(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>> nodes)</pre> +<div class="block">Constructor</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>nodes</code> - a list of service locations, in 'host:port' format</dd></dl> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="isEmpty()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isEmpty</h4> +<pre>public boolean isEmpty()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>true if no locations have been added, false otherwise</dd></dl> +</li> +</ul> +<a name="add(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>add</h4> +<pre>public <a href="../../../../../org/trafodion/dcs/rest/client/Cluster.html" title="class in org.trafodion.dcs.rest.client">Cluster</a> add(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> node)</pre> +<div class="block">Add a node to the cluster</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>node</code> - the service location in 'host:port' format</dd></dl> +</li> +</ul> +<a name="add(java.lang.String, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>add</h4> +<pre>public <a href="../../../../../org/trafodion/dcs/rest/client/Cluster.html" title="class in org.trafodion.dcs.rest.client">Cluster</a> add(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name, + int port)</pre> +<div class="block">Add a node to the cluster</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - host name</dd><dd><code>port</code> - service port</dd></dl> +</li> +</ul> +<a name="remove(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>remove</h4> +<pre>public <a href="../../../../../org/trafodion/dcs/rest/client/Cluster.html" title="class in org.trafodion.dcs.rest.client">Cluster</a> remove(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> node)</pre> +<div class="block">Remove a node from the cluster</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>node</code> - the service location in 'host:port' format</dd></dl> +</li> +</ul> +<a name="remove(java.lang.String, int)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>remove</h4> +<pre>public <a href="../../../../../org/trafodion/dcs/rest/client/Cluster.html" title="class in org.trafodion.dcs.rest.client">Cluster</a> remove(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name, + int port)</pre> +<div class="block">Remove a node from the cluster</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - host name</dd><dd><code>port</code> - service port</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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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="class-use/Cluster.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../org/trafodion/dcs/rest/client/Client.html" title="class in org.trafodion.dcs.rest.client"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/trafodion/dcs/rest/client/Response.html" title="class in org.trafodion.dcs.rest.client"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/trafodion/dcs/rest/client/Cluster.html" target="_top">Frames</a></li> +<li><a href="Cluster.html" target="_top">No Frames</a></li> +</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><a href="#field_summary">Field</a> | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field_detail">Field</a> | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2016. All rights reserved.</small></p> +</body> +</html>
