| |
|
| java.lang.Object
 javax.xml.ws.Endpoint
| Endpoint | | abstract public class Endpoint (Code) | | 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 one based on the annotations
present on the implementor.
since:
JAX-WS 2.0
See Also: javax.xml.ws.Binding
See Also: javax.xml.ws.BindingType
See Also: javax.xml.ws.soap.SOAPBinding
See Also: java.util.concurrent.Executor |
| Field Summary | |
| final public static String | WSDL_PORT
Standard property: name of WSDL port. | | final public static String | WSDL_SERVICE
Standard property: name of WSDL service. |
| Method Summary | |
| public static Endpoint | create(Object implementor)
Creates an endpoint with the specified implementor object. | | 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 - A URI specifying the binding to use. | | abstract public Binding | getBinding()
Returns the binding for this endpoint. | | abstract public java.util.concurrent.Executor | getExecutor()
Returns the executor for this Endpointinstance. | | abstract public Object | getImplementor()
Returns the implementation object for this endpoint. | | abstract public List<javax.xml.transform.Source> | getMetadata()
Returns a list of metadata documents for the service. | | abstract public Map<String, Object> | getProperties()
Returns the property bag for this Endpoint instance. | | abstract public boolean | isPublished()
Returns true if the endpoint is in the published state. | | abstract public 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 - A URI specifying the address to use. | | 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) method instead.
Parameters:
address - A URI specifying the address and transport/protocolto use. | | abstract public void | publish(Object serverContext)
Publishes this endpoint at the provided server context. | | abstract public void | setExecutor(java.util.concurrent.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 - The java.util.concurrent.Executorto be used to dispatch a request.
throws:
SecurityException - If the instance does not supportsetting an executor for security reasons (e.g. | | abstract public void | setMetadata(List<javax.xml.transform.Source> metadata)
Sets the metadata for this endpoint. | | abstract public void | setProperties(Map<String, Object> properties)
Sets the property bag for this Endpoint instance. | | abstract public void | stop()
Stops publishing this endpoint. |
| WSDL_PORT | | final public static String WSDL_PORT(Code) | | Standard property: name of WSDL port.
Type: javax.xml.namespace.QName
|
| WSDL_SERVICE | | final public static String WSDL_SERVICE(Code) | | Standard property: name of WSDL service.
Type: javax.xml.namespace.QName
|
| create | | public static Endpoint create(Object implementor)(Code) | | 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 - The endpoint implementor. The newly created endpoint. |
| create | | public static Endpoint create(String bindingId, Object implementor)(Code) | | 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 - 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.
Parameters:
implementor - The endpoint implementor. The newly created endpoint. |
| getBinding | | abstract public Binding getBinding()(Code) | | Returns the binding for this endpoint.
The binding for this endpoint |
| getImplementor | | abstract public Object getImplementor()(Code) | | Returns the implementation object for this endpoint.
The implementor for this endpoint |
| getMetadata | | abstract public List<javax.xml.transform.Source> getMetadata()(Code) | | Returns a list of metadata documents for the service.
List<javax.xml.transform.Source> A list of metadata documents for the service |
| getProperties | | abstract public Map<String, Object> getProperties()(Code) | | Returns the property bag for this Endpoint instance.
Map<String,Object> The property bagassociated with this instance. |
| isPublished | | abstract public boolean isPublished()(Code) | | Returns true if the endpoint is in the published state.
true if the endpoint is in the published state. |
| publish | | abstract public void publish(String address)(Code) | | 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 - A URI specifying the address to use. The addressmust be compatible with the binding specified at thetime the endpoint was created.
throws:
java.lang.IllegalArgumentException - If the provided address URI is not usablein conjunction with the endpoint's binding.
throws:
java.lang.IllegalStateException - If the endpoint has been published already or it has been stopped. |
| publish | | public static Endpoint publish(String address, Object implementor)(Code) | | 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) method instead.
Parameters:
address - A URI specifying the address and transport/protocolto use. A http: URI must result in the SOAP 1.1/HTTPbinding being used. Implementations may support otherURI schemes.
Parameters:
implementor - The endpoint implementor. The newly created endpoint. |
| publish | | abstract public void publish(Object serverContext)(Code) | | 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 servercontext to be used for publishing the endpoint.
throws:
java.lang.IllegalArgumentException - If the provided server context is notsupported by the implementation or turnsout to be unusable in conjunction with theendpoint's binding.
throws:
java.lang.IllegalStateException - If the endpoint has been published already or it has been stopped. |
| setExecutor | | abstract public void setExecutor(java.util.concurrent.Executor executor)(Code) | | 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 - The java.util.concurrent.Executorto be used to dispatch a request.
throws:
SecurityException - If the instance does not supportsetting an executor for security reasons (e.g. thenecessary permissions are missing).
See Also: java.util.concurrent.Executor |
| setMetadata | | abstract public void setMetadata(List<javax.xml.transform.Source> metadata)(Code) | | Sets the metadata for this endpoint.
Parameters:
metadata - A list of XML document sources containingmetadata information for the endpoint (e.g.WSDL or XML Schema documents)
throws:
java.lang.IllegalStateException - If the endpointhas already been published. |
| setProperties | | abstract public void setProperties(Map<String, Object> properties)(Code) | | Sets the property bag for this Endpoint instance.
Parameters:
properties - The property bag associated withthis instance. |
| stop | | abstract public void stop()(Code) | | Stops publishing this endpoint.
If the endpoint is not in a published state, this method
has not effect.
|
|
|
|