Top Description Fields Constructors Methods
javax.xml.ws

public abstract Class Endpoint

extends Object
Class Inheritance
Imports
java.util.List, .Map, javax.xml.ws.spi.Provider, javax.xml.ws.spi.http.HttpContext, javax.xml.ws.wsaddressing.W3CEndpointReference, org.w3c.dom.Element
A Web service endpoint.

Endpoints are created using the static methods defined in this class. An endpoint is always tied to one Binding and one implementor, both set at endpoint creation time.

An endpoint is either in a published or an unpublished state. The publish methods can be used to start publishing an endpoint, at which point it starts accepting incoming requests. Conversely, the stop method can be used to stop accepting incoming requests and take the endpoint down. Once stopped, an endpoint cannot be published again.

An Executor may be set on the endpoint in order to gain better control over the threads used to dispatch incoming requests. For instance, thread pooling with certain parameters can be enabled by creating a ThreadPoolExecutor and registering it with the endpoint.

Handler chains can be set using the contained Binding.

An endpoint may have a list of metadata documents, such as WSDL and XMLSchema documents, bound to it. At publishing time, the JAX-WS implementation will try to reuse as much of that metadata as possible instead of generating new ones based on the annotations present on the implementor.

Since
1.6, JAX-WS 2.0
See Also
javax.xml.ws.Binding, javax.xml.ws.BindingType, javax.xml.ws.soap.SOAPBinding, java.util.concurrent.Executor

Field Summary

Modifier and TypeField and Description
public static final String
WSDL_PORT

Standard property: name of WSDL port.

public static final String
WSDL_SERVICE

Standard property: name of WSDL service.

Constructor Summary

AccessConstructor and Description
public
Endpoint()

Method Summary

Modifier and TypeMethod and Description
public static Endpoint

Returns:

The newly created endpoint.
create(Object
The endpoint implementor.
implementor)

Creates an endpoint with the specified implementor object.

public static Endpoint

Returns:

The newly created endpoint.
create(Object
The endpoint implementor.
implementor, WebServiceFeature...
A list of WebServiceFeature to configure on the endpoint. Supported features not in the features parameter will have their default values.
features)

Creates an endpoint with the specified implementor object and web service features.

public static Endpoint

Returns:

The newly created endpoint.
create(String
A URI specifying the binding to use. If the bindingID is null and no binding is specified via a BindingType annotation then a default SOAP 1.1 / HTTP binding MUST be used.
bindingId, Object
The endpoint implementor.
implementor)

Creates an endpoint with the specified binding type and implementor object.

public static Endpoint

Returns:

The newly created endpoint.
create(String
A URI specifying the binding to use. If the bindingID is null and no binding is specified via a BindingType annotation then a default SOAP 1.1 / HTTP binding MUST be used.
bindingId, Object
The endpoint implementor.
implementor, WebServiceFeature...
A list of WebServiceFeature to configure on the endpoint. Supported features not in the features parameter will have their default values.
features)

Creates an endpoint with the specified binding type, implementor object, and web service features.

public abstract Binding

Returns:

The binding for this endpoint
getBinding()

Returns the binding for this endpoint.

public abstract EndpointReference

Returns:

EndpointReference of this Endpoint instance. If the returned EndpointReference is of type W3CEndpointReference then it MUST contain the the specified referenceParameters.
getEndpointReference(Element...
Reference parameters to be associated with the returned EndpointReference instance.
referenceParameters)

Returns the EndpointReference associated with this Endpoint instance.

public abstract <
The type of EndpointReference.
T extends EndpointReference> T

Returns:

EndpointReference of type clazz of this Endpoint instance. If the returned EndpointReference is of type W3CEndpointReference then it MUST contain the the specified referenceParameters.
getEndpointReference(Class<T>
Specifies the type of EndpointReference that MUST be returned.
clazz, Element...
Reference parameters to be associated with the returned EndpointReference instance.
referenceParameters)

Returns the EndpointReference associated with this Endpoint instance.

public abstract Executor

Returns:

The java.util.concurrent.Executor to be used to dispatch a request.
getExecutor()

Returns the executor for this Endpointinstance.

public abstract Object

Returns:

The implementor for this endpoint
getImplementor()

Returns the implementation object for this endpoint.

public abstract List<Source>

Returns:

List<javax.xml.transform.Source> A list of metadata documents for the service
getMetadata()

Returns a list of metadata documents for the service.

public abstract Map<String, Object>

Returns:

Map<String,Object> The property bag associated with this instance.
getProperties()

Returns the property bag for this Endpoint instance.

