Класс Service

Service объекты предоставляют представление веб-службы для клиента.

Service служит фабрикой для следующего:

• Прокси для целевого конечной точки службы.
• Экземпляры Dispatch для динамического вызова удалённой операции с ориентацией на сообщения.

Доступные порты службы можно перечислить с помощью метода getPorts. В качестве альтернативы, вы можете передать интерфейс конечной точки службы в унарный метод getPort и позволить среде выполнения выбрать совместимый порт.

Цепочки обработчиков для всех объектов, созданных Service, могут быть установлены с помощью HandlerResolver.

Executor может быть задан для службы, чтобы получить больший контроль над потоками, используемыми для обработки асинхронных обратных вызовов. Например, пул потоков с определёнными параметрами может быть включён путём создания ThreadPoolExecutor и регистрации его в службе.

Конструкторы

Service

protected Service(URL wsdlDocumentLocation,
                  QName serviceName)

Service

protected Service(URL wsdlDocumentLocation,
                  QName serviceName,
                  WebServiceFeature... features)

Методы

getPort

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

Метод getPort возвращает прокси. Клиент службы использует этот прокси для вызова операций на целевом конечном пункте службы. serviceEndpointInterface указывает интерфейс конечного пункта службы, поддерживаемый созданным динамическим экземпляром прокси.

Параметры:

portName - Квалифицированное имя конечного пункта службы в описании службы WSDL.

serviceEndpointInterface - Интерфейс конечного пункта службы, поддерживаемый динамическим экземпляром прокси.

Возвращает:

Экземпляр прокси, поддерживающий указанный интерфейс конечного пункта службы.

Исключение:

WebServiceException - Это исключение выбрасывается в следующих случаях:

• Если произошла ошибка при создании прокси.
• Если отсутствуют необходимые данные WSDL, требуемые этим методом.
• Если указано незаконное serviceEndpointInterface или portName.

См. также:

Proxy, InvocationHandler

getPort

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

Метод getPort возвращает прокси. Клиент службы использует этот прокси для вызова операций на целевом конечном пункте службы. serviceEndpointInterface указывает интерфейс конечного пункта службы, поддерживаемый созданным динамическим экземпляром прокси.

Параметры:

portName - Квалифицированное имя конечного пункта службы в описании службы WSDL.

serviceEndpointInterface - Интерфейс конечного пункта службы, поддерживаемый динамическим экземпляром прокси.

features - Список WebServiceFeatures для настройки прокси. Поддерживаемые функции, отсутствующие в параметре features , будут иметь свои значения по умолчанию.

Возвращает:

Экземпляр прокси, поддерживающий указанный интерфейс конечного пункта службы.

Исключение:

WebServiceException - Это исключение выбрасывается в следующих случаях:

• Если произошла ошибка при создании прокси.
• Если отсутствуют необходимые данные WSDL, требуемые этим методом.
• Если указано незаконное serviceEndpointInterface или portName.
• Если включена функция, несовместимая с этим портом или не поддерживаемая.

С:

JAX-WS 2.1

См. также:

Proxy, InvocationHandler, WebServiceFeature

getPort

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

Метод getPort возвращает прокси. Параметр serviceEndpointInterface указывает интерфейс конечного пункта службы, поддерживаемый возвращаемым прокси. В реализации этого метода система времени выполнения JAX-WS берет на себя ответственность за выбор привязки протокола (и порта) и настройку прокси соответственно. Возвращаемый прокси не должен быть перенастроен клиентом.

Параметры:

serviceEndpointInterface - Интерфейс конечного пункта службы.

Возвращает:

Экземпляр объекта, поддерживающий указанный интерфейс конечного пункта службы.

Исключение:

WebServiceException -

• Если произошла ошибка во время создания прокси.
• Если отсутствуют необходимые данные WSDL, требуемые этим методом.
• Если указано незаконное serviceEndpointInterface.

getPort

public <T> T getPort(Class<T> serviceEndpointInterface,
                     WebServiceFeature... features)

Метод getPort возвращает прокси. Параметр serviceEndpointInterface указывает интерфейс конечного пункта службы, поддерживаемый возвращаемым прокси. В реализации этого метода система времени выполнения JAX-WS берет на себя ответственность за выбор привязки протокола (и порта) и настройку прокси соответственно. Возвращаемый прокси не должен быть перенастроен клиентом.

Параметры:

serviceEndpointInterface - Интерфейс конечного пункта службы.

