| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>EndpointReference</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="EndpointReference"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":9,"i2":10,"i3":6}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete 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="../../../javax/xml/ws/EndpointContext.html" title="class in javax.xml.ws"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../javax/xml/ws/FaultAction.html" title="annotation in javax.xml.ws"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?javax/xml/ws/EndpointReference.html" target="_top">Frames</a></li> |
| <li><a href="EndpointReference.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><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">javax.xml.ws</div> |
| <h2 title="Class EndpointReference" class="title">Class EndpointReference</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>javax.xml.ws.EndpointReference</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><a href="../../../javax/xml/ws/wsaddressing/W3CEndpointReference.html" title="class in javax.xml.ws.wsaddressing">W3CEndpointReference</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public abstract class <span class="typeNameLabel">EndpointReference</span> |
| extends java.lang.Object</pre> |
| <div class="block">This class represents an WS-Addressing EndpointReference |
| which is a remote reference to a web service endpoint. |
| See <a href="http://www.w3.org/TR/2006/REC-ws-addr-core-20060509/"> |
| Web Services Addressing 1.0 - Core</a> |
| for more information on WS-Addressing EndpointReferences. |
| <p> |
| This class is immutable as the typical web service developer |
| need not be concerned with its contents. The web service |
| developer should use this class strictly as a mechanism to |
| reference a remote web service endpoint. See the <a href="../../../javax/xml/ws/Service.html" title="class in javax.xml.ws"><code>Service</code></a> APIs |
| that clients can use to that utilize an <code>EndpointReference</code>. |
| See the <a href="../../../javax/xml/ws/Endpoint.html" title="class in javax.xml.ws"><code>Endpoint</code></a>, and |
| <a href="../../../javax/xml/ws/BindingProvider.html" title="interface in javax.xml.ws"><code>BindingProvider</code></a> APIs on how |
| <code>EndpointReferences</code> can be created for published |
| endpoints. |
| <p> |
| Concrete implementations of this class will represent |
| an <code>EndpointReference</code> for a particular version of Addressing. |
| For example the <a href="../../../javax/xml/ws/wsaddressing/W3CEndpointReference.html" title="class in javax.xml.ws.wsaddressing"><code>W3CEndpointReference</code></a> is for use |
| with W3C Web Services Addressing 1.0 - Core Recommendation. |
| If JAX-WS implementors need to support different versions |
| of addressing, they should write their own |
| <code>EndpointReference</code> subclass for that version. |
| This will allow a JAX-WS implementation to create |
| a vendor specific <code>EndpointReferences</code> that the |
| vendor can use to flag a different version of |
| addressing. |
| <p> |
| Web service developers that wish to pass or return |
| <code>EndpointReference</code> in Java methods in an |
| SEI should use |
| concrete instances of an <code>EndpointReference</code> such |
| as the <code>W3CEndpointReference</code>. This way the |
| schema mapped from the SEI will be more descriptive of the |
| type of endpoint reference being passed. |
| <p> |
| JAX-WS implementors are expected to extract the XML infoset |
| from an <code>EndpointReferece</code> using the |
| <a href="../../../javax/xml/ws/EndpointReference.html#writeTo-javax.xml.transform.Result-"><code>writeTo(javax.xml.transform.Result)</code></a> |
| method. |
| <p> |
| JAXB will bind this class to xs:anyType. If a better binding |
| is desired, web services developers should use a concrete |
| subclass such as <a href="../../../javax/xml/ws/wsaddressing/W3CEndpointReference.html" title="class in javax.xml.ws.wsaddressing"><code>W3CEndpointReference</code></a>.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.6, JAX-WS 2.1</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../javax/xml/ws/wsaddressing/W3CEndpointReference.html" title="class in javax.xml.ws.wsaddressing"><code>W3CEndpointReference</code></a>, |
| <a href="../../../javax/xml/ws/Service.html" title="class in javax.xml.ws"><code>Service</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier</th> |
| <th class="colLast" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/xml/ws/EndpointReference.html#EndpointReference--">EndpointReference</a></span>()</code> |
| <div class="block">Default constructor.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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><T> T</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/xml/ws/EndpointReference.html#getPort-java.lang.Class-javax.xml.ws.WebServiceFeature...-">getPort</a></span>(java.lang.Class<T> serviceEndpointInterface, |
| <a href="../../../javax/xml/ws/WebServiceFeature.html" title="class in javax.xml.ws">WebServiceFeature</a>... features)</code> |
| <div class="block">The <code>getPort</code> method returns a proxy.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../javax/xml/ws/EndpointReference.html" title="class in javax.xml.ws">EndpointReference</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/xml/ws/EndpointReference.html#readFrom-javax.xml.transform.Source-">readFrom</a></span>(javax.xml.transform.Source eprInfoset)</code> |
| <div class="block">Factory method to read an EndpointReference from the infoset contained in |
| <code>eprInfoset</code>.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/xml/ws/EndpointReference.html#toString--">toString</a></span>()</code> |
| <div class="block">Displays EPR infoset for debugging convenience.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/xml/ws/EndpointReference.html#writeTo-javax.xml.transform.Result-">writeTo</a></span>(javax.xml.transform.Result result)</code> |
| <div class="block">write this <code>EndpointReference</code> to the specified infoset format</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.Object</h3> |
| <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="EndpointReference--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>EndpointReference</h4> |
| <pre>protected EndpointReference()</pre> |
| <div class="block">Default constructor.</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="readFrom-javax.xml.transform.Source-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>readFrom</h4> |
| <pre>public static <a href="../../../javax/xml/ws/EndpointReference.html" title="class in javax.xml.ws">EndpointReference</a> readFrom(javax.xml.transform.Source eprInfoset)</pre> |
| <div class="block">Factory method to read an EndpointReference from the infoset contained in |
| <code>eprInfoset</code>. This method delegates to the vendor specific |
| implementation of the <a href="../../../javax/xml/ws/spi/Provider.html#readEndpointReference-javax.xml.transform.Source-"><code>Provider.readEndpointReference(javax.xml.transform.Source)</code></a> method.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>eprInfoset</code> - The <code>EndpointReference</code> infoset to be unmarshalled</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the EndpointReference unmarshalled from <code>eprInfoset</code> |
| never <code>null</code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../javax/xml/ws/WebServiceException.html" title="class in javax.xml.ws">WebServiceException</a></code> - if an error occurs while creating the |
| <code>EndpointReference</code> from the <code>eprInfoset</code></dd> |
| <dd><code>java.lang.IllegalArgumentException</code> - if the <code>null</code> <code>eprInfoset</code> value is given.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="writeTo-javax.xml.transform.Result-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>writeTo</h4> |
| <pre>public abstract void writeTo(javax.xml.transform.Result result)</pre> |
| <div class="block">write this <code>EndpointReference</code> to the specified infoset format</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>result</code> - for writing infoset</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../javax/xml/ws/WebServiceException.html" title="class in javax.xml.ws">WebServiceException</a></code> - if there is an error writing the |
| <code>EndpointReference</code> to the specified <code>result</code>.</dd> |
| <dd><code>java.lang.IllegalArgumentException</code> - If the <code>null</code> <code>result</code> value is given.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getPort-java.lang.Class-javax.xml.ws.WebServiceFeature...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPort</h4> |
| <pre>public <T> T getPort(java.lang.Class<T> serviceEndpointInterface, |
| <a href="../../../javax/xml/ws/WebServiceFeature.html" title="class in javax.xml.ws">WebServiceFeature</a>... features)</pre> |
| <div class="block">The <code>getPort</code> method returns a proxy. If there |
| are any reference parameters in the |
| <code>EndpointReference</code> instance, then those reference |
| parameters MUST appear as SOAP headers, indicating them to be |
| reference parameters, on all messages sent to the endpoint. |
| The parameter <code>serviceEndpointInterface</code> specifies |
| the service endpoint interface that is supported by the |
| returned proxy. |
| The <code>EndpointReference</code> instance specifies the |
| endpoint that will be invoked by the returned proxy. |
| In the implementation of this method, the JAX-WS |
| runtime system takes the responsibility of selecting a protocol |
| binding (and a port) and configuring the proxy accordingly from |
| the WSDL Metadata from this <code>EndpointReference</code> or from |
| annotations on the <code>serviceEndpointInterface</code>. For this method |
| to successfully return a proxy, WSDL metadata MUST be available and the |
| <code>EndpointReference</code> instance MUST contain an implementation understood |
| <code>serviceName</code> metadata. |
| <p> |
| Because this port is not created from a <code>Service</code> object, handlers |
| will not automatically be configured, and the <code>HandlerResolver</code> |
| and <code>Executor</code> cannot be get or set for this port. The |
| <code>BindingProvider().getBinding().setHandlerChain()</code> |
| method can be used to manually configure handlers for this port.</div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - Service endpoint interface</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>serviceEndpointInterface</code> - Service endpoint interface</dd> |
| <dd><code>features</code> - An array of <code>WebServiceFeatures</code> to configure on the |
| proxy. Supported features not in the <code>features |
| </code> parameter will have their default values.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Object Proxy instance that supports the |
| specified service endpoint interface</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../javax/xml/ws/WebServiceException.html" title="class in javax.xml.ws">WebServiceException</a></code> - <UL> |
| <LI>If there is an error during creation |
| of the proxy |
| <LI>If there is any missing WSDL metadata |
| as required by this method |
| <LI>If this |
| <code>endpointReference</code> |
| is invalid |
| <LI>If an illegal |
| <code>serviceEndpointInterface</code> |
| is specified |
| <LI>If a feature is enabled that is not compatible with |
| this port or is unsupported. |
| </UL></dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><code>Proxy</code>, |
| <a href="../../../javax/xml/ws/WebServiceFeature.html" title="class in javax.xml.ws"><code>WebServiceFeature</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="toString--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>toString</h4> |
| <pre>public java.lang.String toString()</pre> |
| <div class="block">Displays EPR infoset for debugging convenience.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code>toString</code> in class <code>java.lang.Object</code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a string representation of the object</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="../../../javax/xml/ws/EndpointContext.html" title="class in javax.xml.ws"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../javax/xml/ws/FaultAction.html" title="annotation in javax.xml.ws"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?javax/xml/ws/EndpointReference.html" target="_top">Frames</a></li> |
| <li><a href="EndpointReference.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><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