public abstract boolean

Returns:

true if the endpoint is in the published state.
isPublished()

Returns true if the endpoint is in the published state.

public abstract void
publish(String
A URI specifying the address to use. The address MUST be compatible with the binding specified at the time the endpoint was created.
address)

Publishes this endpoint at the given address.

public static Endpoint

Returns:

The newly created endpoint.
publish(String
A URI specifying the address and transport/protocol to use. A http: URI MUST result in the SOAP 1.1/HTTP binding being used. Implementations may support other URI schemes.
address, Object
The endpoint implementor.
implementor)

Creates and publishes an endpoint for the specified implementor object at the given address.

public static Endpoint

Returns:

The newly created endpoint.
publish(String
A URI specifying the address and transport/protocol to use. A http: URI MUST result in the SOAP 1.1/HTTP binding being used. Implementations may support other URI schemes.
address, Object
The endpoint implementor.
implementor, WebServiceFeature...
A list of WebServiceFeature to configure on the endpoint. Supported features not in the features parameter will have their default values.
features)

Creates and publishes an endpoint for the specified implementor object at the given address.

public abstract void
publish(Object
An object representing a server context to be used for publishing the endpoint.
serverContext)

Publishes this endpoint at the provided server context.

public void
publish(HttpContext
An object representing a server context to be used for publishing the endpoint.
serverContext)

Publishes this endpoint at the provided server context.

public void
setEndpointContext(EndpointContext
that is shared for multiple endpoints
ctxt)

By setting a EndpointContext, JAX-WS runtime knows about addresses of other endpoints in an application.

public abstract void
setExecutor(Executor
The java.util.concurrent.Executor to be used to dispatch a request.
executor)

Sets the executor for this Endpoint instance.

public abstract void
setMetadata(List<Source>
A list of XML document sources containing metadata information for the endpoint (e.g. WSDL or XML Schema documents)
metadata)

Sets the metadata for this endpoint.

public abstract void
setProperties(Map<String, Object>
The property bag associated with this instance.
properties)

Sets the property bag for this Endpoint instance.

public abstract void
stop()

Stops publishing this endpoint.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

WSDL_PORTback to summary
public static final String WSDL_PORT

Standard property: name of WSDL port.

Type: javax.xml.namespace.QName

WSDL_SERVICEback to summary
public static final String WSDL_SERVICE

Standard property: name of WSDL service.

Type: javax.xml.namespace.QName

Constructor Detail

Endpointback to summary
public Endpoint()

Method Detail

createback to summary
public static Endpoint create(Object implementor)

Creates an endpoint with the specified implementor object. If there is a binding specified via a BindingType annotation then it MUST be used else a default of SOAP 1.1 / HTTP binding MUST be used.

The newly created endpoint may be published by calling one of the javax.xml.ws.Endpoint#publish(String) and javax.xml.ws.Endpoint#publish(Object) methods.

Parameters
implementor:Object

The endpoint implementor.

Returns:Endpoint

The newly created endpoint.

createback to summary
public static Endpoint create(Object implementor, WebServiceFeature... features)

Creates an endpoint with the specified implementor object and web service features. If there is a binding specified via a BindingType annotation then it MUST be used else a default of SOAP 1.1 / HTTP binding MUST be used.

The newly created endpoint may be published by calling one of the javax.xml.ws.Endpoint#publish(String) and javax.xml.ws.Endpoint#publish(Object) methods.

Parameters
implementor:Object

The endpoint implementor.

features:WebServiceFeature[]

A list of WebServiceFeature to configure on the endpoint. Supported features not in the features parameter will have their default values.

Returns:Endpoint

The newly created endpoint.

Since
1.7, JAX-WS 2.2
createback to summary
public static Endpoint create(String bindingId, Object implementor)

Creates an endpoint with the specified binding type and implementor object.

The newly created endpoint may be published by calling one of the javax.xml.ws.Endpoint#publish(String) and javax.xml.ws.Endpoint#publish(Object) methods.

Parameters
bindingId:String

A URI specifying the binding to use. If the bindingID is null and no binding is specified via a BindingType annotation then a default SOAP 1.1 / HTTP binding MUST be used.

implementor:Object

The endpoint implementor.

Returns:Endpoint

The newly created endpoint.

createback to summary
public static Endpoint create(String bindingId, Object implementor, WebServiceFeature... features)

Creates an endpoint with the specified binding type, implementor object, and web service features.

The newly created endpoint may be published by calling one of the javax.xml.ws.Endpoint#publish(String) and javax.xml.ws.Endpoint#publish(Object) methods.

