| <!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 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>Client (Apache CXF JavaDoc 3.2.0 API)</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 (Apache CXF JavaDoc 3.2.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6,"i19":6,"i20":6}; |
| 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="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 class="aboutLanguage">Apache CXF API</div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/cxf/jaxrs/client/AsyncInvokerImpl.html" title="class in org.apache.cxf.jaxrs.client"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/cxf/jaxrs/client/ClientConfiguration.html" title="class in org.apache.cxf.jaxrs.client"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/cxf/jaxrs/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">org.apache.cxf.jaxrs.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 Known Implementing Classes:</dt> |
| <dd><a href="../../../../../org/apache/cxf/jaxrs/client/AbstractClient.html" title="class in org.apache.cxf.jaxrs.client">AbstractClient</a>, <a href="../../../../../org/apache/cxf/jaxrs/client/ClientProxyImpl.html" title="class in org.apache.cxf.jaxrs.client">ClientProxyImpl</a>, <a href="../../../../../org/apache/cxf/jaxrs/client/WebClient.html" title="class in org.apache.cxf.jaxrs.client">WebClient</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">Client</span></pre> |
| <div class="block">Represents common proxy and http-centric client capabilities</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/cxf/jaxrs/client/Client.html" title="interface in org.apache.cxf.jaxrs.client">Client</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/cxf/jaxrs/client/Client.html#accept-javax.ws.rs.core.MediaType...-">accept</a></span>(javax.ws.rs.core.MediaType... types)</code> |
| <div class="block">Set HTTP Accept header</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/cxf/jaxrs/client/Client.html" title="interface in org.apache.cxf.jaxrs.client">Client</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/cxf/jaxrs/client/Client.html#accept-java.lang.String...-">accept</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... types)</code> |
| <div class="block">Set HTTP Accept header</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/cxf/jaxrs/client/Client.html" title="interface in org.apache.cxf.jaxrs.client">Client</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/cxf/jaxrs/client/Client.html#acceptEncoding-java.lang.String...-">acceptEncoding</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... encodings)</code> |
| <div class="block">Set HTTP Accept-Encoding header</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/cxf/jaxrs/client/Client.html" title="interface in org.apache.cxf.jaxrs.client">Client</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/cxf/jaxrs/client/Client.html#acceptLanguage-java.lang.String...-">acceptLanguage</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... languages)</code> |
| <div class="block">Set HTTP Accept-Language header</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/cxf/jaxrs/client/Client.html" title="interface in org.apache.cxf.jaxrs.client">Client</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/cxf/jaxrs/client/Client.html#authorization-java.lang.Object-">authorization</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> auth)</code> |
| <div class="block">Set HTTP Authorization header</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/cxf/jaxrs/client/Client.html#close--">close</a></span>()</code> |
| <div class="block">Release the internal state and configuration associated with this client</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/cxf/jaxrs/client/Client.html" title="interface in org.apache.cxf.jaxrs.client">Client</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/cxf/jaxrs/client/Client.html#cookie-javax.ws.rs.core.Cookie-">cookie</a></span>(javax.ws.rs.core.Cookie cookie)</code> |
| <div class="block">Set HTTP Cookie header</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/cxf/jaxrs/client/Client.html" title="interface in org.apache.cxf.jaxrs.client">Client</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/cxf/jaxrs/client/Client.html#encoding-java.lang.String-">encoding</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> encoding)</code> |
| <div class="block">Set HTTP Content-Encoding header</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net">URI</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/cxf/jaxrs/client/Client.html#getBaseURI--">getBaseURI</a></span>()</code> |
| <div class="block">Get the base URI this Client has been intialized with</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net">URI</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/cxf/jaxrs/client/Client.html#getCurrentURI--">getCurrentURI</a></span>()</code> |
| <div class="block">Get the current URI this Client is working with</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>javax.ws.rs.core.MultivaluedMap<<a href="http://docs.oracle.com/javase/8/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/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/cxf/jaxrs/client/Client.html#getHeaders--">getHeaders</a></span>()</code> |
| <div class="block">Get the copy of request headers</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>javax.ws.rs.core.Response</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/cxf/jaxrs/client/Client.html#getResponse--">getResponse</a></span>()</code> |
| <div class="block">Get the response state if any</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/cxf/jaxrs/client/Client.html" title="interface in org.apache.cxf.jaxrs.client">Client</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/cxf/jaxrs/client/Client.html#header-java.lang.String-java.lang.Object...-">header</a></span>(<a href="http://docs.oracle.com/javase/8/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/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>... values)</code> |
| <div class="block">Set arbitrary HTTP Header</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/cxf/jaxrs/client/Client.html" title="interface in org.apache.cxf.jaxrs.client">Client</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/cxf/jaxrs/client/Client.html#headers-javax.ws.rs.core.MultivaluedMap-">headers</a></span>(javax.ws.rs.core.MultivaluedMap<<a href="http://docs.oracle.com/javase/8/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/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> map)</code> |
| <div class="block">Set HTTP Headers</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/cxf/jaxrs/client/Client.html" title="interface in org.apache.cxf.jaxrs.client">Client</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/cxf/jaxrs/client/Client.html#language-java.lang.String-">language</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> language)</code> |
| <div class="block">Set HTTP Content-Language header</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/cxf/jaxrs/client/Client.html" title="interface in org.apache.cxf.jaxrs.client">Client</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/cxf/jaxrs/client/Client.html#match-javax.ws.rs.core.EntityTag-boolean-">match</a></span>(javax.ws.rs.core.EntityTag tag, |
| boolean ifNot)</code> |
| <div class="block">Set HTTP If-Match or If-None-Match header</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/cxf/jaxrs/client/Client.html" title="interface in org.apache.cxf.jaxrs.client">Client</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/cxf/jaxrs/client/Client.html#modified-java.util.Date-boolean-">modified</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</a> date, |
| boolean ifNot)</code> |
| <div class="block">Set HTTP If-Modified-Since or If-Unmodified-Since header</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/cxf/jaxrs/client/Client.html" title="interface in org.apache.cxf.jaxrs.client">Client</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/cxf/jaxrs/client/Client.html#query-java.lang.String-java.lang.Object...-">query</a></span>(<a href="http://docs.oracle.com/javase/8/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/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>... values)</code> |
| <div class="block">Update the current URI query parameters</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/cxf/jaxrs/client/Client.html" title="interface in org.apache.cxf.jaxrs.client">Client</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/cxf/jaxrs/client/Client.html#reset--">reset</a></span>()</code> |
| <div class="block">Reset the headers and response state if any</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/cxf/jaxrs/client/Client.html" title="interface in org.apache.cxf.jaxrs.client">Client</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/cxf/jaxrs/client/Client.html#type-javax.ws.rs.core.MediaType-">type</a></span>(javax.ws.rs.core.MediaType ct)</code> |
| <div class="block">Set HTTP Content-Type header</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/cxf/jaxrs/client/Client.html" title="interface in org.apache.cxf.jaxrs.client">Client</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/cxf/jaxrs/client/Client.html#type-java.lang.String-">type</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> type)</code> |
| <div class="block">Set HTTP Content-Type header</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="type-javax.ws.rs.core.MediaType-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>type</h4> |
| <pre><a href="../../../../../org/apache/cxf/jaxrs/client/Client.html" title="interface in org.apache.cxf.jaxrs.client">Client</a> type(javax.ws.rs.core.MediaType ct)</pre> |
| <div class="block">Set HTTP Content-Type header</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>ct</code> - JAXRS MediaType representing Content-Type value</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the updated Client</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="type-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>type</h4> |
| <pre><a href="../../../../../org/apache/cxf/jaxrs/client/Client.html" title="interface in org.apache.cxf.jaxrs.client">Client</a> type(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> type)</pre> |
| <div class="block">Set HTTP Content-Type header</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>type</code> - Content-Type value</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the updated Client</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="accept-javax.ws.rs.core.MediaType...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>accept</h4> |
| <pre><a href="../../../../../org/apache/cxf/jaxrs/client/Client.html" title="interface in org.apache.cxf.jaxrs.client">Client</a> accept(javax.ws.rs.core.MediaType... types)</pre> |
| <div class="block">Set HTTP Accept header</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>types</code> - list of JAXRS MediaTypes representing Accept header values</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the updated Client</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="accept-java.lang.String...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>accept</h4> |
| <pre><a href="../../../../../org/apache/cxf/jaxrs/client/Client.html" title="interface in org.apache.cxf.jaxrs.client">Client</a> accept(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... types)</pre> |
| <div class="block">Set HTTP Accept header</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>types</code> - list of Accept header values</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the updated Client</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="language-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>language</h4> |
| <pre><a href="../../../../../org/apache/cxf/jaxrs/client/Client.html" title="interface in org.apache.cxf.jaxrs.client">Client</a> language(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> language)</pre> |
| <div class="block">Set HTTP Content-Language header</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>language</code> - Content-Language header value</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the updated Client</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="acceptLanguage-java.lang.String...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>acceptLanguage</h4> |
| <pre><a href="../../../../../org/apache/cxf/jaxrs/client/Client.html" title="interface in org.apache.cxf.jaxrs.client">Client</a> acceptLanguage(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... languages)</pre> |
| <div class="block">Set HTTP Accept-Language header</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>languages</code> - list of Accept-Language header values</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the updated Client</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="encoding-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>encoding</h4> |
| <pre><a href="../../../../../org/apache/cxf/jaxrs/client/Client.html" title="interface in org.apache.cxf.jaxrs.client">Client</a> encoding(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> encoding)</pre> |
| <div class="block">Set HTTP Content-Encoding header</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>encoding</code> - Content-Encoding header value</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the updated Client</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="acceptEncoding-java.lang.String...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>acceptEncoding</h4> |
| <pre><a href="../../../../../org/apache/cxf/jaxrs/client/Client.html" title="interface in org.apache.cxf.jaxrs.client">Client</a> acceptEncoding(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... encodings)</pre> |
| <div class="block">Set HTTP Accept-Encoding header</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>encodings</code> - list of Accept-Encoding header value</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the updated Client</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="match-javax.ws.rs.core.EntityTag-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>match</h4> |
| <pre><a href="../../../../../org/apache/cxf/jaxrs/client/Client.html" title="interface in org.apache.cxf.jaxrs.client">Client</a> match(javax.ws.rs.core.EntityTag tag, |
| boolean ifNot)</pre> |
| <div class="block">Set HTTP If-Match or If-None-Match header</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>tag</code> - ETag value</dd> |
| <dd><code>ifNot</code> - if true then If-None-Match is set, If-Match otherwise</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the updated Client</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="modified-java.util.Date-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>modified</h4> |
| <pre><a href="../../../../../org/apache/cxf/jaxrs/client/Client.html" title="interface in org.apache.cxf.jaxrs.client">Client</a> modified(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</a> date, |
| boolean ifNot)</pre> |
| <div class="block">Set HTTP If-Modified-Since or If-Unmodified-Since header</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>date</code> - Date value, will be formated as "EEE, dd MMM yyyy HH:mm:ss zzz"</dd> |
| <dd><code>ifNot</code> - if true then If-Unmodified-Since is set, If-Modified-Since otherwise</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the updated Client</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="cookie-javax.ws.rs.core.Cookie-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>cookie</h4> |
| <pre><a href="../../../../../org/apache/cxf/jaxrs/client/Client.html" title="interface in org.apache.cxf.jaxrs.client">Client</a> cookie(javax.ws.rs.core.Cookie cookie)</pre> |
| <div class="block">Set HTTP Cookie header</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>cookie</code> - Cookie value</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the updated Client</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="authorization-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>authorization</h4> |
| <pre><a href="../../../../../org/apache/cxf/jaxrs/client/Client.html" title="interface in org.apache.cxf.jaxrs.client">Client</a> authorization(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> auth)</pre> |
| <div class="block">Set HTTP Authorization header</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>auth</code> - Authorization value</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the updated Client</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="query-java.lang.String-java.lang.Object...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>query</h4> |
| <pre><a href="../../../../../org/apache/cxf/jaxrs/client/Client.html" title="interface in org.apache.cxf.jaxrs.client">Client</a> query(<a href="http://docs.oracle.com/javase/8/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/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>... values)</pre> |
| <div class="block">Update the current URI query parameters</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - query name</dd> |
| <dd><code>values</code> - query values</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>updated WebClient</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="header-java.lang.String-java.lang.Object...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>header</h4> |
| <pre><a href="../../../../../org/apache/cxf/jaxrs/client/Client.html" title="interface in org.apache.cxf.jaxrs.client">Client</a> header(<a href="http://docs.oracle.com/javase/8/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/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>... values)</pre> |
| <div class="block">Set arbitrary HTTP Header</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - header name</dd> |
| <dd><code>values</code> - list of header values</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the updated Client</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="headers-javax.ws.rs.core.MultivaluedMap-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>headers</h4> |
| <pre><a href="../../../../../org/apache/cxf/jaxrs/client/Client.html" title="interface in org.apache.cxf.jaxrs.client">Client</a> headers(javax.ws.rs.core.MultivaluedMap<<a href="http://docs.oracle.com/javase/8/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/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> map)</pre> |
| <div class="block">Set HTTP Headers</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>map</code> - headers</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the updated Client</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="reset--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>reset</h4> |
| <pre><a href="../../../../../org/apache/cxf/jaxrs/client/Client.html" title="interface in org.apache.cxf.jaxrs.client">Client</a> reset()</pre> |
| <div class="block">Reset the headers and response state if any</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the updated Client</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getHeaders--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getHeaders</h4> |
| <pre>javax.ws.rs.core.MultivaluedMap<<a href="http://docs.oracle.com/javase/8/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/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> getHeaders()</pre> |
| <div class="block">Get the copy of request headers</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>request headers</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getBaseURI--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBaseURI</h4> |
| <pre><a href="http://docs.oracle.com/javase/8/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net">URI</a> getBaseURI()</pre> |
| <div class="block">Get the base URI this Client has been intialized with</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>base URI</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getCurrentURI--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCurrentURI</h4> |
| <pre><a href="http://docs.oracle.com/javase/8/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net">URI</a> getCurrentURI()</pre> |
| <div class="block">Get the current URI this Client is working with</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>current URI</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getResponse--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getResponse</h4> |
| <pre>javax.ws.rs.core.Response getResponse()</pre> |
| <div class="block">Get the response state if any</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>JAXRS Response response</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="close--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>close</h4> |
| <pre>void close()</pre> |
| <div class="block">Release the internal state and configuration associated with this client</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="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 class="aboutLanguage">Apache CXF API</div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/cxf/jaxrs/client/AsyncInvokerImpl.html" title="class in org.apache.cxf.jaxrs.client"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/cxf/jaxrs/client/ClientConfiguration.html" title="class in org.apache.cxf.jaxrs.client"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/cxf/jaxrs/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 ======= --> |
| <p class="legalCopy"><small>Apache CXF</small></p> |
| </body> |
| </html> |
