|
Java EE 5 SDK | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object javax.xml.ws.spi.ServiceDelegate
public abstract class ServiceDelegate
Service delegates are used internally by Service
objects
to allow pluggability of JAX-WS implementations.
Every Service
object has its own delegate, created using
the javax.xml.ws.Provider#createServiceDelegate method. A Service
object delegates all of its instance methods to its delegate.
Service
,
Provider
Constructor Summary | |
---|---|
protected |
ServiceDelegate()
|
Method Summary | ||
---|---|---|
abstract void |
addPort(QName portName,
String bindingId,
String endpointAddress)
Creates a new port for the service. |
|
abstract
|
createDispatch(QName portName,
Class<T> type,
Service.Mode mode)
Creates a Dispatch instance for use with objects of
the users choosing. |
|
abstract Dispatch<Object> |
createDispatch(QName portName,
JAXBContext context,
Service.Mode mode)
Creates a Dispatch instance for use with JAXB
generated objects. |
|
abstract Executor |
getExecutor()
Returns the executor for this Service instance. |
|
abstract HandlerResolver |
getHandlerResolver()
Returns the configured handler resolver. |
|
abstract
|
getPort(Class<T> serviceEndpointInterface)
The getPort method returns a stub. |
|
abstract
|
getPort(QName portName,
Class<T> serviceEndpointInterface)
The getPort method returns a stub. |
|
abstract Iterator<QName> |
getPorts()
Returns an Iterator for the list of
QName s of service endpoints grouped by this
service |
|
abstract QName |
getServiceName()
Gets the name of this service. |
|
abstract URL |
getWSDLDocumentLocation()
Gets the location of the WSDL document for this Service. |
|
abstract void |
setExecutor(Executor executor)
Sets the executor for this Service instance. |
|
abstract void |
setHandlerResolver(HandlerResolver handlerResolver)
Sets the HandlerResolver for this Service
instance. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
protected ServiceDelegate()
Method Detail |
---|
public abstract <T> T getPort(QName portName, Class<T> serviceEndpointInterface)
serviceEndpointInterface
specifies the service endpoint interface that is supported by
the created dynamic proxy or stub instance.
portName
- Qualified name of the service endpoint in
the WSDL service descriptionserviceEndpointInterface
- Service endpoint interface
supported by the dynamic proxy or stub
instance
WebServiceException
- This exception is thrown in the
following cases:
serviceEndpointInterface
or portName
is specified
Proxy
,
InvocationHandler
public abstract <T> T getPort(Class<T> serviceEndpointInterface)
serviceEndpointInterface
specifies the service
endpoint interface that is supported 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.
The returned proxy should not be reconfigured by the client.
serviceEndpointInterface
- Service endpoint interface
WebServiceException
- serviceEndpointInterface
is specified
public abstract void addPort(QName portName, String bindingId, String endpointAddress)
Dispatch
instances.
portName
- Qualified name for the target service endpointbindingId
- A URI identifier of a binding.endpointAddress
- Address of the target service endpoint as a URI
WebServiceException
- If any error in the creation of
the portSOAPBinding.SOAP11HTTP_BINDING
,
SOAPBinding.SOAP12HTTP_BINDING
,
HTTPBinding.HTTP_BINDING
public abstract <T> Dispatch<T> createDispatch(QName portName, Class<T> type, Service.Mode mode)
Dispatch
instance for use with objects of
the users choosing.
portName
- Qualified name for the target service endpointtype
- The class of object used to messages or message
payloads. Implementations are required to support
javax.xml.transform.Source and javax.xml.soap.SOAPMessage.mode
- Controls whether the created dispatch instance is message
or payload oriented, i.e. whether the user will work with complete
protocol messages or message payloads. E.g. when using the SOAP
protocol, this parameter controls whether the user will work with
SOAP messages or the contents of a SOAP body. Mode must be MESSAGE
when type is SOAPMessage.
WebServiceException
- If any error in the creation of
the Dispatch
objectSource
,
SOAPMessage
public abstract Dispatch<Object> createDispatch(QName portName, JAXBContext context, Service.Mode mode)
Dispatch
instance for use with JAXB
generated objects.
portName
- Qualified name for the target service endpointcontext
- The JAXB context used to marshall and unmarshall
messages or message payloads.mode
- Controls whether the created dispatch instance is message
or payload oriented, i.e. whether the user will work with complete
protocol messages or message payloads. E.g. when using the SOAP
protocol, this parameter controls whether the user will work with
SOAP messages or the contents of a SOAP body.
ServiceException
- If any error in the creation of
the Dispatch
objectJAXBContext
public abstract QName getServiceName()
public abstract Iterator<QName> getPorts()
Iterator
for the list of
QName
s of service endpoints grouped by this
service
java.util.Iterator
with elements
of type javax.xml.namespace.QName
WebServiceException
- If this Service class does not
have access to the required WSDL metadatapublic abstract URL getWSDLDocumentLocation()
public abstract HandlerResolver getHandlerResolver()
HandlerResolver
being
used by this Service
instance, or null
if there isn't one.public abstract void setHandlerResolver(HandlerResolver handlerResolver)
HandlerResolver
for this Service
instance.
The handler resolver, if present, will be called once for each proxy or dispatch instance that is created, and the handler chain returned by the resolver will be set on the instance.
handlerResolver
- The HandlerResolver
to use
for all subsequently created proxy/dispatch objects.HandlerResolver
public abstract Executor getExecutor()
Service
instance.
The executor is used for all asynchronous invocations that
require callbacks.
java.util.concurrent.Executor
to be
used to invoke a callback.Executor
public abstract void setExecutor(Executor executor)
Service
instance.
The executor is used for all asynchronous invocations that
require callbacks.
executor
- The java.util.concurrent.Executor
to be used to invoke a callback.
SecurityException
- If the instance does not support
setting an executor for security reasons (e.g. the
necessary permissions are missing).Executor
|
Java EE 5 SDK | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright 2007 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms.