| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>W3CEndpointReferenceBuilder</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="W3CEndpointReferenceBuilder"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance 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/wsaddressing/W3CEndpointReference.html" title="class in javax.xml.ws.wsaddressing"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?javax/xml/ws/wsaddressing/W3CEndpointReferenceBuilder.html" target="_top">Frames</a></li> |
| <li><a href="W3CEndpointReferenceBuilder.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.wsaddressing</div> |
| <h2 title="Class W3CEndpointReferenceBuilder" class="title">Class W3CEndpointReferenceBuilder</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>javax.xml.ws.wsaddressing.W3CEndpointReferenceBuilder</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public final class <span class="typeNameLabel">W3CEndpointReferenceBuilder</span> |
| extends java.lang.Object</pre> |
| <div class="block">This class is used to build <code>W3CEndpointReference</code> |
| instances. The intended use of this clsss is for |
| an application component, for example a factory component, |
| to create an <code>W3CEndpointReference</code> for a |
| web service endpoint published by the same |
| Java EE application. It can also be used to create |
| <code>W3CEndpointReferences</code> for an Java SE based |
| endpoint by providing the <code>address</code> property. |
| <p> |
| When creating a <code>W3CEndpointReference</code> for an |
| endpoint that is not published by the same Java EE application, |
| the <code>address</code> property MUST be specified. |
| <p> |
| When creating a <code>W3CEndpointReference</code> for an endpoint |
| published by the same Java EE application, the <code>address</code> |
| property MAY be <code>null</code> but then the <code>serviceName</code> |
| and <code>endpointName</code> MUST specify an endpoint published by |
| the same Java EE application. |
| <p> |
| When the <code>wsdlDocumentLocation</code> is specified it MUST refer |
| to a valid WSDL document and the <code>serviceName</code> and |
| <code>endpointName</code> (if specified) MUST match a service and port |
| in the WSDL document.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.6, JAX-WS 2.1</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="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../javax/xml/ws/wsaddressing/W3CEndpointReferenceBuilder.html#W3CEndpointReferenceBuilder--">W3CEndpointReferenceBuilder</a></span>()</code> |
| <div class="block">Creates a new <code>W3CEndpointReferenceBuilder</code> instance.</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="t2" class="tableTab"><span><a href="javascript:show(2);">Instance 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><a href="../../../../javax/xml/ws/wsaddressing/W3CEndpointReferenceBuilder.html" title="class in javax.xml.ws.wsaddressing">W3CEndpointReferenceBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/xml/ws/wsaddressing/W3CEndpointReferenceBuilder.html#address-java.lang.String-">address</a></span>(java.lang.String address)</code> |
| <div class="block">Sets the <code>address</code> to the |
| <code>W3CEndpointReference</code> instance's |
| <code>wsa:Address</code>.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../javax/xml/ws/wsaddressing/W3CEndpointReferenceBuilder.html" title="class in javax.xml.ws.wsaddressing">W3CEndpointReferenceBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/xml/ws/wsaddressing/W3CEndpointReferenceBuilder.html#attribute-javax.xml.namespace.QName-java.lang.String-">attribute</a></span>(javax.xml.namespace.QName name, |
| java.lang.String value)</code> |
| <div class="block">Adds an extension attribute to the |
| <code>W3CEndpointReference</code> instance's |
| <code>wsa:EndpointReference</code> element.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../javax/xml/ws/wsaddressing/W3CEndpointReference.html" title="class in javax.xml.ws.wsaddressing">W3CEndpointReference</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/xml/ws/wsaddressing/W3CEndpointReferenceBuilder.html#build--">build</a></span>()</code> |
| <div class="block">Builds a <code>W3CEndpointReference</code> from the accumulated |
| properties set on this <code>W3CEndpointReferenceBuilder</code> |
| instance.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../javax/xml/ws/wsaddressing/W3CEndpointReferenceBuilder.html" title="class in javax.xml.ws.wsaddressing">W3CEndpointReferenceBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/xml/ws/wsaddressing/W3CEndpointReferenceBuilder.html#element-org.w3c.dom.Element-">element</a></span>(org.w3c.dom.Element element)</code> |
| <div class="block">Adds an extension element to the |
| <code>W3CEndpointReference</code> instance's |
| <code>wsa:EndpointReference</code> element.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../javax/xml/ws/wsaddressing/W3CEndpointReferenceBuilder.html" title="class in javax.xml.ws.wsaddressing">W3CEndpointReferenceBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/xml/ws/wsaddressing/W3CEndpointReferenceBuilder.html#endpointName-javax.xml.namespace.QName-">endpointName</a></span>(javax.xml.namespace.QName endpointName)</code> |
| <div class="block">Sets the <code>endpointName</code> as |
| <code>wsam:ServiceName/@EndpointName</code> in the |
| <code>wsa:Metadata</code> element.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../javax/xml/ws/wsaddressing/W3CEndpointReferenceBuilder.html" title="class in javax.xml.ws.wsaddressing">W3CEndpointReferenceBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/xml/ws/wsaddressing/W3CEndpointReferenceBuilder.html#interfaceName-javax.xml.namespace.QName-">interfaceName</a></span>(javax.xml.namespace.QName interfaceName)</code> |
| <div class="block">Sets the <code>interfaceName</code> as the |
| <code>wsam:InterfaceName</code> element in the |
| <code>wsa:Metadata</code> element.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../javax/xml/ws/wsaddressing/W3CEndpointReferenceBuilder.html" title="class in javax.xml.ws.wsaddressing">W3CEndpointReferenceBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/xml/ws/wsaddressing/W3CEndpointReferenceBuilder.html#metadata-org.w3c.dom.Element-">metadata</a></span>(org.w3c.dom.Element metadataElement)</code> |
| <div class="block">Adds the <code>metadataElement</code> to the |
| <code>W3CEndpointReference</code> instance's |
| <code>wsa:Metadata</code> element.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../javax/xml/ws/wsaddressing/W3CEndpointReferenceBuilder.html" title="class in javax.xml.ws.wsaddressing">W3CEndpointReferenceBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/xml/ws/wsaddressing/W3CEndpointReferenceBuilder.html#referenceParameter-org.w3c.dom.Element-">referenceParameter</a></span>(org.w3c.dom.Element referenceParameter)</code> |
| <div class="block">Adds the <code>referenceParameter</code> to the |
| <code>W3CEndpointReference</code> instance |
| <code>wsa:ReferenceParameters</code> element.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../javax/xml/ws/wsaddressing/W3CEndpointReferenceBuilder.html" title="class in javax.xml.ws.wsaddressing">W3CEndpointReferenceBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/xml/ws/wsaddressing/W3CEndpointReferenceBuilder.html#serviceName-javax.xml.namespace.QName-">serviceName</a></span>(javax.xml.namespace.QName serviceName)</code> |
| <div class="block">Sets the <code>serviceName</code> as the |
| <code>wsam:ServiceName</code> element in the |
| <code>wsa:Metadata</code> element.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../javax/xml/ws/wsaddressing/W3CEndpointReferenceBuilder.html" title="class in javax.xml.ws.wsaddressing">W3CEndpointReferenceBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/xml/ws/wsaddressing/W3CEndpointReferenceBuilder.html#wsdlDocumentLocation-java.lang.String-">wsdlDocumentLocation</a></span>(java.lang.String wsdlDocumentLocation)</code> |
| <div class="block">Sets the <code>wsdlDocumentLocation</code> that will be referenced |
| as <code>wsa:Metadata/@wsdli:wsdlLocation</code>.</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, toString, 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="W3CEndpointReferenceBuilder--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>W3CEndpointReferenceBuilder</h4> |
| <pre>public W3CEndpointReferenceBuilder()</pre> |
| <div class="block">Creates a new <code>W3CEndpointReferenceBuilder</code> instance.</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="address-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>address</h4> |
| <pre>public <a href="../../../../javax/xml/ws/wsaddressing/W3CEndpointReferenceBuilder.html" title="class in javax.xml.ws.wsaddressing">W3CEndpointReferenceBuilder</a> address(java.lang.String address)</pre> |
| <div class="block">Sets the <code>address</code> to the |
| <code>W3CEndpointReference</code> instance's |
| <code>wsa:Address</code>. |
| <p> |
| The <code>address</code> MUST be set to a non-<code>null</code> |
| value when building a <code>W3CEndpointReference</code> for a |
| web service endpoint that is not published by the same |
| Java EE application or when running on Java SE.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>address</code> - The address of the endpoint to be targeted |
| by the returned <code>W3CEndpointReference</code>.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A <code>W3CEndpointReferenceBuilder</code> instance with |
| the <code>address</code> set to the <code>wsa:Address</code>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="interfaceName-javax.xml.namespace.QName-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>interfaceName</h4> |
| <pre>public <a href="../../../../javax/xml/ws/wsaddressing/W3CEndpointReferenceBuilder.html" title="class in javax.xml.ws.wsaddressing">W3CEndpointReferenceBuilder</a> interfaceName(javax.xml.namespace.QName interfaceName)</pre> |
| <div class="block">Sets the <code>interfaceName</code> as the |
| <code>wsam:InterfaceName</code> element in the |
| <code>wsa:Metadata</code> element. |
| |
| See <a href="http://www.w3.org/TR/2007/REC-ws-addr-metadata-20070904/#refmetadatfromepr"> |
| 2.1 Referencing WSDL Metadata from an EPR</a> for more details.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>interfaceName</code> - The port type name of the endpoint to be targeted |
| by the returned <code>W3CEndpointReference</code>.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A <code>W3CEndpointReferenceBuilder</code> instance with |
| the <code>interfaceName</code> as <code>wsam:InterfaceName</code> |
| element added to the <code>wsa:Metadata</code> element</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.7</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="serviceName-javax.xml.namespace.QName-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>serviceName</h4> |
| <pre>public <a href="../../../../javax/xml/ws/wsaddressing/W3CEndpointReferenceBuilder.html" title="class in javax.xml.ws.wsaddressing">W3CEndpointReferenceBuilder</a> serviceName(javax.xml.namespace.QName serviceName)</pre> |
| <div class="block">Sets the <code>serviceName</code> as the |
| <code>wsam:ServiceName</code> element in the |
| <code>wsa:Metadata</code> element. |
| |
| See <a href="http://www.w3.org/TR/2007/REC-ws-addr-metadata-20070904/#refmetadatfromepr"> |
| 2.1 Referencing WSDL Metadata from an EPR</a> for more details.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>serviceName</code> - The service name of the endpoint to be targeted |
| by the returned <code>W3CEndpointReference</code>. This property |
| may also be used with the <code>endpointName</code> (portName) |
| property to lookup the <code>address</code> of a web service |
| endpoint that is published by the same Java EE application.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A <code>W3CEndpointReferenceBuilder</code> instance with |
| the <code>serviceName</code> as <code>wsam:ServiceName</code> |
| element added to the <code>wsa:Metadata</code> element</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="endpointName-javax.xml.namespace.QName-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>endpointName</h4> |
| <pre>public <a href="../../../../javax/xml/ws/wsaddressing/W3CEndpointReferenceBuilder.html" title="class in javax.xml.ws.wsaddressing">W3CEndpointReferenceBuilder</a> endpointName(javax.xml.namespace.QName endpointName)</pre> |
| <div class="block">Sets the <code>endpointName</code> as |
| <code>wsam:ServiceName/@EndpointName</code> in the |
| <code>wsa:Metadata</code> element. This method can only be called |
| after the <a href="../../../../javax/xml/ws/wsaddressing/W3CEndpointReferenceBuilder.html#serviceName-javax.xml.namespace.QName-"><code>serviceName(QName)</code></a> method has been called. |
| <p> |
| See <a href="http://www.w3.org/TR/2007/REC-ws-addr-metadata-20070904/#refmetadatfromepr"> |
| 2.1 Referencing WSDL Metadata from an EPR</a> for more details.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>endpointName</code> - The name of the endpoint to be targeted |
| by the returned <code>W3CEndpointReference</code>. The |
| <code>endpointName</code> (portName) property may also be |
| used with the <code>serviceName</code> property to lookup |
| the <code>address</code> of a web service |
| endpoint published by the same Java EE application.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A <code>W3CEndpointReferenceBuilder</code> instance with |
| the <code>endpointName</code> as |
| <code>wsam:ServiceName/@EndpointName</code> in the |
| <code>wsa:Metadata</code> element.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.IllegalStateException</code> - if the <code>serviceName</code> |
| has not been set</dd> |
| <dd><code>java.lang.IllegalArgumentException</code> - if the <code>endpointName</code>'s |
| Namespace URI doesn't match <code>serviceName</code>'s Namespace URI</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="wsdlDocumentLocation-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>wsdlDocumentLocation</h4> |
| <pre>public <a href="../../../../javax/xml/ws/wsaddressing/W3CEndpointReferenceBuilder.html" title="class in javax.xml.ws.wsaddressing">W3CEndpointReferenceBuilder</a> wsdlDocumentLocation(java.lang.String wsdlDocumentLocation)</pre> |
| <div class="block">Sets the <code>wsdlDocumentLocation</code> that will be referenced |
| as <code>wsa:Metadata/@wsdli:wsdlLocation</code>. The namespace name |
| for the wsdli:wsdlLocation's value can be taken from the WSDL itself. |
| |
| <p> |
| See <a href="http://www.w3.org/TR/2007/REC-ws-addr-metadata-20070904/#refmetadatfromepr"> |
| 2.1 Referencing WSDL Metadata from an EPR</a> for more details.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>wsdlDocumentLocation</code> - The location of the WSDL document to |
| be referenced in the <code>wsa:Metadata</code> of the |
| <code>W3CEndpointReference</code>.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A <code>W3CEndpointReferenceBuilder</code> instance with |
| the <code>wsdlDocumentLocation</code> that is to be referenced.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="referenceParameter-org.w3c.dom.Element-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>referenceParameter</h4> |
| <pre>public <a href="../../../../javax/xml/ws/wsaddressing/W3CEndpointReferenceBuilder.html" title="class in javax.xml.ws.wsaddressing">W3CEndpointReferenceBuilder</a> referenceParameter(org.w3c.dom.Element referenceParameter)</pre> |
| <div class="block">Adds the <code>referenceParameter</code> to the |
| <code>W3CEndpointReference</code> instance |
| <code>wsa:ReferenceParameters</code> element.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>referenceParameter</code> - The element to be added to the |
| <code>wsa:ReferenceParameters</code> element.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A <code>W3CEndpointReferenceBuilder</code> instance with |
| the <code>referenceParameter</code> added to the |
| <code>wsa:ReferenceParameters</code> element.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.IllegalArgumentException</code> - if <code>referenceParameter</code> |
| is <code>null</code>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="metadata-org.w3c.dom.Element-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>metadata</h4> |
| <pre>public <a href="../../../../javax/xml/ws/wsaddressing/W3CEndpointReferenceBuilder.html" title="class in javax.xml.ws.wsaddressing">W3CEndpointReferenceBuilder</a> metadata(org.w3c.dom.Element metadataElement)</pre> |
| <div class="block">Adds the <code>metadataElement</code> to the |
| <code>W3CEndpointReference</code> instance's |
| <code>wsa:Metadata</code> element.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>metadataElement</code> - The element to be added to the |
| <code>wsa:Metadata</code> element.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A <code>W3CEndpointReferenceBuilder</code> instance with |
| the <code>metadataElement</code> added to the |
| <code>wsa:Metadata</code> element.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.IllegalArgumentException</code> - if <code>metadataElement</code> |
| is <code>null</code>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="element-org.w3c.dom.Element-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>element</h4> |
| <pre>public <a href="../../../../javax/xml/ws/wsaddressing/W3CEndpointReferenceBuilder.html" title="class in javax.xml.ws.wsaddressing">W3CEndpointReferenceBuilder</a> element(org.w3c.dom.Element element)</pre> |
| <div class="block">Adds an extension element to the |
| <code>W3CEndpointReference</code> instance's |
| <code>wsa:EndpointReference</code> element.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>element</code> - The extension element to be added to the |
| <code>W3CEndpointReference</code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A <code>W3CEndpointReferenceBuilder</code> instance with |
| the extension <code>element</code> added to the |
| <code>W3CEndpointReference</code> instance.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.IllegalArgumentException</code> - if <code>element</code> |
| is <code>null</code>.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.7, JAX-WS 2.2</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="attribute-javax.xml.namespace.QName-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>attribute</h4> |
| <pre>public <a href="../../../../javax/xml/ws/wsaddressing/W3CEndpointReferenceBuilder.html" title="class in javax.xml.ws.wsaddressing">W3CEndpointReferenceBuilder</a> attribute(javax.xml.namespace.QName name, |
| java.lang.String value)</pre> |
| <div class="block">Adds an extension attribute to the |
| <code>W3CEndpointReference</code> instance's |
| <code>wsa:EndpointReference</code> element.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - The name of the extension attribute to be added to the |
| <code>W3CEndpointReference</code></dd> |
| <dd><code>value</code> - extension attribute value</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A <code>W3CEndpointReferenceBuilder</code> instance with |
| the extension attribute added to the <code>W3CEndpointReference</code> |
| instance.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.IllegalArgumentException</code> - if <code>name</code> |
| or <code>value</code> is <code>null</code>.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.7, JAX-WS 2.2</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="build--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>build</h4> |
| <pre>public <a href="../../../../javax/xml/ws/wsaddressing/W3CEndpointReference.html" title="class in javax.xml.ws.wsaddressing">W3CEndpointReference</a> build()</pre> |
| <div class="block">Builds a <code>W3CEndpointReference</code> from the accumulated |
| properties set on this <code>W3CEndpointReferenceBuilder</code> |
| instance. |
| <p> |
| This method can be used to create a <code>W3CEndpointReference</code> |
| for any endpoint by specifying the <code>address</code> property along |
| with any other desired properties. This method |
| can also be used to create a <code>W3CEndpointReference</code> for |
| an endpoint that is published by the same Java EE application. |
| This method can automatically determine the <code>address</code> of |
| an endpoint published by the same Java EE application that is identified by the |
| <code>serviceName</code> and |
| <code>endpointName</code> properties. If the <code>address</code> is |
| <code>null</code> and the <code>serviceName</code> and |
| <code>endpointName</code> |
| do not identify an endpoint published by the same Java EE application, a |
| <code>java.lang.IllegalStateException</code> MUST be thrown.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>W3CEndpointReference</code> from the accumulated |
| properties set on this <code>W3CEndpointReferenceBuilder</code> |
| instance. This method never returns <code>null</code>.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.IllegalStateException</code> - <ul> |
| <li>If the <code>address</code>, <code>serviceName</code> and |
| <code>endpointName</code> are all <code>null</code>. |
| <li>If the <code>serviceName</code> service is <code>null</code> and the |
| <code>endpointName</code> is NOT <code>null</code>. |
| <li>If the <code>address</code> property is <code>null</code> and |
| the <code>serviceName</code> and <code>endpointName</code> do not |
| specify a valid endpoint published by the same Java EE |
| application. |
| <li>If the <code>serviceName</code> is NOT <code>null</code> |
| and is not present in the specified WSDL. |
| <li>If the <code>endpointName</code> port is not <code>null</code> and it |
| is not present in <code>serviceName</code> service in the WSDL. |
| <li>If the <code>wsdlDocumentLocation</code> is NOT <code>null</code> |
| and does not represent a valid WSDL. |
| </ul></dd> |
| <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>W3CEndpointReference</code>.</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/wsaddressing/W3CEndpointReference.html" title="class in javax.xml.ws.wsaddressing"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?javax/xml/ws/wsaddressing/W3CEndpointReferenceBuilder.html" target="_top">Frames</a></li> |
| <li><a href="W3CEndpointReferenceBuilder.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> |
