| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>Client</title> |
| <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="Client"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":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-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="../../../../jakarta/ws/rs/client/AsyncInvoker.html" title="interface in jakarta.ws.rs.client"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../jakarta/ws/rs/client/ClientBuilder.html" title="class in jakarta.ws.rs.client"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?jakarta/ws/rs/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>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">jakarta.ws.rs.client</div> |
| <h2 title="Interface Client" class="title">Interface Client</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><a href="../../../../jakarta/ws/rs/core/Configurable.html" title="interface in jakarta.ws.rs.core">Configurable</a><<a href="../../../../jakarta/ws/rs/client/Client.html" title="interface in jakarta.ws.rs.client">Client</a>></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">Client</span> |
| extends <a href="../../../../jakarta/ws/rs/core/Configurable.html" title="interface in jakarta.ws.rs.core">Configurable</a><<a href="../../../../jakarta/ws/rs/client/Client.html" title="interface in jakarta.ws.rs.client">Client</a>></pre> |
| <div class="block"><p> |
| Client is the main entry point to the fluent API used to build and execute client requests in order to consume |
| responses returned. |
| </p> |
| Clients are heavy-weight objects that manage the client-side communication infrastructure. Initialization as well as |
| disposal of a <code>Client</code> instance may be a rather expensive operation. It is therefore advised to construct only |
| a small number of <code>Client</code> instances in the application. Client instances must be <a href="../../../../jakarta/ws/rs/client/Client.html#close--"><code>properly |
| closed</code></a> before being disposed to avoid leaking resources.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.0</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../jakarta/ws/rs/core/Configurable.html" title="interface in jakarta.ws.rs.core"><code>Configurable</code></a></dd> |
| </dl> |
| </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="../../../../jakarta/ws/rs/client/Client.html#close--">close</a></span>()</code> |
| <div class="block"> |
| Close client instance and all it's associated resources.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>javax.net.ssl.HostnameVerifier</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/ws/rs/client/Client.html#getHostnameVerifier--">getHostnameVerifier</a></span>()</code> |
| <div class="block">Get the hostname verifier configured in the client or <code>null</code> in case no hostname verifier has been configured.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>javax.net.ssl.SSLContext</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/ws/rs/client/Client.html#getSslContext--">getSslContext</a></span>()</code> |
| <div class="block">Get the SSL context configured to be used with the current client run-time.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../jakarta/ws/rs/client/Invocation.Builder.html" title="interface in jakarta.ws.rs.client">Invocation.Builder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/ws/rs/client/Client.html#invocation-jakarta.ws.rs.core.Link-">invocation</a></span>(<a href="../../../../jakarta/ws/rs/core/Link.html" title="class in jakarta.ws.rs.core">Link</a> link)</code> |
| <div class="block"> |
| Build an invocation builder from a link.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../jakarta/ws/rs/client/WebTarget.html" title="interface in jakarta.ws.rs.client">WebTarget</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/ws/rs/client/Client.html#target-jakarta.ws.rs.core.Link-">target</a></span>(<a href="../../../../jakarta/ws/rs/core/Link.html" title="class in jakarta.ws.rs.core">Link</a> link)</code> |
| <div class="block">Build a new web resource target.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../jakarta/ws/rs/client/WebTarget.html" title="interface in jakarta.ws.rs.client">WebTarget</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/ws/rs/client/Client.html#target-java.lang.String-">target</a></span>(java.lang.String uri)</code> |
| <div class="block">Build a new web resource target.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../jakarta/ws/rs/client/WebTarget.html" title="interface in jakarta.ws.rs.client">WebTarget</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/ws/rs/client/Client.html#target-java.net.URI-">target</a></span>(java.net.URI uri)</code> |
| <div class="block">Build a new web resource target.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../jakarta/ws/rs/client/WebTarget.html" title="interface in jakarta.ws.rs.client">WebTarget</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/ws/rs/client/Client.html#target-jakarta.ws.rs.core.UriBuilder-">target</a></span>(<a href="../../../../jakarta/ws/rs/core/UriBuilder.html" title="class in jakarta.ws.rs.core">UriBuilder</a> uriBuilder)</code> |
| <div class="block">Build a new web resource target.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.jakarta.ws.rs.core.Configurable"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface jakarta.ws.rs.core.<a href="../../../../jakarta/ws/rs/core/Configurable.html" title="interface in jakarta.ws.rs.core">Configurable</a></h3> |
| <code><a href="../../../../jakarta/ws/rs/core/Configurable.html#getConfiguration--">getConfiguration</a>, <a href="../../../../jakarta/ws/rs/core/Configurable.html#property-java.lang.String-java.lang.Object-">property</a>, <a href="../../../../jakarta/ws/rs/core/Configurable.html#register-java.lang.Class-">register</a>, <a href="../../../../jakarta/ws/rs/core/Configurable.html#register-java.lang.Class-java.lang.Class...-">register</a>, <a href="../../../../jakarta/ws/rs/core/Configurable.html#register-java.lang.Class-int-">register</a>, <a href="../../../../jakarta/ws/rs/core/Configurable.html#register-java.lang.Class-java.util.Map-">register</a>, <a href="../../../../jakarta/ws/rs/core/Configurable.html#register-java.lang.Object-">register</a>, <a href="../../../../jakarta/ws/rs/core/Configurable.html#register-java.lang.Object-java.lang.Class...-">register</a>, <a href="../../../../jakarta/ws/rs/core/Configurable.html#register-java.lang.Object-int-">register</a>, <a href="../../../../jakarta/ws/rs/core/Configurable.html#register-java.lang.Object-java.util.Map-">register</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="close--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>close</h4> |
| <pre>void close()</pre> |
| <div class="block"><p> |
| Close client instance and all it's associated resources. Subsequent calls have no effect and are ignored. Once the |
| client is closed, invoking any other method on the client instance would result in an <code>IllegalStateException</code> |
| being thrown. |
| </p> |
| Calling this method effectively invalidates all <a href="../../../../jakarta/ws/rs/client/WebTarget.html" title="interface in jakarta.ws.rs.client"><code>resource targets</code></a> produced by the client instance. |
| Invoking any method on such targets once the client is closed would result in an <code>IllegalStateException</code> being |
| thrown.</div> |
| </li> |
| </ul> |
| <a name="target-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>target</h4> |
| <pre><a href="../../../../jakarta/ws/rs/client/WebTarget.html" title="interface in jakarta.ws.rs.client">WebTarget</a> target(java.lang.String uri)</pre> |
| <div class="block">Build a new web resource target.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>uri</code> - web resource URI. May contain template parameters. Must not be <code>null</code>.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>web resource target bound to the provided URI.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.IllegalArgumentException</code> - in case the supplied string is not a valid URI template.</dd> |
| <dd><code>java.lang.NullPointerException</code> - in case the supplied argument is <code>null</code>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="target-java.net.URI-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>target</h4> |
| <pre><a href="../../../../jakarta/ws/rs/client/WebTarget.html" title="interface in jakarta.ws.rs.client">WebTarget</a> target(java.net.URI uri)</pre> |
| <div class="block">Build a new web resource target.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>uri</code> - web resource URI. Must not be <code>null</code>.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>web resource target bound to the provided URI.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.NullPointerException</code> - in case the supplied argument is <code>null</code>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="target-jakarta.ws.rs.core.UriBuilder-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>target</h4> |
| <pre><a href="../../../../jakarta/ws/rs/client/WebTarget.html" title="interface in jakarta.ws.rs.client">WebTarget</a> target(<a href="../../../../jakarta/ws/rs/core/UriBuilder.html" title="class in jakarta.ws.rs.core">UriBuilder</a> uriBuilder)</pre> |
| <div class="block">Build a new web resource target.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>uriBuilder</code> - web resource URI represented as URI builder. Must not be <code>null</code>.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>web resource target bound to the provided URI.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.NullPointerException</code> - in case the supplied argument is <code>null</code>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="target-jakarta.ws.rs.core.Link-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>target</h4> |
| <pre><a href="../../../../jakarta/ws/rs/client/WebTarget.html" title="interface in jakarta.ws.rs.client">WebTarget</a> target(<a href="../../../../jakarta/ws/rs/core/Link.html" title="class in jakarta.ws.rs.core">Link</a> link)</pre> |
| <div class="block">Build a new web resource target.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>link</code> - link to a web resource. Must not be <code>null</code>.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>web resource target bound to the linked web resource.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.NullPointerException</code> - in case the supplied argument is <code>null</code>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="invocation-jakarta.ws.rs.core.Link-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>invocation</h4> |
| <pre><a href="../../../../jakarta/ws/rs/client/Invocation.Builder.html" title="interface in jakarta.ws.rs.client">Invocation.Builder</a> invocation(<a href="../../../../jakarta/ws/rs/core/Link.html" title="class in jakarta.ws.rs.core">Link</a> link)</pre> |
| <div class="block"><p> |
| Build an invocation builder from a link. It uses the URI and the type of the link to initialize the invocation |
| builder. The type is used as the initial value for the HTTP Accept header, if present. |
| </p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>link</code> - link to build invocation from. Must not be <code>null</code>.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>newly created invocation builder.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.NullPointerException</code> - in case link is <code>null</code>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSslContext--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSslContext</h4> |
| <pre>javax.net.ssl.SSLContext getSslContext()</pre> |
| <div class="block">Get the SSL context configured to be used with the current client run-time.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>SSL context configured to be used with the current client run-time.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getHostnameVerifier--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getHostnameVerifier</h4> |
| <pre>javax.net.ssl.HostnameVerifier getHostnameVerifier()</pre> |
| <div class="block">Get the hostname verifier configured in the client or <code>null</code> in case no hostname verifier has been configured.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>client hostname verifier or <code>null</code> if not set.</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-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="../../../../jakarta/ws/rs/client/AsyncInvoker.html" title="interface in jakarta.ws.rs.client"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../jakarta/ws/rs/client/ClientBuilder.html" title="class in jakarta.ws.rs.client"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?jakarta/ws/rs/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>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> |