features - Список WebServiceFeatures для настройки прокси. Поддерживаемые функции, отсутствующие в параметре features , будут иметь свои значения по умолчанию.

Возвращает:

Экземпляр объекта, поддерживающий указанный интерфейс конечного пункта службы.

Исключение:

WebServiceException -

• Если произошла ошибка во время создания прокси.
• Если отсутствуют необходимые данные WSDL, требуемые этим методом.
• Если указано незаконное serviceEndpointInterface.
• Если включена функция, несовместимая с этим портом или не поддерживаемая.

С:

JAX-WS 2.1

См. также:

WebServiceFeature

getPort

public <T> T getPort(EndpointReference endpointReference,
                     Class<T> serviceEndpointInterface,
                     WebServiceFeature... features)

port = service.getPort(portName, serviceEndpointInterface);

Параметры:

endpointReference - EndpointReference для целевого конечного пункта службы, который будет вызываться возвращаемым прокси.

serviceEndpointInterface - Интерфейс конечного пункта службы.

features - Список WebServiceFeatures для настройки прокси. Поддерживаемые функции, отсутствующие в параметре features , будут иметь свои значения по умолчанию.

Возвращает:

Экземпляр прокси, поддерживающий указанный интерфейс конечного пункта службы.

Исключение:

WebServiceException -

• Если произошла ошибка во время создания прокси.
• Если отсутствуют необходимые данные WSDL, требуемые этим методом.
• Если метаданные endpointReference не совпадают с serviceName этого экземпляра Service.
• Если portName не может быть извлечен из WSDL или метаданных endpointReference.
• Если указано недопустимое endpointReference.
• Если указано недопустимое serviceEndpointInterface.
• Если включена функция, несовместимая с этим портом или не поддерживаемая.

С:

JAX-WS 2.1

addPort

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

Создает новый порт для службы. Порты, созданные таким образом, не содержат информации о типе порта WSDL и могут использоваться только для создания экземпляров Dispatch.

Параметры:

portName - Квалифицированное имя целевого конечного пункта службы.

bindingId - Строковый идентификатор привязки.

endpointAddress - Адрес целевого конечного пункта службы в качестве URI.

Исключение:

WebServiceException - Если произошла ошибка при создании порта.

См. также:

SOAPBinding.SOAP11HTTP_BINDING, SOAPBinding.SOAP12HTTP_BINDING, HTTPBinding.HTTP_BINDING

createDispatch

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

Создает экземпляр Dispatch для использования с объектами по выбору клиента.

Параметры:

portName - Квалифицированное имя целевого конечного пункта службы

type - Класс объекта, используемого для сообщений или полезных нагрузок сообщений. Реализации должны поддерживать javax.xml.transform.Source, javax.xml.soap.SOAPMessage и javax.activation.DataSource, в зависимости от используемой привязки.

mode - Управляет тем, является ли созданный экземпляр диспетчера ориентированным на сообщения или полезную нагрузку, т.е. работает ли клиент с полными сообщениями протокола или полезной нагрузкой сообщения. Например, при использовании протокола SOAP этот параметр управляет тем, будет ли клиент работать с сообщениями SOAP или содержимым тела SOAP. Режим ДОЛЖЕН быть MESSAGE, когда тип SOAPMessage.

Возвращает:

Экземпляр диспетчера.

Исключение:

WebServiceException - Если произошла ошибка при создании объекта Dispatch.

См. также:

Source, SOAPMessage

createDispatch

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

Создает экземпляр Dispatch для использования с объектами по выбору клиента.

Parameters:

portName - Квалифицированное имя целевой конечной точки службы

type - Класс объекта, используемый для сообщений или полезных нагрузок сообщений. Реализации должны поддерживать javax.xml.transform.Source и javax.xml.soap.SOAPMessage.

mode - Управляет тем, ориентирован ли созданный экземпляр диспетчеризации на сообщения или полезные данные, т. е. будет ли клиент работать с полными сообщениями протокола или полезными данными сообщений. Например, при использовании протокола SOAP этот параметр управляет тем, будет ли клиент работать с сообщениями SOAP или содержимым тела SOAP. Режим ДОЛЖЕН быть MESSAGE, когда тип равен SOAPMessage.

features - Список WebServiceFeatures для настройки на прокси-сервере. Для функций, не указанных в параметре features , будут использоваться значения по умолчанию.

Returns:

Экземпляр диспетчеризации.

Throws:

WebServiceException - При возникновении любой ошибки при создании объекта Dispatch или если включена функция, несовместимая с этим портом или неподдерживаемая.

