JAX-WS API 2.3.1 · javax.xml.ws.EndpointReference

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 Service APIs that clients can use to that utilize an EndpointReference. See the javax.xml.ws.Endpoint, and 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 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 a vendor specific EndpointReferences that the vendor can use to flag a different version of addressing.

Web service developers that wish to pass or return EndpointReference 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 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 W3CEndpointReference.

Access	Constructor and Description
protected	EndpointReference() Default constructor.

Method Summary

Modifier and Type	Method and Description
public < Service endpoint interface T> T	Returns: Object Proxy instance that supports the specified service endpoint interface getPort(Class<T> Service endpoint interface serviceEndpointInterface, WebServiceFeature... An array of `WebServiceFeatures` to configure on the proxy. Supported features not in the `features` parameter will have their default values. features) The `getPort` method returns a proxy.
public static EndpointReference	Returns: the EndpointReference unmarshalled from `eprInfoset` never `null` readFrom(Source The `EndpointReference` infoset to be unmarshalled eprInfoset) Factory method to read an EndpointReference from the infoset contained in `eprInfoset`.
public String	Returns: a string representation of the object toString() Overrides java.lang.Object.toString. Displays EPR infoset for debugging convenience.
public abstract void	writeTo(Result for writing infoset result) write this `EndpointReference` to the specified infoset format

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Constructor Detail

EndpointReference	back to summary
protected EndpointReference() Default constructor.

Method Detail

getPort back to summary

getPort	back to summary
public <T> T getPort(Class<T> serviceEndpointInterface, 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. Parameters <T> Service endpoint interface serviceEndpointInterface:Class<T> Service endpoint interface features:WebServiceFeature[] An array of `WebServiceFeatures` to configure on the proxy. Supported features not in the `features` parameter will have their default values. Returns:T Object Proxy instance that supports the specified service endpoint interface Exceptions 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 Also `java.lang.reflect.Proxy`, `WebServiceFeature`

public <T> T getPort(Class<T> serviceEndpointInterface, 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.

Parameters

<T>: Service endpoint interface
serviceEndpointInterface:Class<T>: Service endpoint interface
features:WebServiceFeature[]: An array of WebServiceFeatures to configure on the proxy. Supported features not in the features parameter will have their default values.

Returns:T

Object Proxy instance that supports the specified service endpoint interface

Exceptions

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.

readFrom back to summary

readFrom	back to summary
public static EndpointReference readFrom(Source eprInfoset) Factory method to read an EndpointReference from the infoset contained in `eprInfoset`. This method delegates to the vendor specific implementation of the `javax.xml.ws.spi.Provider#readEndpointReference` method. Parameters eprInfoset:Source The `EndpointReference` infoset to be unmarshalled Returns:EndpointReference the EndpointReference unmarshalled from `eprInfoset` never `null` Exceptions WebServiceException: if an error occurs while creating the `EndpointReference` from the `eprInfoset` IllegalArgumentException: if the `null` `eprInfoset` value is given.

public static EndpointReference readFrom(Source eprInfoset)

Factory method to read an EndpointReference from the infoset contained in eprInfoset. This method delegates to the vendor specific implementation of the javax.xml.ws.spi.Provider#readEndpointReference method.

Parameters

eprInfoset:Source: The EndpointReference infoset to be unmarshalled

Returns:EndpointReference

the EndpointReference unmarshalled from eprInfoset never null

Exceptions

WebServiceException:: if an error occurs while creating the EndpointReference from the eprInfoset
IllegalArgumentException:: if the null eprInfoset value is given.

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Displays EPR infoset for debugging convenience. Returns:String a string representation of the object Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Displays EPR infoset for debugging convenience.

Returns:String

a string representation of the object

Annotations

@Override

writeTo back to summary

writeTo	back to summary
public abstract void writeTo(Result result) write this `EndpointReference` to the specified infoset format Parameters result:Result for writing infoset Exceptions WebServiceException: if there is an error writing the `EndpointReference` to the specified `result`. IllegalArgumentException: If the `null` `result` value is given.

public abstract void writeTo(Result result)

write this EndpointReference to the specified infoset format

Parameters

result:Result: for writing infoset

Exceptions

WebServiceException:: if there is an error writing the EndpointReference to the specified result.
IllegalArgumentException:: If the null result value is given.

public abstract Class EndpointReference

Constructor Summary

Method Summary

Constructor Detail

Method Detail