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 Jakarta XML Web Services 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.
- See Also:
-
Field Summary
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic Endpoint
Creates an endpoint with the specified implementor object.static Endpoint
create
(Object implementor, WebServiceFeature... features) Creates an endpoint with the specified implementor object and web service features.static Endpoint
Creates an endpoint with the specified binding type and implementor object.static Endpoint
create
(String bindingId, Object implementor, WebServiceFeature... features) Creates an endpoint with the specified binding type, implementor object, and web service features.abstract Binding
Returns the binding for this endpoint.abstract <T extends EndpointReference>
TgetEndpointReference
(Class<T> clazz, Element... referenceParameters) Returns theEndpointReference
associated with thisEndpoint
instance.abstract EndpointReference
getEndpointReference
(Element... referenceParameters) Returns theEndpointReference
associated with thisEndpoint
instance.abstract Executor
Returns the executor for thisEndpoint
instance.abstract Object
Returns the implementation object for this endpoint.Returns a list of metadata documents for the service.Returns the property bag for thisEndpoint
instance.abstract boolean
Returns true if the endpoint is in the published state.void
publish
(HttpContext serverContext) Publishes this endpoint at the provided server context.abstract void
Publishes this endpoint at the provided server context.abstract void
Publishes this endpoint at the given address.static Endpoint
Creates and publishes an endpoint for the specified implementor object at the given address.static Endpoint
publish
(String address, Object implementor, WebServiceFeature... features) Creates and publishes an endpoint for the specified implementor object at the given address.void
By setting aEndpointContext
, Jakarta XML Web Services runtime knows about addresses of other endpoints in an application.abstract void
setExecutor
(Executor executor) Sets the executor for thisEndpoint
instance.abstract void
setMetadata
(List<Source> metadata) Sets the metadata for this endpoint.abstract void
setProperties
(Map<String, Object> properties) Sets the property bag for thisEndpoint
instance.abstract void
stop()
Stops publishing this endpoint.
-
Field Details
-
WSDL_SERVICE
Standard property: name of WSDL service.Type: javax.xml.namespace.QName
- See Also:
-
WSDL_PORT
Standard property: name of WSDL port.Type: javax.xml.namespace.QName
- See Also:
-
-
Constructor Details
-
Endpoint
public Endpoint()
-
-
Method Details
-
create
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
publish(String)
andpublish(Object)
methods.- Parameters:
implementor
- The endpoint implementor.- Returns:
- The newly created endpoint.
-
create
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
publish(String)
andpublish(Object)
methods.- Parameters:
implementor
- The endpoint implementor.features
- A list of WebServiceFeature to configure on the endpoint. Supported features not in thefeatures
parameter will have their default values.- Returns:
- The newly created endpoint.
-
create
Creates an endpoint with the specified binding type and implementor object.The newly created endpoint may be published by calling one of the
publish(String)
andpublish(Object)
methods.- Parameters:
bindingId
- A URI specifying the binding to use. If the bindingID isnull
and no binding is specified via a BindingType annotation then a default SOAP 1.1 / HTTP binding MUST be used.implementor
- The endpoint implementor.- Returns:
- The newly created endpoint.
-
create
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
publish(String)
andpublish(Object)
methods.- Parameters:
bindingId
- A URI specifying the binding to use. If the bindingID isnull
and no binding is specified via a BindingType annotation then a default SOAP 1.1 / HTTP binding MUST be used.implementor
- The endpoint implementor.features
- A list of WebServiceFeature to configure on the endpoint. Supported features not in thefeatures
parameter will have their default values.- Returns:
- The newly created endpoint.
-
getBinding
Returns the binding for this endpoint.- Returns:
- The binding for this endpoint
-
getImplementor
Returns the implementation object for this endpoint.- Returns:
- The implementor for this endpoint
-
publish
Publishes this endpoint at the given address. The necessary server infrastructure will be created and configured by the Jakarta XML Web Services implementation using some default configuration. In order to get more control over the server configuration, please use thepublish(Object)
method instead.- Parameters:
address
- A URI specifying the address to use. The address MUST be compatible with the binding specified at the time the endpoint was created.- Throws:
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 ajava.lang.SecurityManger
is being used and the application doesn't have theWebServicePermission("publishEndpoint")
permission.
-
publish
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 Jakarta XML Web Services implementation using some default configuration.
In order to get more control over the server configuration, please use the
create(String,Object)
andpublish(Object)
methods instead.- Parameters:
address
- 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
- The endpoint implementor.- Returns:
- The newly created endpoint.
- Throws:
SecurityException
- If ajava.lang.SecurityManger
is being used and the application doesn't have theWebServicePermission("publishEndpoint")
permission.
-
publish
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 Jakarta XML Web Services implementation using some default configuration.
In order to get more control over the server configuration, please use the
create(String,Object)
andpublish(Object)
methods instead.- Parameters:
address
- 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
- The endpoint implementor.features
- A list of WebServiceFeature to configure on the endpoint. Supported features not in thefeatures
parameter will have their default values.- Returns:
- The newly created endpoint.
- Throws:
SecurityException
- If ajava.lang.SecurityManger
is being used and the application doesn't have theWebServicePermission("publishEndpoint")
permission.
-
publish
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
- An object representing a server context to be used for publishing the endpoint.- Throws:
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 ajava.lang.SecurityManger
is being used and the application doesn't have theWebServicePermission("publishEndpoint")
permission.
-
publish
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 endpoints portably and not intended for the end developers.
- Parameters:
serverContext
- An object representing a server context to be used for publishing the endpoint.- Throws:
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 ajava.lang.SecurityManger
is being used and the application doesn't have theWebServicePermission("publishEndpoint")
permission.
-
stop
public abstract void stop()Stops publishing this endpoint.If the endpoint is not in a published state, this method has no effect.
-
isPublished
public abstract boolean isPublished()Returns true if the endpoint is in the published state.- Returns:
true
if the endpoint is in the published state.
-
getMetadata
Returns a list of metadata documents for the service.- Returns:
List<javax.xml.transform.Source>
A list of metadata documents for the service
-
setMetadata
Sets the metadata for this endpoint.- Parameters:
metadata
- A list of XML document sources containing metadata information for the endpoint (e.g. WSDL or XML Schema documents)- Throws:
IllegalStateException
- If the endpoint has already been published.
-
getExecutor
Returns the executor for thisEndpoint
instance.The executor is used to dispatch an incoming request to the implementor object.
- Returns:
- The
java.util.concurrent.Executor
to be used to dispatch a request. - See Also:
-
setExecutor
Sets the executor for thisEndpoint
instance.The executor is used to dispatch an incoming request to the implementor object.
If this
Endpoint
is published using thepublish(Object)
method and the specified server context defines its own threading behavior, the executor may be ignored.- Parameters:
executor
- Thejava.util.concurrent.Executor
to be used to dispatch a request.- Throws:
SecurityException
- If the instance does not support setting an executor for security reasons (e.g. the necessary permissions are missing).- See Also:
-
getProperties
Returns the property bag for thisEndpoint
instance.- Returns:
- Map<String,Object> The property bag associated with this instance.
-
setProperties
Sets the property bag for thisEndpoint
instance.- Parameters:
properties
- The property bag associated with this instance.
-
getEndpointReference
Returns theEndpointReference
associated with thisEndpoint
instance.If the Binding for this
bindingProvider
is either SOAP1.1/HTTP or SOAP1.2/HTTP, then aW3CEndpointReference
MUST be returned.- Parameters:
referenceParameters
- Reference parameters to be associated with the returnedEndpointReference
instance.- Returns:
- EndpointReference of this
Endpoint
instance. If the returnedEndpointReference
is of typeW3CEndpointReference
then it MUST contain the specifiedreferenceParameters
. - Throws:
WebServiceException
- If any error in the creation of theEndpointReference
or if theEndpoint
is not in the published state.UnsupportedOperationException
- If thisBindingProvider
uses the XML/HTTP binding.- See Also:
-
getEndpointReference
public abstract <T extends EndpointReference> T getEndpointReference(Class<T> clazz, Element... referenceParameters) Returns theEndpointReference
associated with thisEndpoint
instance.- Type Parameters:
T
- The type of EndpointReference.- Parameters:
clazz
- Specifies the type of EndpointReference that MUST be returned.referenceParameters
- Reference parameters to be associated with the returnedEndpointReference
instance.- Returns:
- EndpointReference of type
clazz
of thisEndpoint
instance. If the returnedEndpointReference
is of typeW3CEndpointReference
then it MUST contain the specifiedreferenceParameters
. - Throws:
WebServiceException
- If any error in the creation of theEndpointReference
or if theEndpoint
is not in the published state or if theclazz
is not a supportedEndpointReference
type.UnsupportedOperationException
- If thisBindingProvider
uses the XML/HTTP binding.
-
setEndpointContext
By setting aEndpointContext
, Jakarta XML Web Services 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
- that is shared for multiple endpoints- Throws:
IllegalStateException
- If the endpoint has been published already, or it has been stopped.
-