Package jakarta.xml.ws
Class RespectBindingFeature
java.lang.Object
jakarta.xml.ws.WebServiceFeature
jakarta.xml.ws.RespectBindingFeature
This feature clarifies the use of the
wsdl:binding
in a Jakarta XML Web Services runtime.
This feature can be used during the creation of SEI proxy, and
Dispatch
instances on the client side and Endpoint
instances on the server side. This feature cannot be used for Service
instance creation on the client side.
This feature is only useful with web services that have an
associated WSDL. Enabling this feature requires that a Jakarta XML Web Services
implementation inspect the wsdl:binding
for an
endpoint at runtime to make sure that all wsdl:extensions
that have the required
attribute set to true
are understood and are being used.
The following describes the affects of this feature with respect to be enabled or disabled:
- ENABLED: In this Mode, a Jakarta XML Web Services runtime MUST assure that all
required
wsdl:binding
extensions(including policies) are either understood and used by the runtime, or explicitly disabled by the web service application. A web service can disable a particular extension if there is a correspondingWebServiceFeature
or annotation. Similarly, a web service client can disable particular extension using the correspondingWebServiceFeature
while creating a proxy or Dispatch instance. The runtime MUST also make sure that binding of SEI parameters/return values respect thewsdl:binding
. With this feature enabled, if a required (wsdl:required="true"
)wsdl:binding
extension is in the WSDL and it is not supported by a Jakarta XML Web Services runtime and it has not been explicitly turned off by the web service developer, then that Jakarta XML Web Services runtime MUST behave appropriately based on whether it is on the client or server:- Client: runtime MUST throw a
WebServiceException
no sooner than when one of the methods above is invoked but no later than the first invocation of an endpoint operation. - Server: throw a
WebServiceException
and the endpoint MUST fail to deploy
- Client: runtime MUST throw a
- DISABLED: In this Mode, an implementation may choose whether
to inspect the
wsdl:binding
or not and to what degree thewsdl:binding
will be inspected. For example, one implementation may choose to behave as if this feature is enabled, another implementation may only choose to verify the SEI's parameter/return type bindings.
- Since:
- 1.6, JAX-WS 2.1
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Constant value identifying the RespectBindingFeatureFields inherited from class jakarta.xml.ws.WebServiceFeature
enabled
-
Constructor Summary
ConstructorDescriptionCreates anRespectBindingFeature
.RespectBindingFeature
(boolean enabled) Creates an RespectBindingFeature -
Method Summary
Methods inherited from class jakarta.xml.ws.WebServiceFeature
isEnabled
-
Field Details
-
ID
Constant value identifying the RespectBindingFeature- See Also:
-
-
Constructor Details
-
RespectBindingFeature
public RespectBindingFeature()Creates anRespectBindingFeature
. The instance created will be enabled. -
RespectBindingFeature
public RespectBindingFeature(boolean enabled) Creates an RespectBindingFeature- Parameters:
enabled
- specifies whether this feature should be enabled or not.
-
-
Method Details
-
getID
Get the unique identifier for this WebServiceFeature.- Specified by:
getID
in classWebServiceFeature
- Returns:
- the unique identifier for this feature.
-