Java Doc for BindingID.java in  » 6.0-JDK-Modules » jax-ws-runtime » com » sun » xml » ws » api » Java Source Code / Java DocumentationJava Source Code and Java Documentation

BindingID is an immutable object that represents a binding ID, much like how URL is a representation of an URL. Like URL , this class offers a bunch of methods that let you query various traits/properties of a binding ID.

BindingID is extensible; one can plug in a parser from String to BindingID to interpret binding IDs that the JAX-WS RI does no a-priori knowledge of. Technologies such as Tango uses this to make the JAX-WS RI understand binding IDs defined in their world. Such technologies are free to extend this class and expose more characterstics.

Even though this class defines a few well known constants, BindingID instances do not necessarily have singleton semantics. Use BindingID.equals(Object) for the comparison.

BindingID and WSBinding

WSBinding is mutable and represents a particular "use" of a BindingID . As such, it has state like a list of Handler s, which are inherently local to a particular usage. For example, if you have two proxies, you need two instances. BindingID , OTOH, is immutable and thus the single instance that represents "SOAP1.2/HTTP" can be shared and reused by all proxies in the same VM.
author:
   Kohsuke Kawaguchi

For e.g.: SOAP 1.1 and "XSOAP 1.2" is supposed to return true from this method.

Some binding ID, such as those for SOAP/HTTP, uses the URL query syntax (like ?mtom=true) to control the optional part of the binding.

This method first checks for a few known values and then delegate the parsing to BindingIDFactory .

If parsing succeeds this method returns a value.

For e.g.: SOAP 1.1 and "XSOAP 1.2" is supposed to return true from this method. For SOAP1.2, there is no standard WSDL, so the runtime is not generating one and it expects the WSDL is packaged.

For example, BindingID for " " would always return a list that has MTOMFeature enabled.

Some binding ID, such as those for SOAP/HTTP, uses the URL query syntax (like ?mtom=true) to control the optional part of the binding. This method obtains the value for such optional parts.

For implementors of the derived classes, if your binding ID does not define such optional parts (such as the XML/HTTP binding ID), then you should simply return the specified default value (which is what this implementation does.)
Parameters:
  parameterName - The parameter name, such as "mtom" in the above example.
Parameters:
  defaultValue - If this binding ID doesn't have the specified parameter explicitly,this value will be returned.the value of the parameter, if it's present (such as "true"in the above example.) If not present, this method returnsthe defaultValue .

This method first checks for a few known values and then delegate the parsing to BindingIDFactory .

If parsing succeeds this method returns a value. Otherwise throws WebServiceException .
throws:
  WebServiceException - If the binding ID is not understood.

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, ...) Always non-null same value.