| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>WebTarget</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="WebTarget"; |
| } |
| } |
| 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}; |
| 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/SyncInvoker.html" title="interface in jakarta.ws.rs.client"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?jakarta/ws/rs/client/WebTarget.html" target="_top">Frames</a></li> |
| <li><a href="WebTarget.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 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><a href="../../../../jakarta/ws/rs/core/Configurable.html" title="interface in jakarta.ws.rs.core">Configurable</a><<a href="../../../../jakarta/ws/rs/client/WebTarget.html" title="interface in jakarta.ws.rs.client">WebTarget</a>></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">WebTarget</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/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> |
| </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>java.net.URI</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/ws/rs/client/WebTarget.html#getUri--">getUri</a></span>()</code> |
| <div class="block">Get the URI identifying the resource.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../jakarta/ws/rs/core/UriBuilder.html" title="class in jakarta.ws.rs.core">UriBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/ws/rs/client/WebTarget.html#getUriBuilder--">getUriBuilder</a></span>()</code> |
| <div class="block">Get the URI builder initialized with the <code>URI</code> of the current resource target.</div> |
| </td> |
| </tr> |
| <tr id="i2" 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/WebTarget.html#matrixParam-java.lang.String-java.lang.Object...-">matrixParam</a></span>(java.lang.String name, |
| java.lang.Object... values)</code> |
| <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="../../../../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/WebTarget.html#path-java.lang.String-">path</a></span>(java.lang.String path)</code> |
| <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="../../../../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/WebTarget.html#queryParam-java.lang.String-java.lang.Object...-">queryParam</a></span>(java.lang.String name, |
| java.lang.Object... values)</code> |
| <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="../../../../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/WebTarget.html#request--">request</a></span>()</code> |
| <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="../../../../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/WebTarget.html#request-jakarta.ws.rs.core.MediaType...-">request</a></span>(<a href="../../../../jakarta/ws/rs/core/MediaType.html" title="class in jakarta.ws.rs.core">MediaType</a>... acceptedResponseTypes)</code> |
| <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="../../../../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/WebTarget.html#request-java.lang.String...-">request</a></span>(java.lang.String... acceptedResponseTypes)</code> |
| <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="../../../../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/WebTarget.html#resolveTemplate-java.lang.String-java.lang.Object-">resolveTemplate</a></span>(java.lang.String name, |
| java.lang.Object value)</code> |
| <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="../../../../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/WebTarget.html#resolveTemplate-java.lang.String-java.lang.Object-boolean-">resolveTemplate</a></span>(java.lang.String name, |
| java.lang.Object value, |
| boolean encodeSlashInPath)</code> |
| <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="../../../../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/WebTarget.html#resolveTemplateFromEncoded-java.lang.String-java.lang.Object-">resolveTemplateFromEncoded</a></span>(java.lang.String name, |
| java.lang.Object value)</code> |
| <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="../../../../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/WebTarget.html#resolveTemplates-java.util.Map-">resolveTemplates</a></span>(java.util.Map<java.lang.String,java.lang.Object> templateValues)</code> |
| <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="../../../../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/WebTarget.html#resolveTemplates-java.util.Map-boolean-">resolveTemplates</a></span>(java.util.Map<java.lang.String,java.lang.Object> templateValues, |
| boolean encodeSlashInPath)</code> |
| <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="../../../../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/WebTarget.html#resolveTemplatesFromEncoded-java.util.Map-">resolveTemplatesFromEncoded</a></span>(java.util.Map<java.lang.String,java.lang.Object> templateValues)</code> |
| <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 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="getUri--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getUri</h4> |
| <pre>java.net.URI 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 name="getUriBuilder--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getUriBuilder</h4> |
| <pre><a href="../../../../jakarta/ws/rs/core/UriBuilder.html" title="class in jakarta.ws.rs.core">UriBuilder</a> getUriBuilder()</pre> |
| <div class="block">Get the URI builder initialized with the <code>URI</code> 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 name="path-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>path</h4> |
| <pre><a href="../../../../jakarta/ws/rs/client/WebTarget.html" title="interface in jakarta.ws.rs.client">WebTarget</a> path(java.lang.String 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>java.lang.NullPointerException</code> - if path is <code>null</code>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="resolveTemplate-java.lang.String-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>resolveTemplate</h4> |
| <pre><a href="../../../../jakarta/ws/rs/client/WebTarget.html" title="interface in jakarta.ws.rs.client">WebTarget</a> resolveTemplate(java.lang.String name, |
| java.lang.Object 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 <code>NullPointerException</code> 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>java.lang.NullPointerException</code> - if the resolved template name or value is <code>null</code>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="resolveTemplate-java.lang.String-java.lang.Object-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>resolveTemplate</h4> |
| <pre><a href="../../../../jakarta/ws/rs/client/WebTarget.html" title="interface in jakarta.ws.rs.client">WebTarget</a> resolveTemplate(java.lang.String name, |
| java.lang.Object 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 <code>NullPointerException</code> 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>java.lang.NullPointerException</code> - if the resolved template name or value is <code>null</code>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="resolveTemplateFromEncoded-java.lang.String-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>resolveTemplateFromEncoded</h4> |
| <pre><a href="../../../../jakarta/ws/rs/client/WebTarget.html" title="interface in jakarta.ws.rs.client">WebTarget</a> resolveTemplateFromEncoded(java.lang.String name, |
| java.lang.Object 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 <code>NullPointerException</code> 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>java.lang.NullPointerException</code> - if the resolved template name or value is <code>null</code>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="resolveTemplates-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>resolveTemplates</h4> |
| <pre><a href="../../../../jakarta/ws/rs/client/WebTarget.html" title="interface in jakarta.ws.rs.client">WebTarget</a> resolveTemplates(java.util.Map<java.lang.String,java.lang.Object> 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>java.lang.NullPointerException</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 name="resolveTemplates-java.util.Map-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>resolveTemplates</h4> |
| <pre><a href="../../../../jakarta/ws/rs/client/WebTarget.html" title="interface in jakarta.ws.rs.client">WebTarget</a> resolveTemplates(java.util.Map<java.lang.String,java.lang.Object> 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>java.lang.NullPointerException</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 name="resolveTemplatesFromEncoded-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>resolveTemplatesFromEncoded</h4> |
| <pre><a href="../../../../jakarta/ws/rs/client/WebTarget.html" title="interface in jakarta.ws.rs.client">WebTarget</a> resolveTemplatesFromEncoded(java.util.Map<java.lang.String,java.lang.Object> 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>java.lang.NullPointerException</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 name="matrixParam-java.lang.String-java.lang.Object...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>matrixParam</h4> |
| <pre><a href="../../../../jakarta/ws/rs/client/WebTarget.html" title="interface in jakarta.ws.rs.client">WebTarget</a> matrixParam(java.lang.String name, |
| java.lang.Object... 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>java.lang.NullPointerException</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 name="queryParam-java.lang.String-java.lang.Object...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>queryParam</h4> |
| <pre><a href="../../../../jakarta/ws/rs/client/WebTarget.html" title="interface in jakarta.ws.rs.client">WebTarget</a> queryParam(java.lang.String name, |
| java.lang.Object... 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>java.lang.NullPointerException</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 name="request--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>request</h4> |
| <pre><a href="../../../../jakarta/ws/rs/client/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 name="request-java.lang.String...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>request</h4> |
| <pre><a href="../../../../jakarta/ws/rs/client/Invocation.Builder.html" title="interface in jakarta.ws.rs.client">Invocation.Builder</a> request(java.lang.String... 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 name="request-jakarta.ws.rs.core.MediaType...-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>request</h4> |
| <pre><a href="../../../../jakarta/ws/rs/client/Invocation.Builder.html" title="interface in jakarta.ws.rs.client">Invocation.Builder</a> request(<a href="../../../../jakarta/ws/rs/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> |
| </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/SyncInvoker.html" title="interface in jakarta.ws.rs.client"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?jakarta/ws/rs/client/WebTarget.html" target="_top">Frames</a></li> |
| <li><a href="WebTarget.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> |
