com.sun.xml.ws.api.BindingIDFactory Maven / Gradle / Ivy
/*
* Copyright (c) 1997, 2020 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Distribution License v. 1.0, which is available at
* http://www.eclipse.org/org/documents/edl-v10.php.
*
* SPDX-License-Identifier: BSD-3-Clause
*/
package com.sun.xml.ws.api;
import com.sun.istack.Nullable;
import com.sun.istack.NotNull;
import jakarta.xml.ws.WebServiceException;
/**
* Extension point to plug in additional {@link BindingID} parsing logic.
*
*
* When the JAX-WS RI is asked to parse a binding ID string into a {@link BindingID}
* object, it uses service idiom to look for the implementations of this class
* in the {@code META-INF/services/...}.
*
* @since JAX-WS 2.0.next
* @author Kohsuke Kawaguchi
* @see BindingID#parse(String)
*/
public abstract class BindingIDFactory {
/**
* Parses a binding ID string into {@link BindingID} if possible.
*
* @return
* a non-null return value would cause the JAX-WS RI to consider
* the parsing to be successful. No furhter {@link 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
* {@link BindingIDFactory}.
*
* @throws 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 {@link BindingIDFactory} will be consulted, and
* {@link BindingID#parse(String)} will throw the exception.
*/
public abstract @Nullable BindingID parse(@NotNull String lexical) throws WebServiceException;
/**
* Creates a {@link BindingID} for given transport and SOAPVersion.
*
* @return
* a non-null return value would cause the JAX-WS RI to consider
* the creation to be successful. No furhter {@link 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
* {@link BindingIDFactory}.
*
* @throws 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 {@link BindingIDFactory} will be consulted, and
* {@link #create(String, SOAPVersion)} will throw the exception.
*/
public @Nullable BindingID create(@NotNull String transport, @NotNull SOAPVersion soapVersion) throws WebServiceException {
return null;
}
}