Spec-Zone .ru
спецификации, руководства, описания, API
|
public class Service extends Object
Service
объекты обеспечивают клиентское представление Веб-сервиса. Service
действия как фабрика следующего:
Dispatch
для динамического ориентированного на сообщение вызова удаленной работы. Порты, доступные на службе, могут быть перечислены, используя getPorts
метод. Альтернативно, можно передать интерфейс конечной точки службы к унарному getPort
метод и позволял времени выполнения выбирать совместимый порт.
Цепочки обработчика для всех объектов создаются a Service
может быть установлен посредством a HandlerResolver
.
Executor
может быть установлен на службе, чтобы получить лучший контроль над потоками, используемыми, чтобы диспетчеризировать асинхронные обратные вызовы. Например, объединение в пул потока с определенными параметрами может быть включено, создавая a ThreadPoolExecutor
и регистрация этого со службой.
Provider
, HandlerResolver
, Executor
Модификатор и Тип | Класс и Описание |
---|---|
static class |
Служба. Режим
Ориентация динамического клиента или службы.
|
Модификатор | Конструктор и Описание |
---|---|
protected |
Service(URL wsdlDocumentLocation, QName serviceName) |
protected |
Service(URL wsdlDocumentLocation, QName serviceName, WebServiceFeature... features) |
Модификатор и Тип | Метод и Описание |
---|---|
void |
addPort(QName portName, String bindingId, String endpointAddress)
Создает новый порт для службы.
|
static Service |
create(QName serviceName)
Создает a
Service экземпляр. |
static Service |
create(QName serviceName, WebServiceFeature... features)
Создает a
Service экземпляр. |
static Service |
create(URL wsdlDocumentLocation, QName serviceName)
Создает a
Service экземпляр. |
static Service |
create(URL wsdlDocumentLocation, QName serviceName, WebServiceFeature... features)
Создает a
Service экземпляр. |
<T> Dispatch<T> |
createDispatch(EndpointReference endpointReference, Class<T> type, Service.Mode mode, WebServiceFeature... features)
Создает a
Dispatch экземпляр для использования с объектами выбора клиента. |
Dispatch<Object> |
createDispatch(EndpointReference endpointReference, JAXBContext context, Service.Mode mode, WebServiceFeature... features)
Создает a
Dispatch экземпляр для использования с JAXB сгенерированные объекты. |
<T> Dispatch<T> |
createDispatch(QName portName, Class<T> type, Service.Mode mode)
Создает a
Dispatch экземпляр для использования с объектами выбора клиента. |
<T> Dispatch<T> |
createDispatch(QName portName, Class<T> type, Service.Mode mode, WebServiceFeature... features)
Создает a
Dispatch экземпляр для использования с объектами выбора клиента. |
Dispatch<Object> |
createDispatch(QName portName, JAXBContext context, Service.Mode mode)
Создает a
Dispatch экземпляр для использования с JAXB сгенерированные объекты. |
Dispatch<Object> |
createDispatch(QName portName, JAXBContext context, Service.Mode mode, WebServiceFeature... features)
Создает a
Dispatch экземпляр для использования с JAXB сгенерированные объекты. |
Исполнитель |
getExecutor()
Возвращает исполнителя для этого
Service экземпляр. |
HandlerResolver |
getHandlerResolver()
Возвращает сконфигурированный преобразователь обработчика.
|
<T> T |
getPort(Class<T> serviceEndpointInterface)
getPort метод возвращает прокси. |
<T> T |
getPort(Class<T> serviceEndpointInterface, WebServiceFeature... features)
getPort метод возвращает прокси. |
<T> T |
getPort(EndpointReference endpointReference, Class<T> serviceEndpointInterface, WebServiceFeature... features)
getPort метод возвращает прокси. |
<T> T |
getPort(QName portName, Class<T> serviceEndpointInterface)
getPort метод возвращает прокси. |
<T> T |
getPort(QName portName, Class<T> serviceEndpointInterface, WebServiceFeature... features)
getPort метод возвращает прокси. |
Iterator<QName> |
getPorts()
Возвраты
Iterator для списка QName s конечных точек службы сгруппировался этой службой |
QName |
getServiceName()
Получает имя этой службы.
|
URL |
getWSDLDocumentLocation()
Получает расположение документа WSDL для этой Службы.
|
void |
setExecutor(Executor executor)
Устанавливает исполнителя для этого
Service экземпляр. |
void |
setHandlerResolver(HandlerResolver handlerResolver)
Наборы
HandlerResolver для этого Service экземпляр. |
protected Service(URL wsdlDocumentLocation, QName serviceName, WebServiceFeature... features)
public <T> T getPort(QName portName, Class<T> serviceEndpointInterface)
getPort
метод возвращает прокси. Клиент службы использует этот прокси, чтобы вызвать операции на целевую конечную точку службы. serviceEndpointInterface
определяет интерфейс конечной точки службы, который поддерживается создаваемым динамическим экземпляром прокси.portName
- Полностью определенное имя конечной точки службы в описании службы WSDL.serviceEndpointInterface
- Интерфейс конечной точки службы поддерживается динамическим экземпляром прокси.WebServiceException
- Это исключение выдается в следующих случаях: serviceEndpointInterface
или portName
определяется. Proxy
, InvocationHandler
public <T> T getPort(QName portName, Class<T> serviceEndpointInterface, WebServiceFeature... features)
getPort
метод возвращает прокси. Клиент службы использует этот прокси, чтобы вызвать операции на целевую конечную точку службы. serviceEndpointInterface
определяет интерфейс конечной точки службы, который поддерживается создаваемым динамическим экземпляром прокси.portName
- Полностью определенное имя конечной точки службы в описании службы WSDL.serviceEndpointInterface
- Интерфейс конечной точки службы поддерживается динамическим экземпляром прокси.features
- Список WebServiceFeatures, чтобы сконфигурировать на прокси. Поддерживавшие функции не в features
у параметра будут их значения по умолчанию.WebServiceException
- Это исключение выдается в следующих случаях: serviceEndpointInterface
или portName
определяется. Proxy
, InvocationHandler
, WebServiceFeature
public <T> T getPort(Class<T> serviceEndpointInterface)
getPort
метод возвращает прокси. Параметр serviceEndpointInterface
определяет интерфейс конечной точки службы, который поддерживается возвращенным прокси. В реализации этого метода система времени выполнения JAX-WS берет на себя ответственность выбора привязки протокола (и порт) и конфигурирование прокси соответственно. Возвращенный прокси не должен быть реконфигурирован клиентом.serviceEndpointInterface
- Интерфейс конечной точки службы.WebServiceException
- serviceEndpointInterface
определяется. public <T> T getPort(Class<T> serviceEndpointInterface, WebServiceFeature... features)
getPort
метод возвращает прокси. Параметр serviceEndpointInterface
определяет интерфейс конечной точки службы, который поддерживается возвращенным прокси. В реализации этого метода система времени выполнения JAX-WS берет на себя ответственность выбора привязки протокола (и порт) и конфигурирование прокси соответственно. Возвращенный прокси не должен быть реконфигурирован клиентом.serviceEndpointInterface
- Интерфейс конечной точки службы.features
- Список WebServiceFeatures, чтобы сконфигурировать на прокси. Поддерживавшие функции не в features
у параметра будут их значения по умолчанию.WebServiceException
- serviceEndpointInterface
определяется. WebServiceFeature
public <T> T getPort(EndpointReference endpointReference, Class<T> serviceEndpointInterface, WebServiceFeature... features)
getPort
метод возвращает прокси. Параметр endpointReference
определяет конечную точку, которая будет вызвана возвращенным прокси. Если есть какие-либо ссылочные параметры в endpointReference
, тогда те ссылочные параметры ДОЛЖНЫ появиться как заголовки SOAP, указывая на них, чтобы быть ссылочными параметрами, на всех сообщениях, отправленных конечной точке. endpointReference's
адрес ДОЛЖЕН использоваться для вызовов на конечной точке. Параметр serviceEndpointInterface
определяет интерфейс конечной точки службы, который поддерживается возвращенным прокси. В реализации этого метода система времени выполнения JAX-WS берет на себя ответственность выбора привязки протокола (и порт) и конфигурирование прокси соответственно от WSDL, связанного с этим Service
экземпляр или от метаданных от endpointReference
. Если это Service
у экземпляра есть WSDL и endpointReference
у метаданных также есть WSDL, тогда WSDL от этого экземпляра ДОЛЖЕН использоваться. Если это Service
у экземпляра нет WSDL и endpointReference
действительно имеет WSDL, тогда WSDL от endpointReference
МОЖЕТ использоваться. Возвращенный прокси не должен быть реконфигурирован клиентом. Если это Service
у экземпляра есть известный порт прокси, который соответствует информацию, содержавшуюся в WSDL, тогда тот прокси возвращается, иначе WebServiceException бросается. У вызова этого метода есть то же самое поведение как следующий
port = service.getPort(portName, serviceEndpointInterface);
где portName
получается от метаданных endpointReference
или от serviceEndpointInterface
и WSDL связался с этим Service
экземпляр.endpointReference
- EndpointReference
для целевой конечной точки службы, которая будет вызвана возвращенным прокси.serviceEndpointInterface
- Интерфейс конечной точки службы.features
- Список WebServiceFeatures
сконфигурировать на прокси. Поддерживавшие функции не в features
у параметра будут их значения по умолчанию.WebServiceException
- endpointReference
метаданные не соответствуют serviceName
из этого Service
экземпляр. portName
не может быть извлечен из WSDL или endpointReference
метаданные. endpointReference
определяется. serviceEndpointInterface
определяется. public void addPort(QName portName, String bindingId, String endpointAddress)
Dispatch
экземпляры.portName
- Полностью определенное имя для целевой конечной точки службы.bindingId
- Строковый идентификатор привязки.endpointAddress
- Адрес целевой конечной точки службы как URI.WebServiceException
- Если любая ошибка в создании порта.SOAPBinding.SOAP11HTTP_BINDING
, SOAPBinding.SOAP12HTTP_BINDING
, HTTPBinding.HTTP_BINDING
public <T> Dispatch<T> createDispatch(QName portName, Class<T> type, Service.Mode mode)
Dispatch
экземпляр для использования с объектами выбора клиента.portName
- Полностью определенное имя для целевой конечной точки службыtype
- class объекта, используемого для сообщений или полезных нагрузок сообщения. Реализации обязаны поддерживать javax.xml.transform.Source
, javax.xml.soap.SOAPMessage
и javax.activation.DataSource
, В зависимости от привязки в использовании.mode
- Средства управления, диспетчеризируют ли создаваемые экземпляр, являются сообщением или полезной нагрузкой, ориентированной, то есть будет ли клиент работать с полными сообщениями протокола или передавать полезные нагрузки. Например, при использовании протокола SOAP, этот параметр управляет, будет ли клиент работать с сообщениями SOAP или содержанием тела SOAP. Режим ДОЛЖЕН быть СООБЩЕНИЕМ, когда тип является SOAPMessage.WebServiceException
- Если любая ошибка в создании Dispatch
объект.Source
, SOAPMessage
public <T> Dispatch<T> createDispatch(QName portName, Class<T> type, Service.Mode mode, WebServiceFeature... features)
Dispatch
экземпляр для использования с объектами выбора клиента.portName
- Полностью определенное имя для целевой конечной точки службыtype
- class объекта, используемого для сообщений или полезных нагрузок сообщения. Реализации обязаны поддерживать javax.xml.transform.Source
и javax.xml.soap.SOAPMessage
.mode
- Средства управления, диспетчеризируют ли создаваемые экземпляр, являются сообщением или полезной нагрузкой, ориентированной, то есть будет ли клиент работать с полными сообщениями протокола или передавать полезные нагрузки. Например, при использовании протокола SOAP, этот параметр управляет, будет ли клиент работать с сообщениями SOAP или содержанием тела SOAP. Режим ДОЛЖЕН быть MESSAGE
когда тип SOAPMessage
.features
- Список WebServiceFeatures
сконфигурировать на прокси. Поддерживавшие функции не в features
у параметра будут их значения по умолчанию.WebServiceException
- Если любая ошибка в создании Dispatch
возразите или если опция активируется, который не совместимый с этим портом или неподдерживается.Source
, SOAPMessage
, WebServiceFeature
public <T> Dispatch<T> createDispatch(EndpointReference endpointReference, Class<T> type, Service.Mode mode, WebServiceFeature... features)
Dispatch
экземпляр для использования с объектами выбора клиента. Если есть какие-либо ссылочные параметры в endpointReference
, тогда те ссылочные параметры ДОЛЖНЫ появиться как заголовки SOAP, указывая на них, чтобы быть ссылочными параметрами, на всех сообщениях, отправленных конечной точке. endpointReference's
адрес ДОЛЖЕН использоваться для вызовов на конечной точке. В реализации этого метода система времени выполнения JAX-WS берет на себя ответственность выбора привязки протокола (и порт) и конфигурирование диспетчеризирования соответственно от WSDL, связанного с этим Service
экземпляр или от метаданных от endpointReference
. Если это Service
у экземпляра есть WSDL и endpointReference
также имеет WSDL в его метаданных, тогда WSDL от этого экземпляра ДОЛЖЕН использоваться. Если это Service
у экземпляра нет WSDL и endpointReference
действительно имеет WSDL, тогда WSDL от endpointReference
МОЖЕТ использоваться. Реализация ДОЛЖНА быть в состоянии получить portName
от endpointReference
метаданные. Этот метод ведет себя то же самое как вызов
dispatch = service.createDispatch(portName, type, mode, features);
где portName
получается от WSDL или EndpointReference
метаданные.endpointReference
- EndpointReference
для целевой конечной точки службы, которая будет вызвана возвращенным Dispatch
объект.type
- class объекта, привыкшего к сообщениям или полезным нагрузкам сообщения. Реализации обязаны поддерживать javax.xml.transform.Source
и javax.xml.soap.SOAPMessage
.mode
- Средства управления, диспетчеризируют ли создаваемые экземпляр, являются сообщением или полезной нагрузкой, ориентированной, то есть будет ли клиент работать с полными сообщениями протокола или передавать полезные нагрузки. Например, при использовании протокола SOAP, этот параметр управляет, будет ли клиент работать с сообщениями SOAP или содержанием тела SOAP. Режим ДОЛЖЕН быть MESSAGE
когда тип SOAPMessage
.features
- Массив WebServiceFeatures
сконфигурировать на прокси. Поддерживавшие функции не в features
у параметра будут их значения по умолчанию.WebServiceException
- endpointReference
метаданные не соответствуют serviceName
или portName
из WSDL, связанного с этим Service
экземпляр. portName
не может быть определен от EndpointReference
метаданные. Dispatch
объект. Source
, SOAPMessage
, WebServiceFeature
public Dispatch<Object> createDispatch(QName portName, JAXBContext context, Service.Mode mode)
Dispatch
экземпляр для использования с JAXB сгенерированные объекты.portName
- Полностью определенное имя для целевой конечной точки службыcontext
- Контекст JAXB, привыкший к маршальским и немаршальским сообщениям или полезным нагрузкам сообщения.mode
- Средства управления, диспетчеризируют ли создаваемые экземпляр, являются сообщением или полезной нагрузкой, ориентированной, то есть будет ли клиент работать с полными сообщениями протокола или передавать полезные нагрузки. Например, при использовании протокола SOAP, этот параметр управляет, будет ли клиент работать с сообщениями SOAP или содержанием тела SOAP.WebServiceException
- Если любая ошибка в создании Dispatch
объект.JAXBContext
public Dispatch<Object> createDispatch(QName portName, JAXBContext context, Service.Mode mode, WebServiceFeature... features)
Dispatch
экземпляр для использования с JAXB сгенерированные объекты.portName
- Полностью определенное имя для целевой конечной точки службыcontext
- Контекст JAXB, привыкший к маршальским и немаршальским сообщениям или полезным нагрузкам сообщения.mode
- Средства управления, диспетчеризируют ли создаваемые экземпляр, являются сообщением или полезной нагрузкой, ориентированной, то есть будет ли клиент работать с полными сообщениями протокола или передавать полезные нагрузки. Например, при использовании протокола SOAP, этот параметр управляет, будет ли клиент работать с сообщениями SOAP или содержанием тела SOAP.features
- Список WebServiceFeatures
сконфигурировать на прокси. Поддерживавшие функции не в features
у параметра будут их значения по умолчанию.WebServiceException
- Если любая ошибка в создании Dispatch
возразите или если опция активируется, который не совместимый с этим портом или неподдерживается.JAXBContext
, WebServiceFeature
public Dispatch<Object> createDispatch(EndpointReference endpointReference, JAXBContext context, Service.Mode mode, WebServiceFeature... features)
Dispatch
экземпляр для использования с JAXB сгенерированные объекты. Если есть какие-либо ссылочные параметры в endpointReference
, тогда те ссылочные параметры ДОЛЖНЫ появиться как заголовки SOAP, указывая на них, чтобы быть ссылочными параметрами, на всех сообщениях, отправленных конечной точке. endpointReference's
адрес ДОЛЖЕН использоваться для вызовов на конечной точке. В реализации этого метода система времени выполнения JAX-WS берет на себя ответственность выбора привязки протокола (и порт) и конфигурирование диспетчеризирования соответственно от WSDL, связанного с этим Service
экземпляр или от метаданных от endpointReference
. Если это Service
у экземпляра есть WSDL и endpointReference
также имеет WSDL в его метаданных, тогда WSDL от этого экземпляра ДОЛЖЕН использоваться. Если это Service
у экземпляра нет WSDL и endpointReference
действительно имеет WSDL, тогда WSDL от endpointReference
МОЖЕТ использоваться. Реализация ДОЛЖНА быть в состоянии получить portName
от endpointReference
метаданные. Этот метод behavies то же самое как вызов
dispatch = service.createDispatch(portName, context, mode, features);
где portName
получается от WSDL или endpointReference
метаданные.endpointReference
- EndpointReference
для целевой конечной точки службы, которая будет вызвана возвращенным Dispatch
объект.context
- Контекст JAXB, привыкший к маршальским и немаршальским сообщениям или полезным нагрузкам сообщения.mode
- Средства управления, диспетчеризируют ли создаваемые экземпляр, являются сообщением или полезной нагрузкой, ориентированной, то есть будет ли клиент работать с полными сообщениями протокола или передавать полезные нагрузки. Например, при использовании протокола SOAP, этот параметр управляет, будет ли клиент работать с сообщениями SOAP или содержанием тела SOAP.features
- Массив WebServiceFeatures
сконфигурировать на прокси. Поддерживавшие функции не в features
у параметра будут их значения по умолчанию.WebServiceException
- endpointReference
метаданные не соответствуют serviceName
или portName
из WSDL, связанного с этим Service
экземпляр. portName
не может быть определен от EndpointReference
метаданные. Dispatch
объект. JAXBContext
, WebServiceFeature
public QName getServiceName()
public Iterator<QName> getPorts()
Iterator
для списка QName
s конечных точек службы сгруппировался этой службойjava.util.Iterator
с элементами типа javax.xml.namespace.QName
.WebServiceException
- Если у этой Службы class нет доступа к необходимым метаданным WSDL.public URL getWSDLDocumentLocation()
public HandlerResolver getHandlerResolver()
HandlerResolver
быть используемым этим Service
экземпляр, или null
если нет того.public void setHandlerResolver(HandlerResolver handlerResolver)
HandlerResolver
для этого Service
экземпляр. Однажды преобразователь обработчика, если есть вызовут для каждого прокси или диспетчеризирует экземпляр, который создается, и цепочка обработчика, возвращенная преобразователем, будет установлена на экземпляре.
handlerResolver
- HandlerResolver
чтобы использовать для всех впоследствии создаваемых проксируют/диспетчеризируют объекты.HandlerResolver
public Executor getExecutor()
Service
экземпляр. Исполнитель используется для всех асинхронных вызовов, которые требуют обратных вызовов.java.util.concurrent.Executor
использоваться, чтобы вызвать обратный вызов.Executor
public void setExecutor(Executor executor)
Service
экземпляр. Исполнитель используется для всех асинхронных вызовов, которые требуют обратных вызовов.executor
- java.util.concurrent.Executor
использоваться, чтобы вызвать обратный вызов.SecurityException
- Если экземпляр не поддерживает установку исполнителя для соображений безопасности (например, необходимые полномочия отсутствуют).Executor
public static Service create(URL wsdlDocumentLocation, QName serviceName)
Service
экземпляр. Указанное расположение документа WSDL и полностью определенное имя службы ДОЛЖНЫ однозначно определить a wsdl:service
элемент.wsdlDocumentLocation
- URL
для расположения документа WSDL для службыserviceName
- QName
для службыWebServiceException
- Если любая ошибка в создании указанной службы.public static Service create(URL wsdlDocumentLocation, QName serviceName, WebServiceFeature... features)
Service
экземпляр. Создаваемый экземпляр конфигурируется с функциями веб-сервиса. Указанное расположение документа WSDL и полностью определенное имя службы ДОЛЖНЫ однозначно определить a wsdl:service
элемент.wsdlDocumentLocation
- URL
для расположения документа WSDL для службыserviceName
- QName
для службыfeatures
- Функции Веб-сервиса, которые должны быть сконфигурированы на службе. Если провайдер не понимает функцию, он должен бросить WebServiceException.WebServiceException
- Если любая ошибка в создании указанной службы.public static Service create(QName serviceName)
Service
экземпляр.serviceName
- QName
для службыWebServiceException
- Если любая ошибка в создании указанной службыpublic static Service create(QName serviceName, WebServiceFeature... features)
Service
экземпляр. Создаваемый экземпляр конфигурируется с функциями веб-сервиса.serviceName
- QName
для службыfeatures
- Функции Веб-сервиса, которые должны быть сконфигурированы на службе. Если провайдер не понимает функцию, он должен бросить WebServiceException.WebServiceException
- Если любая ошибка в создании указанной службы
Для дальнейшей ссылки API и документации разработчика, см. Java Документация SE. Та документация содержит более подробные, предназначенные разработчиком описания, с концептуальными краткими обзорами, определениями сроков, обходных решений, и рабочих примеров кода.
Авторское право © 1993, 2013, Oracle и/или его филиалы. Все права защищены.
ЧЕРНОВАЯ земля-b92