com.sun.xml.ws.api
Interface WSBinding

All Superinterfaces:

javax.xml.ws.Binding

All Known Implementing Classes:

BindingImpl, HTTPBindingImpl, SOAPBindingImpl

public interface WSBinding
extends javax.xml.ws.Binding

JAX-WS implementation of Binding.

This object can be created by BindingID.createBinding().

Binding conceptually includes the on-the-wire format of the message, this this object owns Codec.

Method Summary

boolean	addKnownHeader(javax.xml.namespace.QName knownHeader) Adds header QName to set known to be supported by this binding
AddressingVersion	getAddressingVersion() Gets the WS-Addressing version of this binding.
BindingID	getBindingId() Gets the binding ID, which uniquely identifies the binding.
WSFeatureList	getFaultMessageFeatures(javax.xml.namespace.QName operationName, javax.xml.namespace.QName messageName) Experimental: Returns a list of features associated with WSBinding that apply to one of the fault messages of an operation.
<F extends javax.xml.ws.WebServiceFeature> F	getFeature(java.lang.Class<F> featureType) Gets a WebServiceFeature of the specific type.
WSFeatureList	getFeatures() Returns a list of features associated with WSBinding.
java.util.List<javax.xml.ws.handler.Handler>	getHandlerChain()
WSFeatureList	getInputMessageFeatures(javax.xml.namespace.QName operationName) Experimental: Returns a list of features associated with WSBinding that apply to the input message of an operation.
java.util.Set<javax.xml.namespace.QName>	getKnownHeaders() Returns set of header QNames known to be supported by this binding.
com.oracle.webservices.api.message.MessageContextFactory	getMessageContextFactory()
<F extends javax.xml.ws.WebServiceFeature> F	getOperationFeature(java.lang.Class<F> featureType, javax.xml.namespace.QName operationName) Experimental: Gets a WebServiceFeature of the specific type that applies to an operation.
WSFeatureList	getOperationFeatures(javax.xml.namespace.QName operationName) Experimental: Returns a list of features associated with WSBinding that apply to a particular operation.
WSFeatureList	getOutputMessageFeatures(javax.xml.namespace.QName operationName) Experimental: Returns a list of features associated with WSBinding that apply to the output message of an operation.
SOAPVersion	getSOAPVersion() Gets the SOAP version of this binding.
boolean	isFeatureEnabled(java.lang.Class<? extends javax.xml.ws.WebServiceFeature> feature) Checks if a particular WebServiceFeature is enabled.
boolean	isOperationFeatureEnabled(java.lang.Class<? extends javax.xml.ws.WebServiceFeature> feature, javax.xml.namespace.QName operationName) Experimental: Checks if a particular WebServiceFeature on an operation is enabled.

Methods inherited from interface javax.xml.ws.Binding

getBindingID, setHandlerChain

Method Detail

getSOAPVersion

SOAPVersion getSOAPVersion()

Gets the SOAP version of this binding. TODO: clarify what to do with XML/HTTP binding

This is just a short-cut for getBindingID().getSOAPVersion()

Returns:

If the binding is using SOAP, this method returns a SOAPVersion constant. If the binding is not based on SOAP, this method returns null. See Message for how a non-SOAP binding shall be handled by Tubes.

getAddressingVersion

AddressingVersion getAddressingVersion()

Gets the WS-Addressing version of this binding.

TODO: clarify what to do with XML/HTTP binding

Returns:

If the binding is using SOAP and WS-Addressing is enabled, this method returns a AddressingVersion constant. If binding is not using SOAP or WS-Addressing is not enabled, this method returns null. This might be little slow as it has to go over all the features on binding. Its advisable to cache the addressingVersion wherever possible and reuse it.

getBindingId

@NotNull
BindingID getBindingId()

Gets the binding ID, which uniquely identifies the binding.

