| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.2) on Wed Sep 23 17:36:24 GMT 2020 --> |
| <title>WebTarget (jakarta.ws.rs-api 3.0.0 API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2020-09-23"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../jquery/jquery-3.3.1.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jquery-migrate-3.0.1.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jquery-ui.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="WebTarget (jakarta.ws.rs-api 3.0.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"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}; |
| 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"; |
| var pathtoroot = "../../../../"; |
| var useModuleDirectories = true; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/WebTarget.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" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <ul class="navListSearch"> |
| <li><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </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> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </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 id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <main role="main"> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">jakarta.ws.rs.client</a></div> |
| <h2 title="Interface WebTarget" class="title">Interface WebTarget</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><code><a href="../core/Configurable.html" title="interface in jakarta.ws.rs.core">Configurable</a><<a href="WebTarget.html" title="interface in jakarta.ws.rs.client">WebTarget</a>></code></dd> |
| </dl> |
| <hr> |
| <pre>public interface <span class="typeNameLabel">WebTarget</span> |
| extends <a href="../core/Configurable.html" title="interface in jakarta.ws.rs.core">Configurable</a><<a href="WebTarget.html" title="interface in jakarta.ws.rs.client">WebTarget</a>></pre> |
| <div class="block">A resource target identified by the resource URI.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.0</dd> |
| <dt><span class="simpleTagLabel">Author:</span></dt> |
| <dd>Marek Potociar</dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary"> |
| <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="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net" class="externalLink">URI</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getUri()">getUri</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Get the URI identifying the resource.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../core/UriBuilder.html" title="class in jakarta.ws.rs.core">UriBuilder</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getUriBuilder()">getUriBuilder</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Get the URI builder initialized with the <a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net" class="externalLink"><code>URI</code></a> of the current resource target.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="WebTarget.html" title="interface in jakarta.ws.rs.client">WebTarget</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#matrixParam(java.lang.String,java.lang.Object...)">matrixParam</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> name, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>... values)</code></th> |
| <td class="colLast"> |
| <div class="block">Create a new <code>WebTarget</code> instance by appending a matrix parameter to the existing set of matrix parameters of |
| the current final segment of the URI of the current target instance.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="WebTarget.html" title="interface in jakarta.ws.rs.client">WebTarget</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#path(java.lang.String)">path</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> path)</code></th> |
| <td class="colLast"> |
| <div class="block">Create a new <code>WebTarget</code> instance by appending path to the URI of the current target instance.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="WebTarget.html" title="interface in jakarta.ws.rs.client">WebTarget</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#queryParam(java.lang.String,java.lang.Object...)">queryParam</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> name, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>... values)</code></th> |
| <td class="colLast"> |
| <div class="block">Create a new <code>WebTarget</code> instance by configuring a query parameter on the URI of the current target instance.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="Invocation.Builder.html" title="interface in jakarta.ws.rs.client">Invocation.Builder</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#request()">request</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Start building a request to the targeted web resource.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="Invocation.Builder.html" title="interface in jakarta.ws.rs.client">Invocation.Builder</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#request(jakarta.ws.rs.core.MediaType...)">request</a></span>​(<a href="../core/MediaType.html" title="class in jakarta.ws.rs.core">MediaType</a>... acceptedResponseTypes)</code></th> |
| <td class="colLast"> |
| <div class="block">Start building a request to the targeted web resource and define the accepted response media types.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="Invocation.Builder.html" title="interface in jakarta.ws.rs.client">Invocation.Builder</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#request(java.lang.String...)">request</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>... acceptedResponseTypes)</code></th> |
| <td class="colLast"> |
| <div class="block">Start building a request to the targeted web resource and define the accepted response media types.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="WebTarget.html" title="interface in jakarta.ws.rs.client">WebTarget</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#resolveTemplate(java.lang.String,java.lang.Object)">resolveTemplate</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> name, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> value)</code></th> |
| <td class="colLast"> |
| <div class="block">Create a new <code>WebTarget</code> instance by resolving a URI template with a given <code>name</code> in the URI of the |
| current target instance using a supplied value.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="WebTarget.html" title="interface in jakarta.ws.rs.client">WebTarget</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#resolveTemplate(java.lang.String,java.lang.Object,boolean)">resolveTemplate</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> name, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> value, |
| boolean encodeSlashInPath)</code></th> |
| <td class="colLast"> |
| <div class="block">Create a new <code>WebTarget</code> instance by resolving a URI template with a given <code>name</code> in the URI of the |
| current target instance using a supplied value.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code><a href="WebTarget.html" title="interface in jakarta.ws.rs.client">WebTarget</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#resolveTemplateFromEncoded(java.lang.String,java.lang.Object)">resolveTemplateFromEncoded</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> name, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> value)</code></th> |
| <td class="colLast"> |
| <div class="block">Create a new <code>WebTarget</code> instance by resolving a URI template with a given <code>name</code> in the URI of the |
| current target instance using a supplied encoded value.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code><a href="WebTarget.html" title="interface in jakarta.ws.rs.client">WebTarget</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#resolveTemplates(java.util.Map)">resolveTemplates</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,​<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>> templateValues)</code></th> |
| <td class="colLast"> |
| <div class="block">Create a new <code>WebTarget</code> instance by resolving one or more URI templates in the URI of the current target |
| instance using supplied name-value pairs.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code><a href="WebTarget.html" title="interface in jakarta.ws.rs.client">WebTarget</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#resolveTemplates(java.util.Map,boolean)">resolveTemplates</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,​<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>> templateValues, |
| boolean encodeSlashInPath)</code></th> |
| <td class="colLast"> |
| <div class="block">Create a new <code>WebTarget</code> instance by resolving one or more URI templates in the URI of the current target |
| instance using supplied name-value pairs.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code><a href="WebTarget.html" title="interface in jakarta.ws.rs.client">WebTarget</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#resolveTemplatesFromEncoded(java.util.Map)">resolveTemplatesFromEncoded</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,​<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>> templateValues)</code></th> |
| <td class="colLast"> |
| <div class="block">Create a new <code>WebTarget</code> instance by resolving one or more URI templates in the URI of the current target |
| instance using supplied name-encoded value pairs.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.jakarta.ws.rs.core.Configurable"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface jakarta.ws.rs.core.<a href="../core/Configurable.html" title="interface in jakarta.ws.rs.core">Configurable</a></h3> |
| <code><a href="../core/Configurable.html#getConfiguration()">getConfiguration</a>, <a href="../core/Configurable.html#property(java.lang.String,java.lang.Object)">property</a>, <a href="../core/Configurable.html#register(java.lang.Class)">register</a>, <a href="../core/Configurable.html#register(java.lang.Class,int)">register</a>, <a href="../core/Configurable.html#register(java.lang.Class,java.lang.Class...)">register</a>, <a href="../core/Configurable.html#register(java.lang.Class,java.util.Map)">register</a>, <a href="../core/Configurable.html#register(java.lang.Object)">register</a>, <a href="../core/Configurable.html#register(java.lang.Object,int)">register</a>, <a href="../core/Configurable.html#register(java.lang.Object,java.lang.Class...)">register</a>, <a href="../core/Configurable.html#register(java.lang.Object,java.util.Map)">register</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="getUri()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getUri</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net" class="externalLink">URI</a> getUri()</pre> |
| <div class="block">Get the URI identifying the resource.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the resource URI.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getUriBuilder()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getUriBuilder</h4> |
| <pre class="methodSignature"><a href="../core/UriBuilder.html" title="class in jakarta.ws.rs.core">UriBuilder</a> getUriBuilder()</pre> |
| <div class="block">Get the URI builder initialized with the <a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net" class="externalLink"><code>URI</code></a> of the current resource target. The returned URI builder is |
| detached from the target, i.e. any updates in the URI builder MUST NOT have any effects on the URI of the originating |
| target.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the initialized URI builder.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="path(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>path</h4> |
| <pre class="methodSignature"><a href="WebTarget.html" title="interface in jakarta.ws.rs.client">WebTarget</a> path​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> path)</pre> |
| <div class="block">Create a new <code>WebTarget</code> instance by appending path to the URI of the current target instance. |
| <p> |
| When constructing the final path, a '/' separator will be inserted between the existing path and the supplied path if |
| necessary. Existing '/' characters are preserved thus a single value can represent multiple URI path segments. |
| </p> |
| <p> |
| A snapshot of the present configuration of the current (parent) target instance is taken and is inherited by the |
| newly constructed (child) target instance. |
| </p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>path</code> - the path, may contain URI template parameters.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a new target instance.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang" class="externalLink">NullPointerException</a></code> - if path is <code>null</code>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="resolveTemplate(java.lang.String,java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>resolveTemplate</h4> |
| <pre class="methodSignature"><a href="WebTarget.html" title="interface in jakarta.ws.rs.client">WebTarget</a> resolveTemplate​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> name, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> value)</pre> |
| <div class="block">Create a new <code>WebTarget</code> instance by resolving a URI template with a given <code>name</code> in the URI of the |
| current target instance using a supplied value. |
| |
| In case a <code>null</code> template name or value is entered a <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>NullPointerException</code></a> is thrown. |
| <p> |
| A snapshot of the present configuration of the current (parent) target instance is taken and is inherited by the |
| newly constructed (child) target instance. |
| </p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - name of the URI template.</dd> |
| <dd><code>value</code> - value to be used to resolve the template.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a new target instance.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang" class="externalLink">NullPointerException</a></code> - if the resolved template name or value is <code>null</code>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="resolveTemplate(java.lang.String,java.lang.Object,boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>resolveTemplate</h4> |
| <pre class="methodSignature"><a href="WebTarget.html" title="interface in jakarta.ws.rs.client">WebTarget</a> resolveTemplate​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> name, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> value, |
| boolean encodeSlashInPath)</pre> |
| <div class="block">Create a new <code>WebTarget</code> instance by resolving a URI template with a given <code>name</code> in the URI of the |
| current target instance using a supplied value. |
| |
| In case a <code>null</code> template name or value is entered a <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>NullPointerException</code></a> is thrown. |
| <p> |
| A snapshot of the present configuration of the current (parent) target instance is taken and is inherited by the |
| newly constructed (child) target instance. |
| </p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - name of the URI template.</dd> |
| <dd><code>value</code> - value to be used to resolve the template.</dd> |
| <dd><code>encodeSlashInPath</code> - if <code>true</code>, the slash (<code>'/'</code>) characters in template values will be encoded if |
| the template is placed in the URI path component, otherwise the slash characters will not be encoded in path |
| templates.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a new target instance.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang" class="externalLink">NullPointerException</a></code> - if the resolved template name or value is <code>null</code>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="resolveTemplateFromEncoded(java.lang.String,java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>resolveTemplateFromEncoded</h4> |
| <pre class="methodSignature"><a href="WebTarget.html" title="interface in jakarta.ws.rs.client">WebTarget</a> resolveTemplateFromEncoded​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> name, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> value)</pre> |
| <div class="block">Create a new <code>WebTarget</code> instance by resolving a URI template with a given <code>name</code> in the URI of the |
| current target instance using a supplied encoded value. |
| |
| A template with a matching name will be replaced by the supplied value. Value is converted to <code>String</code> using |
| its <code>toString()</code> method and is then encoded to match the rules of the URI component to which they pertain. All |
| % characters in the stringified values that are not followed by two hexadecimal numbers will be encoded. |
| |
| In case a <code>null</code> template name or value is entered a <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>NullPointerException</code></a> is thrown. |
| <p> |
| A snapshot of the present configuration of the current (parent) target instance is taken and is inherited by the |
| newly constructed (child) target instance. |
| </p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - name of the URI template.</dd> |
| <dd><code>value</code> - encoded value to be used to resolve the template.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a new target instance.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang" class="externalLink">NullPointerException</a></code> - if the resolved template name or value is <code>null</code>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="resolveTemplates(java.util.Map)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>resolveTemplates</h4> |
| <pre class="methodSignature"><a href="WebTarget.html" title="interface in jakarta.ws.rs.client">WebTarget</a> resolveTemplates​(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,​<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>> templateValues)</pre> |
| <div class="block">Create a new <code>WebTarget</code> instance by resolving one or more URI templates in the URI of the current target |
| instance using supplied name-value pairs. |
| |
| A call to the method with an empty parameter map is ignored, i.e. same <code>WebTarget</code> instance is returned. |
| <p> |
| A snapshot of the present configuration of the current (parent) target instance is taken and is inherited by the |
| newly constructed (child) target instance. |
| </p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>templateValues</code> - a map of URI template names and their values.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a new target instance or the same target instance in case the input name-value map is empty.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang" class="externalLink">NullPointerException</a></code> - if the name-value map or any of the names or values in the map is <code>null</code>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="resolveTemplates(java.util.Map,boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>resolveTemplates</h4> |
| <pre class="methodSignature"><a href="WebTarget.html" title="interface in jakarta.ws.rs.client">WebTarget</a> resolveTemplates​(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,​<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>> templateValues, |
| boolean encodeSlashInPath)</pre> |
| <div class="block">Create a new <code>WebTarget</code> instance by resolving one or more URI templates in the URI of the current target |
| instance using supplied name-value pairs. |
| |
| A call to the method with an empty parameter map is ignored, i.e. same <code>WebTarget</code> instance is returned. |
| <p> |
| A snapshot of the present configuration of the current (parent) target instance is taken and is inherited by the |
| newly constructed (child) target instance. |
| </p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>templateValues</code> - a map of URI template names and their values.</dd> |
| <dd><code>encodeSlashInPath</code> - if <code>true</code>, the slash (<code>'/'</code>) characters in template values will be encoded if |
| the template is placed in the URI path component, otherwise the slash characters will not be encoded in path |
| templates.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a new target instance or the same target instance in case the input name-value map is empty.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang" class="externalLink">NullPointerException</a></code> - if the name-value map or any of the names or values in the map is <code>null</code>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="resolveTemplatesFromEncoded(java.util.Map)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>resolveTemplatesFromEncoded</h4> |
| <pre class="methodSignature"><a href="WebTarget.html" title="interface in jakarta.ws.rs.client">WebTarget</a> resolveTemplatesFromEncoded​(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,​<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>> templateValues)</pre> |
| <div class="block">Create a new <code>WebTarget</code> instance by resolving one or more URI templates in the URI of the current target |
| instance using supplied name-encoded value pairs. |
| |
| All templates with their name matching one of the keys in the supplied map will be replaced by the value in the |
| supplied map. Values are converted to <code>String</code> using their <code>toString()</code> method and are then encoded to |
| match the rules of the URI component to which they pertain. All % characters in the stringified values that are not |
| followed by two hexadecimal numbers will be encoded. |
| |
| A call to the method with an empty parameter map is ignored, i.e. same <code>WebTarget</code> instance is returned. |
| <p> |
| A snapshot of the present configuration of the current (parent) target instance is taken and is inherited by the |
| newly constructed (child) target instance. |
| </p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>templateValues</code> - a map of URI template names and their encoded values.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a new target instance or the same target instance in case the input name-value map is empty.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang" class="externalLink">NullPointerException</a></code> - if the name-value map or any of the names or encoded values in the map is <code>null</code>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="matrixParam(java.lang.String,java.lang.Object...)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>matrixParam</h4> |
| <pre class="methodSignature"><a href="WebTarget.html" title="interface in jakarta.ws.rs.client">WebTarget</a> matrixParam​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> name, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>... values)</pre> |
| <div class="block">Create a new <code>WebTarget</code> instance by appending a matrix parameter to the existing set of matrix parameters of |
| the current final segment of the URI of the current target instance. |
| |
| If multiple values are supplied the parameter will be added once per value. In case a single <code>null</code> value is |
| entered, all parameters with that name in the current final path segment are removed (if present) from the collection |
| of last segment matrix parameters inherited from the current target. |
| <p> |
| Note that the matrix parameters are tied to a particular path segment; appending a value to an existing matrix |
| parameter name will not affect the position of the matrix parameter in the URI path. |
| </p> |
| <p> |
| A snapshot of the present configuration of the current (parent) target instance is taken and is inherited by the |
| newly constructed (child) target instance. |
| </p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - the matrix parameter name, may contain URI template parameters.</dd> |
| <dd><code>values</code> - the matrix parameter value(s), each object will be converted to a <code>String</code> using its |
| <code>toString()</code> method. Stringified values may contain URI template parameters.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a new target instance.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang" class="externalLink">NullPointerException</a></code> - if the parameter name is <code>null</code> or if there are multiple values present and any of |
| those values is <code>null</code>.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="http://www.w3.org/DesignIssues/MatrixURIs.html">Matrix URIs</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="queryParam(java.lang.String,java.lang.Object...)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>queryParam</h4> |
| <pre class="methodSignature"><a href="WebTarget.html" title="interface in jakarta.ws.rs.client">WebTarget</a> queryParam​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> name, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>... values)</pre> |
| <div class="block">Create a new <code>WebTarget</code> instance by configuring a query parameter on the URI of the current target instance. |
| |
| If multiple values are supplied the parameter will be added once per value. In case a single <code>null</code> value is |
| entered, all parameters with that name are removed (if present) from the collection of query parameters inherited |
| from the current target. |
| <p> |
| A snapshot of the present configuration of the current (parent) target instance is taken and is inherited by the |
| newly constructed (child) target instance. |
| </p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - the query parameter name, may contain URI template parameters</dd> |
| <dd><code>values</code> - the query parameter value(s), each object will be converted to a <code>String</code> using its |
| <code>toString()</code> method. Stringified values may contain URI template parameters.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a new target instance.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang" class="externalLink">NullPointerException</a></code> - if the parameter name is <code>null</code> or if there are multiple values present and any of |
| those values is <code>null</code>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="request()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>request</h4> |
| <pre class="methodSignature"><a href="Invocation.Builder.html" title="interface in jakarta.ws.rs.client">Invocation.Builder</a> request()</pre> |
| <div class="block">Start building a request to the targeted web resource.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>builder for a request targeted at the URI referenced by this target instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="request(java.lang.String...)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>request</h4> |
| <pre class="methodSignature"><a href="Invocation.Builder.html" title="interface in jakarta.ws.rs.client">Invocation.Builder</a> request​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>... acceptedResponseTypes)</pre> |
| <div class="block">Start building a request to the targeted web resource and define the accepted response media types. |
| <p> |
| Invoking this method is identical to: |
| </p> |
| |
| <pre> |
| webTarget.request().accept(types); |
| </pre></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>acceptedResponseTypes</code> - accepted response media types.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>builder for a request targeted at the URI referenced by this target instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="request(jakarta.ws.rs.core.MediaType...)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>request</h4> |
| <pre class="methodSignature"><a href="Invocation.Builder.html" title="interface in jakarta.ws.rs.client">Invocation.Builder</a> request​(<a href="../core/MediaType.html" title="class in jakarta.ws.rs.core">MediaType</a>... acceptedResponseTypes)</pre> |
| <div class="block">Start building a request to the targeted web resource and define the accepted response media types. |
| <p> |
| Invoking this method is identical to: |
| </p> |
| |
| <pre> |
| webTarget.request().accept(types); |
| </pre></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>acceptedResponseTypes</code> - accepted response media types.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>builder for a request targeted at the URI referenced by this target instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </main> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/WebTarget.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" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses.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> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </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 id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small><p align="left">Copyright © 2018, 2020 Eclipse Foundation.<br>Use is subject to <a href="../../../../resources/EFSL.html" target="_top">license terms</a>.</small></p> |
| </footer> |
| </body> |
| </html> |
