ohair@286: /*
alanb@368:  * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved.
ohair@286:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
ohair@286:  *
ohair@286:  * This code is free software; you can redistribute it and/or modify it
ohair@286:  * under the terms of the GNU General Public License version 2 only, as
ohair@286:  * published by the Free Software Foundation.  Oracle designates this
ohair@286:  * particular file as subject to the "Classpath" exception as provided
ohair@286:  * by Oracle in the LICENSE file that accompanied this code.
ohair@286:  *
ohair@286:  * This code is distributed in the hope that it will be useful, but WITHOUT
ohair@286:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
ohair@286:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
ohair@286:  * version 2 for more details (a copy is included in the LICENSE file that
ohair@286:  * accompanied this code).
ohair@286:  *
ohair@286:  * You should have received a copy of the GNU General Public License version
ohair@286:  * 2 along with this work; if not, write to the Free Software Foundation,
ohair@286:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
ohair@286:  *
ohair@286:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@286:  * or visit www.oracle.com if you need additional information or have any
ohair@286:  * questions.
ohair@286:  */
ohair@286: 
ohair@286: package com.sun.xml.internal.ws.api;
ohair@286: 
ohair@286: import com.sun.istack.internal.Nullable;
ohair@286: import com.sun.istack.internal.NotNull;
ohair@286: 
ohair@286: import javax.xml.ws.WebServiceException;
ohair@286: 
ohair@286: /**
ohair@286:  * Extension point to plug in additional {@link BindingID} parsing logic.
ohair@286:  *
ohair@286:  * <p>
ohair@286:  * When the JAX-WS RI is asked to parse a binding ID string into a {@link BindingID}
ohair@286:  * object, it uses service idiom to look for the implementations of this class
ohair@286:  * in the <tt>META-INF/services/...</tt>.
ohair@286:  *
ohair@286:  * @since JAX-WS 2.0.next
ohair@286:  * @author Kohsuke Kawaguchi
ohair@286:  * @see BindingID#parse(String)
ohair@286:  */
ohair@286: public abstract class BindingIDFactory {
ohair@286:     /**
ohair@286:      * Parses a binding ID string into {@link BindingID} if possible.
ohair@286:      *
ohair@286:      * @return
ohair@286:      *      a non-null return value would cause the JAX-WS RI to consider
ohair@286:      *      the parsing to be successful. No furhter {@link BindingIDFactory}
ohair@286:      *      will be consulted.
ohair@286:      *
ohair@286:      *      <p>
ohair@286:      *      Retruning a null value indicates that this factory doesn't understand
ohair@286:      *      this string, in which case the JAX-WS RI will keep asking next
ohair@286:      *      {@link BindingIDFactory}.
ohair@286:      *
ohair@286:      * @throws WebServiceException
ohair@286:      *      if the implementation understood the lexical value but it is not correct,
ohair@286:      *      this exception can be thrown to abort the parsing with error.
ohair@286:      *      No further {@link BindingIDFactory} will be consulted, and
ohair@286:      *      {@link BindingID#parse(String)} will throw the exception.
ohair@286:      */
ohair@286:     public abstract @Nullable BindingID parse(@NotNull String lexical) throws WebServiceException;
alanb@368: 
alanb@368:     /**
alanb@368:      * Creates a {@link BindingID} for given transport and SOAPVersion.
alanb@368:      *
alanb@368:      * @return
alanb@368:      *      a non-null return value would cause the JAX-WS RI to consider
alanb@368:      *      the creation to be successful. No furhter {@link BindingIDFactory}
alanb@368:      *      will be consulted.
alanb@368:      *
alanb@368:      *      <p>
alanb@368:      *      Retruning a null value indicates that this factory doesn't understand
alanb@368:      *      the transport, in which case the JAX-WS RI will keep asking next
alanb@368:      *      {@link BindingIDFactory}.
alanb@368:      *
alanb@368:      * @throws WebServiceException
alanb@368:      *      if the implementation understood the transport but it is not correct,
alanb@368:      *      this exception can be thrown to abort the creation with error.
alanb@368:      *      No further {@link BindingIDFactory} will be consulted, and
alanb@368:      *      {@link BindingID#create(String, SOAPVersion)} will throw the exception.
alanb@368:      */
alanb@368:     public @Nullable BindingID create(@NotNull String transport, @NotNull SOAPVersion soapVersion) throws WebServiceException {
alanb@368:         return null;
alanb@368:     }
ohair@286: }