Parameters
bindingId:String

A URI specifying the binding to use. If the bindingID is null and no binding is specified via a BindingType annotation then a default SOAP 1.1 / HTTP binding MUST be used.

implementor:Object

The endpoint implementor.

features:WebServiceFeature[]

A list of WebServiceFeature to configure on the endpoint. Supported features not in the features parameter will have their default values.

Returns:Endpoint

The newly created endpoint.

Since
1.7, JAX-WS 2.2
getBindingback to summary
public abstract Binding getBinding()

Returns the binding for this endpoint.

Returns:Binding

The binding for this endpoint

getEndpointReferenceback to summary
public abstract EndpointReference getEndpointReference(Element... referenceParameters)

Returns the EndpointReference associated with this Endpoint instance.

If the Binding for this bindingProvider is either SOAP1.1/HTTP or SOAP1.2/HTTP, then a W3CEndpointReference MUST be returned.

Parameters
referenceParameters:Element[]

Reference parameters to be associated with the returned EndpointReference instance.

Returns:EndpointReference

EndpointReference of this Endpoint instance. If the returned EndpointReference is of type W3CEndpointReference then it MUST contain the the specified referenceParameters.

Exceptions
WebServiceException:
If any error in the creation of the EndpointReference or if the Endpoint is not in the published state.
UnsupportedOperationException:
If this BindingProvider uses the XML/HTTP binding.
Since
1.6, JAX-WS 2.1
See Also
W3CEndpointReference
getEndpointReferenceback to summary
public abstract <T extends EndpointReference> T getEndpointReference(Class<T> clazz, Element... referenceParameters)

Returns the EndpointReference associated with this Endpoint instance.

Parameters
<T>
The type of EndpointReference.
clazz:Class<T>

Specifies the type of EndpointReference that MUST be returned.

referenceParameters:Element[]

Reference parameters to be associated with the returned EndpointReference instance.

Returns:T

EndpointReference of type clazz of this Endpoint instance. If the returned EndpointReference is of type W3CEndpointReference then it MUST contain the the specified referenceParameters.

Exceptions
WebServiceException:
If any error in the creation of the EndpointReference or if the Endpoint is not in the published state or if the clazz is not a supported EndpointReference type.
UnsupportedOperationException:
If this BindingProvider uses the XML/HTTP binding.
Since
1.6, JAX-WS 2.1
getExecutorback to summary
public abstract Executor getExecutor()

Returns the executor for this Endpointinstance. The executor is used to dispatch an incoming request to the implementor object.

Returns:Executor

The java.util.concurrent.Executor to be used to dispatch a request.

See Also
java.util.concurrent.Executor
getImplementorback to summary
public abstract Object getImplementor()

Returns the implementation object for this endpoint.

Returns:Object

The implementor for this endpoint

getMetadataback to summary
public abstract List<Source> getMetadata()

Returns a list of metadata documents for the service.

Returns:List<Source>

List<javax.xml.transform.Source> A list of metadata documents for the service

getPropertiesback to summary
public abstract Map<String, Object> getProperties()

Returns the property bag for this Endpoint instance.

Returns:Map<String, Object>

Map<String,Object> The property bag associated with this instance.

isPublishedback to summary
public abstract boolean isPublished()

Returns true if the endpoint is in the published state.

Returns:boolean

true if the endpoint is in the published state.

publishback to summary
public abstract void publish(String address)

Publishes this endpoint at the given address. The necessary server infrastructure will be created and configured by the JAX-WS implementation using some default configuration. In order to get more control over the server configuration, please use the javax.xml.ws.Endpoint#publish(Object) method instead.

Parameters
address:String

A URI specifying the address to use. The address MUST be compatible with the binding specified at the time the endpoint was created.

Exceptions
IllegalArgumentException:
If the provided address URI is not usable in conjunction with the endpoint's binding.
IllegalStateException:
If the endpoint has been published already or it has been stopped.
SecurityException:
If a java.lang.SecurityManger is being used and the application doesn't have the WebServicePermission("publishEndpoint") permission.
publishback to summary
public static Endpoint publish(String address, Object implementor)

Creates and publishes an endpoint for the specified implementor object at the given address.

The necessary server infrastructure will be created and configured by the JAX-WS implementation using some default configuration. In order to get more control over the server configuration, please use the javax.xml.ws.Endpoint#create(String, Object) and javax.xml.ws.Endpoint#publish(Object) methods instead.

Parameters
address:String

A URI specifying the address and transport/protocol to use. A http: URI MUST result in the SOAP 1.1/HTTP binding being used. Implementations may support other URI schemes.

