Service (Java EE 5 SDK)

The ports available on a service can be enumerated using the getPorts method. Alternatively, you can pass a service endpoint interface to the unary getPort method and let the runtime select a compatible port.

Handler chains for all the objects created by a Service can be set by means of a HandlerResolver.

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

从以下版本开始:: JAX-WS 2.0
另请参见:: Provider, HandlerResolver, Executor

嵌套类摘要
`static class`	`Service.Mode` The orientation of a dynamic client or service.

构造器摘要
`protected`	`Service(URL wsdlDocumentLocation, QName serviceName)`

方法摘要

void addPort(QName portName, String bindingId, String endpointAddress)
Creates a new port for the service.

static Service create(QName serviceName)
Create a Service instance.

static Service create(URL wsdlDocumentLocation, QName serviceName)
Create a Service instance.

<T> Dispatch<T>

createDispatch(QName portName,
               Class<T> type,
               Service.Mode mode)

Dispatch

Dispatch<Object>

createDispatch(QName portName,
               JAXBContext context,
               Service.Mode mode)

Dispatch

Executor

getExecutor()

Service

HandlerResolver

getHandlerResolver()

<T> T

getPort(Class<T> serviceEndpointInterface)

<T> T

getPort(QName portName,
        Class<T> serviceEndpointInterface)

Iterator<QName>

getPorts()

Iterator

QName

getServiceName()

URL

getWSDLDocumentLocation()

void

setExecutor(Executor executor)

Service

void

setHandlerResolver(HandlerResolver handlerResolver)

HandlerResolver

Service

类方法继承 java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

构造器详细信息

Service

protected Service(URL wsdlDocumentLocation,
                  QName serviceName)

方法详细信息

getPort

public <T> T getPort(QName portName,
                     Class<T> serviceEndpointInterface)

The getPort method returns a stub. A service client uses this stub to invoke operations on the target service endpoint. The 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 description

serviceEndpointInterface - Service endpoint interface supported by the dynamic proxy or stub instance

返回:

Object Proxy instance that supports the specified service endpoint interface

抛出异常:

WebServiceException - This exception is thrown in the following cases:

If there is an error in creation of the proxy
If there is any missing WSDL metadata as required by this method
Optionally, if an illegal serviceEndpointInterface or portName is specified

另请参见:

Proxy, InvocationHandler

getPort

public <T> T getPort(Class<T> serviceEndpointInterface)

The getPort method returns a stub. The parameter 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

返回:

Object instance that supports the specified service endpoint interface

抛出异常:

WebServiceException -

If there is an error during creation of the proxy
If there is any missing WSDL metadata as required by this method
Optionally, if an illegal serviceEndpointInterface is specified

addPort

public void addPort(QName portName,
                    String bindingId,
                    String endpointAddress)

Creates a new port for the service. Ports created in this way contain no WSDL port type information and can only be used for creating Dispatchinstances.

参数:: portName - Qualified name for the target service endpoint; bindingId - A String identifier of a binding.; endpointAddress - Address of the target service endpoint as a URI
抛出异常:: WebServiceException - If any error in the creation of the port
另请参见:: SOAPBinding.SOAP11HTTP_BINDING, SOAPBinding.SOAP12HTTP_BINDING, HTTPBinding.HTTP_BINDING

createDispatch

public <T> Dispatch<T> createDispatch(QName portName,
                                      Class<T> type,
                                      Service.Mode mode)

Creates a Dispatch instance for use with objects of the users choosing.

参数:: portName - Qualified name for the target service endpoint; type - 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.
返回:: Dispatch instance
抛出异常:: WebServiceException - If any error in the creation of the Dispatch object
另请参见:: Source, SOAPMessage

createDispatch

public Dispatch<Object> createDispatch(QName portName,
                                       JAXBContext context,
                                       Service.Mode mode)

Creates a Dispatch instance for use with JAXB generated objects.

参数:: portName - Qualified name for the target service endpoint; context - 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.
返回:: Dispatch instance
抛出异常:: ServiceException - If any error in the creation of the Dispatch object
另请参见:: JAXBContext

getServiceName

public QName getServiceName()

Gets the name of this service.

返回:: Qualified name of this service

getPorts

public Iterator<QName> getPorts()

Returns an Iterator for the list of QNames of service endpoints grouped by this service

返回:: Returns java.util.Iterator with elements of type javax.xml.namespace.QName
抛出异常:: WebServiceException - If this Service class does not have access to the required WSDL metadata

getWSDLDocumentLocation

public URL getWSDLDocumentLocation()

Gets the location of the WSDL document for this Service.

返回:: URL for the location of the WSDL document for this service

getHandlerResolver

public HandlerResolver getHandlerResolver()

Returns the configured handler resolver.

返回:: HandlerResolver The HandlerResolver being used by this Service instance, or null if there isn't one.

setHandlerResolver

public void setHandlerResolver(HandlerResolver handlerResolver)

Sets the 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

getExecutor

public Executor getExecutor()

Returns the executor for this Serviceinstance. The executor is used for all asynchronous invocations that require callbacks.

返回:: The java.util.concurrent.Executor to be used to invoke a callback.
另请参见:: Executor

setExecutor

public void setExecutor(Executor executor)

Sets the executor for this 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

create

public static Service create(URL wsdlDocumentLocation,
                             QName serviceName)

Create a Service instance. The specified WSDL document location and service qualified name must uniquely identify a wsdl:service element.

参数:: wsdlDocumentLocation - URL for the WSDL document location for the service; serviceName - QName for the service
抛出异常:: WebServiceException - If any error in creation of the specified service

create

public static Service create(QName serviceName)

Create a Service instance.

参数:: serviceName - QName for the service
抛出异常:: WebServiceException - If any error in creation of the specified service

概述

软件包

类

树

已过时

索引

帮助

Java EE 5 SDK

深圳电信培训中心.徐海蛟老师.

上一个类 下一个类

框架 无框架

摘要: NESTED | 字段 | 构造器 | 方法

详细信息: 字段 | 构造器 | 方法

提交错误或意见

previous page start next page