* This feature can be used during the creation of SEI proxy, and * {@link javax.xml.ws.Dispatch} instances on the client side and {@link Endpoint} * instances on the server side. This feature cannot be used for {@link Service} * instance creation on the client side. *
* The following describes the effects of this feature with respect * to be enabled or disabled: *
* If the feature is enabled, the required property determines
* whether the endpoint requires WS-Addressing. If it is set true,
* WS-Addressing headers MUST be present on incoming and outgoing messages.
* By default the required property is false.
*
*
* If the web service developer has not explicitly enabled this feature, * WSDL's wsam:Addressing policy assertion is used to find * the use of WS-Addressing. By using the feature explicitly, an application * overrides WSDL's indication of the use of WS-Addressing. In some cases, * this is really required. For example, if an application has implemented * WS-Addressing itself, it can use this feature to disable addressing. That * means a JAX-WS implementation doesn't consume or produce WS-Addressing * headers. * *
* If addressing is enabled, a corresponding wsam:Addressing policy assertion * must be generated in the WSDL as per * * 3.1 WS-Policy Assertions * *
* Example 1: Possible Policy Assertion in the generated WSDL for
* @Addressing
*
* <wsam:Addressing wsp:Optional="true"> * <wsp:Policy/> * </wsam:Addressing> ** *
* Example 2: Possible Policy Assertion in the generated WSDL for
* @Addressing(required=true)
*
* <wsam:Addressing> * <wsp:Policy/> * </wsam:Addressing> ** *
* Example 3: Possible Policy Assertion in the generated WSDL for
* @Addressing(required=true, responses=Responses.ANONYMOUS)
*
* <wsam:Addressing> * <wsp:Policy> * <wsam:AnonymousResponses/> * </wsp:Policy> * </wsam:Addressing> ** *
* See * Web Services Addressing - Core, * * Web Services Addressing 1.0 - SOAP Binding, * and * Web Services Addressing 1.0 - Metadata * for more information on WS-Addressing. * * @see Addressing * @since 1.6, JAX-WS 2.1 */ public final class AddressingFeature extends WebServiceFeature { /** * Constant value identifying the AddressingFeature */ public static final String ID = "http://www.w3.org/2005/08/addressing/module"; /** * If addressing is enabled, this property determines whether the endpoint * requires WS-Addressing. If required is true, WS-Addressing headers MUST * be present on incoming and outgoing messages. */ // should be private final, keeping original modifier due to backwards compatibility protected boolean required; /** * If addressing is enabled, this property determines if endpoint requires * the use of only anonymous responses, or only 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.
*
* @since 1.7, JAX-WS 2.2
*/
public enum Responses {
/**
* Specifies 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.
*/
ANONYMOUS,
/**
* Specifies 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.
*/
NON_ANONYMOUS,
/**
* Supports all response types and this is the default
*/
ALL
}
private final Responses responses;
/**
* Creates and configures an AddressingFeature with the
* use of addressing requirements. The created feature enables
* ws-addressing i.e. supports ws-addressing but doesn't require
* its use. It is also configured to accept all the response types.
*/
public AddressingFeature() {
this(true, false, Responses.ALL);
}
/**
* Creates and configures an AddressingFeature with the
* use of addressing requirements. If enabled is true,
* it enables ws-addressing i.e. supports ws-addressing but doesn't
* require its use. It also configures to accept all the response types.
*
* @param enabled true enables ws-addressing i.e.ws-addressing
* is supported but doesn't require its use
*/
public AddressingFeature(boolean enabled) {
this(enabled, false, Responses.ALL);
}
/**
* Creates and configures an AddressingFeature with the
* use of addressing requirements. If enabled and
* required are true, it enables ws-addressing and
* requires its use. It also configures to accept all the response types.
*
* @param enabled true enables ws-addressing i.e.ws-addressing
* is supported but doesn't require its use
* @param required true means requires the use of ws-addressing .
*/
public AddressingFeature(boolean enabled, boolean required) {
this(enabled, required, Responses.ALL);
}
/**
* Creates and configures an AddressingFeature with the
* use of addressing requirements. If enabled and
* required are true, it enables ws-addressing and
* requires its use. Also, the response types can be configured using
* responses parameter.
*
* @param enabled true enables ws-addressing i.e.ws-addressing
* is supported but doesn't require its use
* @param required true means requires the use of ws-addressing .
* @param responses specifies what type of responses are required
*
* @since 1.7, JAX-WS 2.2
*/
public AddressingFeature(boolean enabled, boolean required, Responses responses) {
this.enabled = enabled;
this.required = required;
this.responses = responses;
}
/**
* {@inheritDoc}
*/
public String getID() {
return ID;
}
/**
* If addressing is enabled, this property determines whether the endpoint
* requires WS-Addressing. If required is true, WS-Addressing headers MUST
* be present on incoming and outgoing messages.
*
* @return the current required value
*/
public boolean isRequired() {
return required;
}
/**
* If addressing is enabled, this property determines whether endpoint
* requires the use of anonymous responses, or non-anonymous responses,
* or all responses.
*
*
* @return {@link Responses#ALL} when endpoint supports all types of * responses, * {@link Responses#ANONYMOUS} when endpoint requires the use of * only anonymous responses, * {@link Responses#NON_ANONYMOUS} when endpoint requires the use * of only non-anonymous responses * * @since 1.7, JAX-WS 2.2 */ public Responses getResponses() { return responses; } }