File Doc Category Size Date Package
EndpointReference.java API Doc Java SE 6 API 7582 Tue Jun 10 00:27:14 BST 2008 javax.xml.ws

EndpointReference

java.lang.Object

public abstract class EndpointReference extends Object

This class represents an WS-Addressing EndpointReference which is a remote reference to a web service endpoint. See Web Services Addressing 1.0 - Core for more information on WS-Addressing EndpointReferences.

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 {@link Service} APIs that clients can use to that utilize an EndpointReference. See the {@link javax.xml.ws.Endpoint}, and {@link javax.xml.ws.BindingProvider} APIs on how EndpointReferences can be created for published endpoints.

Concrete implementations of this class will represent an EndpointReference for a particular version of Addressing. For example the {@link W3CEndpointReference} 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 EndpointReference subclass for that version. This will allow a JAX-WS implementation to create vendor specific EndpointReferences that that vendor can use to flag a different version of addressing.

Web service developers that wish to pass or return EndpointReferences in Java methods in an SEI should use concrete instances of an EndpointReference such as the W3CEndpointReference. This way the schema mapped from the SEI will be more descriptive of the type of endpoint reference being passed.

JAX-WS implementors are expected to extract the XML infoset from an EndpointReferece using the {@link EndpointReference#writeTo} method.

JAXB will bind this class to xs:anyType. If a better binding is desired, web services developers should use a concrete subclass such as {@link W3CEndpointReference}.

see: W3CEndpointReference
see: Service
since: JAX-WS 2.1

Fields Summary
Constructors Summary
protected EndpointReference()
Methods Summary
public T getPort(java.lang.Class serviceEndpointInterface, javax.xml.ws.WebServiceFeature features)
The getPort method returns a proxy. If there are any reference parameters in the EndpointReference 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 serviceEndpointInterface specifies the service endpoint interface that is supported by the returned proxy. The EndpointReference 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 EndpointReference or from annotations on the serviceEndpointInterface. For this method to successfully return a proxy, WSDL metadata MUST be available and the EndpointReference instance MUST contain an implementation understood serviceName metadata.
Because this port is not created from a Service object, handlers will not automatically be configured, and the HandlerResolver and Executor cannot be get or set for this port. The BindingProvider().getBinding().setHandlerChain() method can be used to manually configure handlers for this port.
param
serviceEndpointInterface Service endpoint interface
param
features An array of WebServiceFeatures to configure on the proxy. Supported features not in the features parameter will have their default values.
return
Object Proxy instance that supports the specified service endpoint interface
throws
WebServiceException

If there is an error during creation of the proxy
If there is any missing WSDL metadata as required by this method
If this endpointReference is invalid
If an illegal serviceEndpointInterface is specified
If a feature is enabled that is not compatible with this port or is unsupported.
see
java.lang.reflect.Proxy
see
WebServiceFeature
return Provider.provider().getPort(this, serviceEndpointInterface, features);
public static javax.xml.ws.EndpointReference readFrom(javax.xml.transform.Source eprInfoset)
Factory method to read an EndpointReference from the infoset contained in eprInfoset. This method delegates to the vendor specific implementation of the {@link javax.xml.ws.spi.Provider#readEndpointReference} method.
param
eprInfoset The EndpointReference infoset to be unmarshalled
return
the EndpointReference unmarshalled from eprInfoset never null
throws
WebServiceException if an error occurs while creating the EndpointReference from the eprInfoset
throws
java.lang.IllegalArgumentException if the null eprInfoset value is given.
return Provider.provider().readEndpointReference(eprInfoset);
public java.lang.String toString()
Displays EPR infoset for debugging convenience.
StringWriter w = new StringWriter(); writeTo(new StreamResult(w)); return w.toString();
public abstract void writeTo(javax.xml.transform.Result result)
write this EndpointReference to the specified infoset format
throws
WebServiceException if there is an error writing the EndpointReference to the specified result.
throws
java.lang.IllegalArgumentException If the null result value is given.