Spec-Zone.ru › OpenJDK 8

Тип аннотации WebServiceRef


@Target(value={TYPE,METHOD,FIELD})
 @Retention(value=RUNTIME)
 @Documented
public @interface WebServiceRef

Аннотация WebServiceRef используется для определения ссылки на веб-сервис и (необязательно) целевого объекта для инъекции. Она может использоваться для инъекции как экземпляров сервиса, так и прокси. Эти инжектированные ссылки не являются потокобезопасными. Если к ссылкам обращаются несколько потоков, для поддержки нескольких потоков можно использовать обычные методы синхронизации.

Ссылки на веб-сервисы являются ресурсами в смысле Java EE 5. Аннотации (например, Addressing), помеченные мета-аннотацией WebServiceFeatureAnnotation, могут использоваться совместно с WebServiceRef. Созданная ссылка ДОЛЖНА быть настроена с веб-функцией аннотации.

Например, в коде ниже инжектированный StockQuoteProvider прокси ДОЛЖЕН иметь включенный WS-Addressing, как указано аннотацией Addressing.

public class MyClient {
       @Addressing
       @WebServiceRef(StockQuoteService.class)
       private StockQuoteProvider stockQuoteProvider;
       ...
    }

Если реализация JAX-WS сталкивается с неподдерживаемой или нераспознанной аннотацией, помеченной аннотацией WebServiceFeatureAnnotation, которая указана WebServiceRef, то ДОЛЖНО быть выдано сообщение об ОШИБКЕ.

С момента:
JAX-WS 2.0
См. также:
Resource, WebServiceFeatureAnnotation

Необязательные элементы

Модификатор и тип Необязательный элемент и описание
String lookup

Переносная имя поиска JNDI, которое разрешается до целевой ссылки на веб-сервис.

String mappedName

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

String name

Имя ресурса в JNDI.

Class<?> type

Тип ресурса в Java.

Class<? extends Service> value

Класс сервиса, всегда тип, расширяющий javax.xml.ws.Service.

String wsdlLocation

URL, указывающий на документ WSDL для веб-сервиса.

Элементы

name

public abstract String name

Имя ресурса в JNDI. Для аннотаций полей, значение по умолчанию — имя поля. Для аннотаций методов, значение по умолчанию — имя свойства JavaBeans, соответствующее методу. Для аннотаций классов, значение по умолчанию отсутствует и оно ДОЛЖНО быть указано. Имя JNDI может быть абсолютным (с любым логическим пространством имён) или относительным к пространству имён JNDI java:comp/env.

Значение по умолчанию:
""

type

public abstract Class<?> type

Тип ресурса в Java. Для аннотаций полей, значение по умолчанию — тип поля. Для аннотаций методов, значение по умолчанию — тип свойства JavaBeans. Для аннотаций классов, значение по умолчанию отсутствует и оно ДОЛЖНО быть указано.

Значение по умолчанию:
java.lang.Object.class

mappedName

public abstract String mappedName

Уникальное имя, к которому должен быть привязан этот ресурс. Имя этого ресурса, как определено элементом name, или по умолчанию, является именем, локальным для компонента приложения, использующего этот ресурс. (Если указано относительное имя JNDI, то это имя в пространстве имён JNDI java:comp/env.) Многие серверы приложений предоставляют способ сопоставления этих локальных имён с именами ресурсов, известными серверу приложения. Это сопоставленное имя часто является глобальным именем JNDI, но может быть именем любого формата.

Серверы приложений не обязаны поддерживать какой-либо конкретный формат или тип сопоставленного имени, а также возможность использования сопоставленных имён. Сопоставленное имя зависит от продукта и часто от установки. Любое использование сопоставленного имени не является портативным.

Значение по умолчанию:
""

value

public abstract Class<? extends Service> value

Класс сервиса, всегда тип, расширяющий javax.xml.ws.Service. Этот элемент ДОЛЖЕН быть указан, когда тип ссылки — интерфейс точки входа сервиса.

Значение по умолчанию:
javax.xml.ws.Service.class

wsdlLocation

public abstract String wsdlLocation

URL, указывающий на документ WSDL для веб-сервиса. Если не указано, используется расположение WSDL, указанное аннотациями на типе ресурса.

Значение по умолчанию:
""

lookup

public abstract String lookup

Переносная имя поиска JNDI, которое разрешается до целевой ссылки на веб-сервис.

С момента:
JAX-WS 2.2
Значение по умолчанию:
""

© 1993, 2020, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API