The relevant specs define the binding IDs and what they mean. The ID is used in many places to identify the kind of binding (such as SOAP1.1, SOAP1.2, REST, ...)

Returns:

Always non-null same value.

getHandlerChain

@NotNull
java.util.List<javax.xml.ws.handler.Handler> getHandlerChain()

Specified by:

getHandlerChain in interface javax.xml.ws.Binding

isFeatureEnabled

boolean isFeatureEnabled(@NotNull
                         java.lang.Class<? extends javax.xml.ws.WebServiceFeature> feature)

Checks if a particular WebServiceFeature is enabled.

Returns:

true if enabled.

isOperationFeatureEnabled

boolean isOperationFeatureEnabled(@NotNull
                                  java.lang.Class<? extends javax.xml.ws.WebServiceFeature> feature,
                                  @NotNull
                                  javax.xml.namespace.QName operationName)

Experimental: Checks if a particular WebServiceFeature on an operation is enabled.

Parameters:

operationName - The WSDL name of the operation.

Returns:

true if enabled.

getFeature

@Nullable
<F extends javax.xml.ws.WebServiceFeature> F getFeature(@NotNull
                                                                 java.lang.Class<F> featureType)

Gets a WebServiceFeature of the specific type.

Parameters:

featureType - The type of the feature to retrieve.

Returns:

If the feature is present and enabled, return a non-null instance. Otherwise null.

getOperationFeature

@Nullable
<F extends javax.xml.ws.WebServiceFeature> F getOperationFeature(@NotNull
                                                                          java.lang.Class<F> featureType,
                                                                          @NotNull
                                                                          javax.xml.namespace.QName operationName)

Experimental: Gets a WebServiceFeature of the specific type that applies to an operation.

Parameters:

featureType - The type of the feature to retrieve.

operationName - The WSDL name of the operation.

Returns:

If the feature is present and enabled, return a non-null instance. Otherwise null.

getFeatures

@NotNull
WSFeatureList getFeatures()

Returns a list of features associated with WSBinding.

getOperationFeatures

@NotNull
WSFeatureList getOperationFeatures(@NotNull
                                           javax.xml.namespace.QName operationName)

Experimental: Returns a list of features associated with WSBinding that apply to a particular operation.

Parameters:

operationName - The WSDL name of the operation.

getInputMessageFeatures

@NotNull
WSFeatureList getInputMessageFeatures(@NotNull
                                              javax.xml.namespace.QName operationName)

Experimental: Returns a list of features associated with WSBinding that apply to the input message of an operation.

Parameters:

operationName - The WSDL name of the operation.

getOutputMessageFeatures

@NotNull
WSFeatureList getOutputMessageFeatures(@NotNull
                                               javax.xml.namespace.QName operationName)

Experimental: Returns a list of features associated with WSBinding that apply to the output message of an operation.

Parameters:

operationName - The WSDL name of the operation.

getFaultMessageFeatures

@NotNull
WSFeatureList getFaultMessageFeatures(@NotNull
                                              javax.xml.namespace.QName operationName,
                                              @NotNull
                                              javax.xml.namespace.QName messageName)

Experimental: Returns a list of features associated with WSBinding that apply to one of the fault messages of an operation.

Parameters:

operationName - The WSDL name of the operation.

messageName - The WSDL name of the fault message.

getKnownHeaders

@NotNull
java.util.Set<javax.xml.namespace.QName> getKnownHeaders()

Returns set of header QNames known to be supported by this binding.

Returns:

Set of known QNames

addKnownHeader

boolean addKnownHeader(javax.xml.namespace.QName knownHeader)

Adds header QName to set known to be supported by this binding

Parameters:

knownHeader - Known header QName

Returns:

true, if new entry was added; false, if known header QName was already known

getMessageContextFactory

@NotNull
com.oracle.webservices.api.message.MessageContextFactory getMessageContextFactory()

Returns:

A MessageContextFactory configured according to the binding's features.