Mercurial > jdk8-mips64-public > jaxws / annotate
src/share/jaxws_classes/com/sun/xml/internal/ws/api/BindingIDFactory.java@9c07ef4934dd (annotated)
src/share/jaxws_classes/com/sun/xml/internal/ws/api/BindingIDFactory.java
Thu, 31 Aug 2017 15:18:52 +0800
- author
- aoqi
- date
- Thu, 31 Aug 2017 15:18:52 +0800
- changeset 637
- 9c07ef4934dd
- parent 368
- 0989ad8c0860
- parent 0
- 373ffda63c9a
- permissions
- -rw-r--r--
merge
| aoqi@0 | 1 | /* |
| aoqi@0 | 2 | * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved. |
| aoqi@0 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| aoqi@0 | 4 | * |
| aoqi@0 | 5 | * This code is free software; you can redistribute it and/or modify it |
| aoqi@0 | 6 | * under the terms of the GNU General Public License version 2 only, as |
| aoqi@0 | 7 | * published by the Free Software Foundation. Oracle designates this |
| aoqi@0 | 8 | * particular file as subject to the "Classpath" exception as provided |
| aoqi@0 | 9 | * by Oracle in the LICENSE file that accompanied this code. |
| aoqi@0 | 10 | * |
| aoqi@0 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
| aoqi@0 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| aoqi@0 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| aoqi@0 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
| aoqi@0 | 15 | * accompanied this code). |
| aoqi@0 | 16 | * |
| aoqi@0 | 17 | * You should have received a copy of the GNU General Public License version |
| aoqi@0 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
| aoqi@0 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| aoqi@0 | 20 | * |
| aoqi@0 | 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
| aoqi@0 | 22 | * or visit www.oracle.com if you need additional information or have any |
| aoqi@0 | 23 | * questions. |
| aoqi@0 | 24 | */ |
| aoqi@0 | 25 | |
| aoqi@0 | 26 | package com.sun.xml.internal.ws.api; |
| aoqi@0 | 27 | |
| aoqi@0 | 28 | import com.sun.istack.internal.Nullable; |
| aoqi@0 | 29 | import com.sun.istack.internal.NotNull; |
| aoqi@0 | 30 | |
| aoqi@0 | 31 | import javax.xml.ws.WebServiceException; |
| aoqi@0 | 32 | |
| aoqi@0 | 33 | /** |
| aoqi@0 | 34 | * Extension point to plug in additional {@link BindingID} parsing logic. |
| aoqi@0 | 35 | * |
| aoqi@0 | 36 | * <p> |
| aoqi@0 | 37 | * When the JAX-WS RI is asked to parse a binding ID string into a {@link BindingID} |
| aoqi@0 | 38 | * object, it uses service idiom to look for the implementations of this class |
| aoqi@0 | 39 | * in the <tt>META-INF/services/...</tt>. |
| aoqi@0 | 40 | * |
| aoqi@0 | 41 | * @since JAX-WS 2.0.next |
| aoqi@0 | 42 | * @author Kohsuke Kawaguchi |
| aoqi@0 | 43 | * @see BindingID#parse(String) |
| aoqi@0 | 44 | */ |
| aoqi@0 | 45 | public abstract class BindingIDFactory { |
| aoqi@0 | 46 | /** |
| aoqi@0 | 47 | * Parses a binding ID string into {@link BindingID} if possible. |
| aoqi@0 | 48 | * |
| aoqi@0 | 49 | * @return |
| aoqi@0 | 50 | * a non-null return value would cause the JAX-WS RI to consider |
| aoqi@0 | 51 | * the parsing to be successful. No furhter {@link BindingIDFactory} |
| aoqi@0 | 52 | * will be consulted. |
| aoqi@0 | 53 | * |
| aoqi@0 | 54 | * <p> |
| aoqi@0 | 55 | * Retruning a null value indicates that this factory doesn't understand |
| aoqi@0 | 56 | * this string, in which case the JAX-WS RI will keep asking next |
| aoqi@0 | 57 | * {@link BindingIDFactory}. |
| aoqi@0 | 58 | * |
| aoqi@0 | 59 | * @throws WebServiceException |
| aoqi@0 | 60 | * if the implementation understood the lexical value but it is not correct, |
| aoqi@0 | 61 | * this exception can be thrown to abort the parsing with error. |
| aoqi@0 | 62 | * No further {@link BindingIDFactory} will be consulted, and |
| aoqi@0 | 63 | * {@link BindingID#parse(String)} will throw the exception. |
| aoqi@0 | 64 | */ |
| aoqi@0 | 65 | public abstract @Nullable BindingID parse(@NotNull String lexical) throws WebServiceException; |
| aoqi@0 | 66 | |
| aoqi@0 | 67 | /** |
| aoqi@0 | 68 | * Creates a {@link BindingID} for given transport and SOAPVersion. |
| aoqi@0 | 69 | * |
| aoqi@0 | 70 | * @return |
| aoqi@0 | 71 | * a non-null return value would cause the JAX-WS RI to consider |
| aoqi@0 | 72 | * the creation to be successful. No furhter {@link BindingIDFactory} |
| aoqi@0 | 73 | * will be consulted. |
| aoqi@0 | 74 | * |
| aoqi@0 | 75 | * <p> |
| aoqi@0 | 76 | * Retruning a null value indicates that this factory doesn't understand |
| aoqi@0 | 77 | * the transport, in which case the JAX-WS RI will keep asking next |
| aoqi@0 | 78 | * {@link BindingIDFactory}. |
| aoqi@0 | 79 | * |
| aoqi@0 | 80 | * @throws WebServiceException |
| aoqi@0 | 81 | * if the implementation understood the transport but it is not correct, |
| aoqi@0 | 82 | * this exception can be thrown to abort the creation with error. |
| aoqi@0 | 83 | * No further {@link BindingIDFactory} will be consulted, and |
| aoqi@0 | 84 | * {@link BindingID#create(String, SOAPVersion)} will throw the exception. |
| aoqi@0 | 85 | */ |
| aoqi@0 | 86 | public @Nullable BindingID create(@NotNull String transport, @NotNull SOAPVersion soapVersion) throws WebServiceException { |
| aoqi@0 | 87 | return null; |
| aoqi@0 | 88 | } |
| aoqi@0 | 89 | } |
