Mercurial > jdk8-mips64-public > jaxws / file diff

     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/src/share/jaxws_classes/com/sun/xml/internal/ws/api/BindingIDFactory.java	Tue Mar 06 16:09:35 2012 -0800
     1.3 @@ -0,0 +1,66 @@
     1.4 +/*
     1.5 + * Copyright (c) 1997, 2010, Oracle and/or its affiliates. All rights reserved.
     1.6 + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
     1.7 + *
     1.8 + * This code is free software; you can redistribute it and/or modify it
     1.9 + * under the terms of the GNU General Public License version 2 only, as
    1.10 + * published by the Free Software Foundation.  Oracle designates this
    1.11 + * particular file as subject to the "Classpath" exception as provided
    1.12 + * by Oracle in the LICENSE file that accompanied this code.
    1.13 + *
    1.14 + * This code is distributed in the hope that it will be useful, but WITHOUT
    1.15 + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    1.16 + * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
    1.17 + * version 2 for more details (a copy is included in the LICENSE file that
    1.18 + * accompanied this code).
    1.19 + *
    1.20 + * You should have received a copy of the GNU General Public License version
    1.21 + * 2 along with this work; if not, write to the Free Software Foundation,
    1.22 + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
    1.23 + *
    1.24 + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
    1.25 + * or visit www.oracle.com if you need additional information or have any
    1.26 + * questions.
    1.27 + */
    1.28 +
    1.29 +package com.sun.xml.internal.ws.api;
    1.30 +
    1.31 +import com.sun.istack.internal.Nullable;
    1.32 +import com.sun.istack.internal.NotNull;
    1.33 +
    1.34 +import javax.xml.ws.WebServiceException;
    1.35 +
    1.36 +/**
    1.37 + * Extension point to plug in additional {@link BindingID} parsing logic.
    1.38 + *
    1.39 + * <p>
    1.40 + * When the JAX-WS RI is asked to parse a binding ID string into a {@link BindingID}
    1.41 + * object, it uses service idiom to look for the implementations of this class
    1.42 + * in the <tt>META-INF/services/...</tt>.
    1.43 + *
    1.44 + * @since JAX-WS 2.0.next
    1.45 + * @author Kohsuke Kawaguchi
    1.46 + * @see BindingID#parse(String)
    1.47 + */
    1.48 +public abstract class BindingIDFactory {
    1.49 +    /**
    1.50 +     * Parses a binding ID string into {@link BindingID} if possible.
    1.51 +     *
    1.52 +     * @return
    1.53 +     *      a non-null return value would cause the JAX-WS RI to consider
    1.54 +     *      the parsing to be successful. No furhter {@link BindingIDFactory}
    1.55 +     *      will be consulted.
    1.56 +     *
    1.57 +     *      <p>
    1.58 +     *      Retruning a null value indicates that this factory doesn't understand
    1.59 +     *      this string, in which case the JAX-WS RI will keep asking next
    1.60 +     *      {@link BindingIDFactory}.
    1.61 +     *
    1.62 +     * @throws WebServiceException
    1.63 +     *      if the implementation understood the lexical value but it is not correct,
    1.64 +     *      this exception can be thrown to abort the parsing with error.
    1.65 +     *      No further {@link BindingIDFactory} will be consulted, and
    1.66 +     *      {@link BindingID#parse(String)} will throw the exception.
    1.67 +     */
    1.68 +    public abstract @Nullable BindingID parse(@NotNull String lexical) throws WebServiceException;
    1.69 +}