Since:

JAX-WS 2.1

See Also:

Source, SOAPMessage, WebServiceFeature

createDispatch

public <T> Dispatch<T> createDispatch(EndpointReference endpointReference,
                                      Class<T> type,
                                      Service.Mode mode,
                                      WebServiceFeature... features)

dispatch = service.createDispatch(portName, type, mode, features);

Parameters:

endpointReference - EndpointReference для целевой конечной точки службы, которая будет вызываться возвращаемым объектом Dispatch.

type - Класс объекта, используемый для сообщений или полезных нагрузок сообщений. Реализации должны поддерживать javax.xml.transform.Source и javax.xml.soap.SOAPMessage.

mode - Управляет тем, ориентирован ли созданный экземпляр диспетчеризации на сообщения или полезные данные, т. е. будет ли клиент работать с полными сообщениями протокола или полезными данными сообщений. Например, при использовании протокола SOAP этот параметр управляет тем, будет ли клиент работать с сообщениями SOAP или содержимым тела SOAP. Режим ДОЛЖЕН быть MESSAGE, когда тип равен SOAPMessage.

features - Массив WebServiceFeatures для настройки на прокси-сервере. Для функций, не указанных в параметре features , будут использоваться значения по умолчанию.

Returns:

Экземпляр диспетчеризации

Throws:

WebServiceException -

• Если отсутствуют какие-либо метаданные WSDL, необходимые для этого метода.
• Если метаданные endpointReference не соответствуют serviceName или portName WSDL, связанного с этим экземпляром Service.
• Если portName не может быть определен из метаданных EndpointReference.
• При возникновении любой ошибки при создании объекта Dispatch.
• Если включена функция, несовместимая с этим портом или неподдерживаемая.

Since:

JAX-WS 2.1

See Also:

Source, SOAPMessage, WebServiceFeature

createDispatch

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

Создает экземпляр Dispatch для использования с объектами, генерируемыми JAXB.

Parameters:

portName - Квалифицированное имя целевой конечной точки службы

context - Контекст JAXB, используемый для маршалинга и анмаршалинга сообщений или полезных нагрузок сообщений.

mode - Управляет тем, ориентирован ли созданный экземпляр диспетчеризации на сообщения или полезные данные, т. е. будет ли клиент работать с полными сообщениями протокола или полезными данными сообщений. Например, при использовании протокола SOAP этот параметр управляет тем, будет ли клиент работать с сообщениями SOAP или содержимым тела SOAP.

Returns:

Экземпляр диспетчеризации.

Throws:

WebServiceException - При возникновении любой ошибки при создании объекта Dispatch.

See Also:

JAXBContext

createDispatch

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

Создает экземпляр Dispatch для использования с объектами, генерируемыми JAXB.

Parameters:

portName - Квалифицированное имя целевой конечной точки службы

context - Контекст JAXB, используемый для маршалинга и анмаршалинга сообщений или полезных нагрузок сообщений.

mode - Управляет тем, ориентирован ли созданный экземпляр диспетчеризации на сообщения или полезные данные, т. е. будет ли клиент работать с полными сообщениями протокола или полезными данными сообщений. Например, при использовании протокола SOAP этот параметр управляет тем, будет ли клиент работать с сообщениями SOAP или содержимым тела SOAP.

features - Список WebServiceFeatures для настройки на прокси-сервере. Для функций, не указанных в параметре features , будут использоваться значения по умолчанию.

Returns:

Экземпляр диспетчеризации.

Throws:

WebServiceException - При возникновении любой ошибки при создании объекта Dispatch или если включена функция, несовместимая с этим портом или неподдерживаемая.

Since:

JAX-WS 2.1

See Also:

JAXBContext, WebServiceFeature

createDispatch

public Dispatch<Object> createDispatch(EndpointReference endpointReference,
                                       JAXBContext context,
                                       Service.Mode mode,
                                       WebServiceFeature... features)

dispatch = service.createDispatch(portName, context, mode, features);

Parameters:

endpointReference - EndpointReference для целевой конечной точки службы, которая будет вызываться возвращаемым объектом Dispatch.

context - Контекст JAXB, используемый для маршалинга и анмаршалинга сообщений или полезных нагрузок сообщений.

mode - Управляет тем, ориентирован ли созданный экземпляр диспетчеризации на сообщения или полезные данные, т. е. будет ли клиент работать с полными сообщениями протокола или полезными данными сообщений. Например, при использовании протокола SOAP этот параметр управляет тем, будет ли клиент работать с сообщениями SOAP или содержимым тела SOAP.