implementor:Object

The endpoint implementor.

Returns:Endpoint

The newly created endpoint.

Exceptions
SecurityException:
If a java.lang.SecurityManger is being used and the application doesn't have the WebServicePermission("publishEndpoint") permission.
publishback to summary
public static Endpoint publish(String address, Object implementor, WebServiceFeature... features)

Creates and publishes an endpoint for the specified implementor object at the given address. The created endpoint is configured with the web service features.

The necessary server infrastructure will be created and configured by the JAX-WS implementation using some default configuration. In order to get more control over the server configuration, please use the javax.xml.ws.Endpoint#create(String, Object) and javax.xml.ws.Endpoint#publish(Object) methods instead.

Parameters
address:String

A URI specifying the address and transport/protocol to use. A http: URI MUST result in the SOAP 1.1/HTTP binding being used. Implementations may support other URI schemes.

implementor:Object

The endpoint implementor.

features:WebServiceFeature[]

A list of WebServiceFeature to configure on the endpoint. Supported features not in the features parameter will have their default values.

Returns:Endpoint

The newly created endpoint.

Exceptions
SecurityException:
If a java.lang.SecurityManger is being used and the application doesn't have the WebServicePermission("publishEndpoint") permission.
Since
1.7, JAX-WS 2.2
publishback to summary
public abstract void publish(Object serverContext)

Publishes this endpoint at the provided server context. A server context encapsulates the server infrastructure and addressing information for a particular transport. For a call to this method to succeed, the server context passed as an argument to it MUST be compatible with the endpoint's binding.

Parameters
serverContext:Object

An object representing a server context to be used for publishing the endpoint.

Exceptions
IllegalArgumentException:
If the provided server context is not supported by the implementation or turns out to be unusable in conjunction with the endpoint's binding.
IllegalStateException:
If the endpoint has been published already or it has been stopped.
SecurityException:
If a java.lang.SecurityManger is being used and the application doesn't have the WebServicePermission("publishEndpoint") permission.
publishback to summary
public void publish(HttpContext serverContext)

Publishes this endpoint at the provided server context. A server context encapsulates the server infrastructure and addressing information for a particular transport. For a call to this method to succeed, the server context passed as an argument to it MUST be compatible with the endpoint's binding.

This is meant for container developers to publish the the endpoints portably and not intended for the end developers.

Parameters
serverContext:HttpContext

An object representing a server context to be used for publishing the endpoint.

Exceptions
IllegalArgumentException:
If the provided server context is not supported by the implementation or turns out to be unusable in conjunction with the endpoint's binding.
IllegalStateException:
If the endpoint has been published already or it has been stopped.
SecurityException:
If a java.lang.SecurityManger is being used and the application doesn't have the WebServicePermission("publishEndpoint") permission.
Since
1.7, JAX-WS 2.2
setEndpointContextback to summary
public void setEndpointContext(EndpointContext ctxt)

By setting a EndpointContext, JAX-WS runtime knows about addresses of other endpoints in an application. If multiple endpoints share different ports of a WSDL, then the multiple port addresses are patched when the WSDL is accessed.

This needs to be set before publishing the endpoints.

Parameters
ctxt:EndpointContext

that is shared for multiple endpoints

Exceptions
IllegalStateException:
If the endpoint has been published already or it has been stopped.
Since
1.7, JAX-WS 2.2
setExecutorback to summary
public abstract void setExecutor(Executor executor)

Sets the executor for this Endpoint instance. The executor is used to dispatch an incoming request to the implementor object. If this Endpoint is published using the publish(Object) method and the specified server context defines its own threading behavior, the executor may be ignored.

Parameters
executor:Executor

The java.util.concurrent.Executor to be used to dispatch a request.

Exceptions
SecurityException:
If the instance does not support setting an executor for security reasons (e.g. the necessary permissions are missing).
See Also
java.util.concurrent.Executor
setMetadataback to summary
public abstract void setMetadata(List<Source> metadata)

Sets the metadata for this endpoint.

Parameters
metadata:List<Source>

A list of XML document sources containing metadata information for the endpoint (e.g. WSDL or XML Schema documents)

Exceptions
IllegalStateException:
If the endpoint has already been published.
setPropertiesback to summary
public abstract void setProperties(Map<String, Object> properties)

Sets the property bag for this Endpoint instance.

Parameters
properties:Map<String, Object>

The property bag associated with this instance.

stopback to summary
public abstract void stop()

Stops publishing this endpoint. If the endpoint is not in a published state, this method has no effect.