This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
Overview  Package   Class 
 PREV CLASS   NEXT CLASS FRAMES   NO FRAMES 
SUMMARY: NESTED | FIELD | CONSTR | METHOD  DETAIL: FIELD | CONSTR | METHOD 

javax.xml.ws.wsaddressing
class W3CEndpointReferenceBuilder

java.lang.Object extended by javax.xml.ws.wsaddressing.W3CEndpointReferenceBuilder 
public final class W3CEndpointReferenceBuilder
extends Object

This class is used to build W3CEndpointReference instances. The intended use of this clsss is for an application component, for example a factory component, to create an W3CEndpointReference for a web service endpoint published by the same Java EE application. It can also be used to create W3CEndpointReferences for an Java SE based endpoint by providing the address property.

When creating a W3CEndpointReference for an endpoint that is not published by the same Java EE application, the address property MUST be specified.

When creating a W3CEndpointReference for an endpoint published by the same Java EE application, the address property MAY be null but then the serviceName and endpointName MUST specify an endpoint published by the same Java EE application.

When the wsdlDocumentLocation is specified it MUST refer to a valid WSDL document and the serviceName and endpointName (if specified) MUST match a service and port in the WSDL document.

Constructor Summary
W3CEndpointReferenceBuilder()

          Creates a new W3CEndpointReferenceBuilder instance.
 
Method Summary
 W3CEndpointReferenceBuilder
address(String address)

          Sets the address to the W3CEndpointReference instance's wsa:Address.
 W3CEndpointReference
build()

          Builds a W3CEndpointReference from the accumulated properties set on this W3CEndpointReferenceBuilder instance.
 W3CEndpointReferenceBuilder
endpointName(QName endpointName)

          Sets the endpointName of the endpoint to be targeted by the returned W3CEndpointRefernce.
 W3CEndpointReferenceBuilder
metadata(Element metadataElement)

          Adds the metadataElement to the W3CEndpointReference instance's wsa:Metadata element.
 W3CEndpointReferenceBuilder
referenceParameter(Element referenceParameter)

          Adds the referenceParameter to the W3CEndpointReference instance wsa:ReferenceParameters element.
 W3CEndpointReferenceBuilder
serviceName(QName serviceName)

          Sets the serviceName of the endpoint to be targeted by the returned W3CEndpointReference.
 W3CEndpointReferenceBuilder
wsdlDocumentLocation(String wsdlDocumentLocation)

          Sets the wsdlDocumentLocation associated with the targeted W3CEndpointReference.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

W3CEndpointReferenceBuilder

public W3CEndpointReferenceBuilder()
Creates a new W3CEndpointReferenceBuilder instance.

Method Detail

address

public W3CEndpointReferenceBuilder address(String address)
Sets the address to the W3CEndpointReference instance's wsa:Address.

The address MUST be set to a non-null value when building a W3CEndpointReference for a web service endpoint that is not published by the same Java EE application or when running on Java SE.

Parameters:
address - The address of the endpoint to be targeted by the returned W3CEndpointReference.
Returns:
A W3CEndpointReferenceBuilder instance with the address set to the wsa:Address.

build

public W3CEndpointReference build()
Builds a W3CEndpointReference from the accumulated properties set on this W3CEndpointReferenceBuilder instance.

This method can be used to create a W3CEndpointReference for any endpoint by specifying the address property along with any other desired properties. This method can also be used to create a W3CEndpointReference for an endpoint that is published by the same Java EE application. This method can automatically determine the address of an endpoint published by the same Java EE application that is identified by the serviceName and endpointName properties. If the address is null and the serviceName and endpointName do not identify an endpoint published by the same Java EE application, a java.lang.IllegalStateException MUST be thrown.

Returns:
W3CEndpointReference from the accumulated properties set on this W3CEndpointReferenceBuilder instance. This method never returns null.

endpointName

public W3CEndpointReferenceBuilder endpointName(QName endpointName)
Sets the endpointName of the endpoint to be targeted by the returned W3CEndpointRefernce. This method can only be called after the {@link #serviceName} method has been called.

Parameters:
endpointName - The name of the endpoint to be targeted by the returned W3CEndpointReference. The endpointName (portName) property may also be used with the serviceName property to lookup the address of a web service endpoint published by the same Java EE application.
Returns:
A W3CEndpointReferenceBuilder instance with the endpointName property set.

metadata

public W3CEndpointReferenceBuilder metadata(Element metadataElement)
Adds the metadataElement to the W3CEndpointReference instance's wsa:Metadata element.

Parameters:
metadataElement - The element to be added to the wsa:Metadata element.
Returns:
A W3CEndpointReferenceBuilder instance with the metadataElement added to the wsa:Metadata element.

referenceParameter

public W3CEndpointReferenceBuilder referenceParameter(Element referenceParameter)
Adds the referenceParameter to the W3CEndpointReference instance wsa:ReferenceParameters element.

Parameters:
referenceParameter - The element to be added to the wsa:ReferenceParameters element.
Returns:
A W3CEndpointReferenceBuilder instance with the referenceParameter added to the wsa:ReferenceParameters element.

serviceName

public W3CEndpointReferenceBuilder serviceName(QName serviceName)
Sets the serviceName of the endpoint to be targeted by the returned W3CEndpointReference.

Parameters:
serviceName - The service name of the endpoint to be targeted by the returned W3CEndpointReference. This property may also be used with the endpointName (portName) property to lookup the address of a web service endpoint that is published by the same Java EE application.
Returns:
A W3CEndpointReferenceBuilder instance with the serviceName property set.

wsdlDocumentLocation

public W3CEndpointReferenceBuilder wsdlDocumentLocation(String wsdlDocumentLocation)
Sets the wsdlDocumentLocation associated with the targeted W3CEndpointReference.

Parameters:
wsdlDocumentLocation - The location of the WSDL document associated with the targeted W3CEndpointReference.
Returns:
A W3CEndpointReferenceBuilder instance with the wsdlDocumentLocation property set.
Overview  Package   Class 
 PREV CLASS   NEXT CLASS FRAMES   NO FRAMES 
SUMMARY: NESTED | FIELD | CONSTR | METHOD  DETAIL: FIELD | CONSTR | METHOD 
This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
This page displays the Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
Copyright 2008 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
The official Sun™ documentation can be found here at http://java.sun.com/javase/6/docs/api/.