features - Массив WebServiceFeatures для настройки на прокси-сервере. Для функций, не указанных в параметре features , будут использоваться значения по умолчанию.

Returns:

Экземпляр диспетчеризации

Throws:

WebServiceException -

• Если отсутствуют какие-либо метаданные WSDL, необходимые для этого метода.
• Если метаданные endpointReference не соответствуют serviceName или portName WSDL, связанного с этим экземпляром Service.
• Если portName не может быть определен из метаданных EndpointReference.
• При возникновении любой ошибки при создании объекта Dispatch.
• Если включена функция, несовместимая с этим портом или неподдерживаемая.

Since:

JAX-WS 2.1

See Also:

JAXBContext, WebServiceFeature

getServiceName

public QName getServiceName()

Получает имя этой службы.

Returns:

Квалифицированное имя этой службы

getPorts

public Iterator<QName> getPorts()

Возвращает Iterator для списка QName конечных точек службы, сгруппированных по этой службе

Returns:

Возвращает java.util.Iterator с элементами типа javax.xml.namespace.QName.

Throws:

WebServiceException - Если этот класс Service не имеет доступа к необходимым метаданным WSDL.

getWSDLDocumentLocation

public URL getWSDLDocumentLocation()

Получает расположение документа WSDL для этой службы.

Returns:

URL для расположения документа WSDL для этой службы.

getHandlerResolver

public HandlerResolver getHandlerResolver()

Возвращает настроенный обработчик разрешения.

Возвращает:

HandlerResolver Используемый этим экземпляром Service HandlerResolver, или null, если такового нет.

setHandlerResolver

public void setHandlerResolver(HandlerResolver handlerResolver)

Параметры:

handlerResolver - HandlerResolver для всех созданных впоследствии объектов прокси/диспетчера.

См. также:

HandlerResolver

getExecutor

public Executor getExecutor()

Возвращает Service для этого экземпляра. Service используется для всех асинхронных вызовов, требующих обратных вызовов.

Возвращает:

java.util.concurrent.Executor для вызова обратного вызова.

См. также:

Executor

setExecutor

public void setExecutor(Executor executor)

Устанавливает Service для этого экземпляра. Service используется для всех асинхронных вызовов, требующих обратных вызовов.

Параметры:

executor - java.util.concurrent.Executor для вызова обратного вызова.

Исключения:

SecurityException - Если экземпляр не поддерживает установку Service по соображениям безопасности (например, отсутствуют необходимые разрешения).

См. также:

Executor

create

public static Service create(URL wsdlDocumentLocation,
                             QName serviceName)

Создает экземпляр Service. Указанный URL-адрес документа WSDL и квалифицированное имя службы ОБЯЗАТЕЛЬНО должны однозначно идентифицировать элемент wsdl:service.

Параметры:

wsdlDocumentLocation - URL-адрес документа WSDL для службы

serviceName - Квалифицированное имя службы

Исключения:

WebServiceException - При любой ошибке при создании указанной службы.

create

public static Service create(URL wsdlDocumentLocation,
                             QName serviceName,
                             WebServiceFeature... features)

Создает экземпляр Service. Созданный экземпляр настроен с помощью функций веб-службы. Указанный URL-адрес документа WSDL и квалифицированное имя службы ОБЯЗАТЕЛЬНО должны однозначно идентифицировать элемент wsdl:service.

Параметры:

wsdlDocumentLocation - URL-адрес документа WSDL для службы

serviceName - Квалифицированное имя службы

features - Функции веб-службы, которые должны быть настроены на службе. Если поставщик не понимает функцию, он должен выбросить исключение WebServiceException.

Исключения:

WebServiceException - При любой ошибке при создании указанной службы.

С:

JAX-WS 2.2

create

public static Service create(QName serviceName)

Создает экземпляр Service.

Параметры:

serviceName - Квалифицированное имя службы

Исключения:

WebServiceException - При любой ошибке при создании указанной службы

create

public static Service create(QName serviceName,
                             WebServiceFeature... features)

Создает экземпляр Service. Созданный экземпляр настроен с помощью функций веб-службы.

Параметры:

serviceName - Квалифицированное имя службы

features - Функции веб-службы, которые должны быть настроены на службе. Если поставщик не понимает функцию, он должен выбросить исключение WebServiceException.

Исключения:

WebServiceException - При любой ошибке при создании указанной службы

С:

JAX-WS 2.2