com.sun.xml.ws.api.BindingIDFactory Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2017 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://oss.oracle.com/licenses/CDDL+GPL-1.1
* or LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package com.sun.xml.ws.api;
import com.sun.istack.Nullable;
import com.sun.istack.NotNull;
import javax.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;
}
}