jakarta.xml.ws.soap.Addressing Maven / Gradle / Ivy
/*
* Copyright (c) 2005, 2020 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Distribution License v. 1.0, which is available at
* http://www.eclipse.org/org/documents/edl-v10.php.
*
* SPDX-License-Identifier: BSD-3-Clause
*/
package jakarta.xml.ws.soap;
import java.lang.annotation.Documented;
import java.lang.annotation.Target;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import jakarta.xml.ws.WebServiceRef;
import jakarta.xml.ws.WebServiceProvider;
import jakarta.xml.ws.soap.AddressingFeature.Responses;
import jakarta.xml.ws.spi.WebServiceFeatureAnnotation;
/**
* This annotation represents the use of WS-Addressing with either
* the SOAP 1.1/HTTP or SOAP 1.2/HTTP binding. Using this annotation
* with any other binding is undefined.
*
* This annotation MUST only be used in conjunction with the
* {@code javax.jws.WebService}, {@link WebServiceProvider},
* and {@link WebServiceRef} annotations.
* When used with a {@code javax.jws.WebService} annotation, this
* annotation MUST only be used on the service endpoint implementation
* class.
* When used with a {@code WebServiceRef} annotation, this annotation
* MUST only be used when a proxy instance is created. The injected SEI
* proxy, and endpoint MUST honor the values of the {@code Addressing}
* annotation.
*
* This annotation's behaviour is defined by the corresponding feature
* {@link AddressingFeature}.
*
* @since 1.6, JAX-WS 2.1
*/
@Target({ElementType.TYPE, ElementType.METHOD, ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@WebServiceFeatureAnnotation(id=AddressingFeature.ID,bean=AddressingFeature.class)
public @interface Addressing {
/**
* Specifies if this feature is enabled or disabled. If enabled, it means
* the endpoint supports WS-Addressing but does not require its use.
* Corresponding
*
* 3.1.1 Addressing Assertion must be generated in the generated WSDL.
*
* @return {@code true} if endpoint supports WS-Addressing, {@code false} otherwise
*/
boolean enabled() default true;
/**
* If addressing is enabled, this property determines whether the endpoint
* requires WS-Addressing. If required is true, the endpoint requires
* WS-Addressing and WS-Addressing headers MUST
* be present on incoming messages. A corresponding
*
* 3.1.1 Addressing Assertion must be generated in the WSDL.
*
* @return {@code true} if endpoint requires WS-Addressing, {@code false} otherwise
*/
boolean required() default false;
/**
* If addressing is enabled, this property determines whether endpoint
* requires the use of anonymous responses, or non-anonymous responses,
* or all.
*
*
* {@link Responses#ALL} supports all response types and this is the
* default value.
*
*
* {@link Responses#ANONYMOUS} requires the use of only anonymous
* responses. It will result into wsam:AnonymousResponses nested assertion
* as specified in
*
* 3.1.2 AnonymousResponses Assertion in the generated WSDL.
*
*
* {@link Responses#NON_ANONYMOUS} requires the use of only non-anonymous
* responses. It will result into
* wsam:NonAnonymousResponses nested assertion as specified in
*
* 3.1.3 NonAnonymousResponses Assertion in the generated WSDL.
*
* @return supported response types
* @since 1.7, JAX-WS 2.2
*/
Responses responses() default Responses.ALL;
}