Module com.sun.xml.ws.rt

Package com.sun.xml.ws.api

Class BindingIDFactory

java.lang.Object

com.sun.xml.ws.api.BindingIDFactory

public abstract class BindingIDFactory
extends Object

Extension point to plug in additional BindingID parsing logic.

When the JAX-WS RI is asked to parse a binding ID string into a BindingID object, it uses service idiom to look for the implementations of this class in the META-INF/services/....

Since:

JAX-WS 2.0.next

Author:

Kohsuke Kawaguchi

See Also:

BindingID.parse(String)

Constructor Summary

Constructors

Constructor	Description
BindingIDFactory()

Method Summary

Modifier and Type	Method	Description
BindingID	create(String transport, SOAPVersion soapVersion)	Creates a BindingID for given transport and SOAPVersion.
abstract BindingID	parse(String lexical)	Parses a binding ID string into BindingID if possible.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BindingIDFactory

public BindingIDFactory()

Method Detail

parse

@Nullable
public abstract BindingID parse(@NotNull
                                String lexical)
                         throws javax.xml.ws.WebServiceException

Parses a binding ID string into BindingID if possible.

Returns:

a non-null return value would cause the JAX-WS RI to consider the parsing to be successful. No furhter BindingIDFactory will be consulted.

Retruning a null value indicates that this factory doesn't understand this string, in which case the JAX-WS RI will keep asking next BindingIDFactory.

Throws:

javax.xml.ws.WebServiceException - if the implementation understood the lexical value but it is not correct, this exception can be thrown to abort the parsing with error. No further BindingIDFactory will be consulted, and BindingID.parse(String) will throw the exception.

create

@Nullable
public BindingID create(@NotNull
                        String transport,
                        @NotNull
                        SOAPVersion soapVersion)
                 throws javax.xml.ws.WebServiceException

Creates a BindingID for given transport and SOAPVersion.

Returns:

a non-null return value would cause the JAX-WS RI to consider the creation to be successful. No furhter BindingIDFactory will be consulted.

Retruning a null value indicates that this factory doesn't understand the transport, in which case the JAX-WS RI will keep asking next BindingIDFactory.

Throws:

javax.xml.ws.WebServiceException - if the implementation understood the transport but it is not correct, this exception can be thrown to abort the creation with error. No further BindingIDFactory will be consulted, and create(String, SOAPVersion) will throw the exception.