01: /*
02: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
03: *
04: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
05: *
06: * The contents of this file are subject to the terms of either the GNU
07: * General Public License Version 2 only ("GPL") or the Common Development
08: * and Distribution License("CDDL") (collectively, the "License"). You
09: * may not use this file except in compliance with the License. You can obtain
10: * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
11: * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
12: * language governing permissions and limitations under the License.
13: *
14: * When distributing the software, include this License Header Notice in each
15: * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
16: * Sun designates this particular file as subject to the "Classpath" exception
17: * as provided by Sun in the GPL Version 2 section of the License file that
18: * accompanied this code. If applicable, add the following below the License
19: * Header, with the fields enclosed by brackets [] replaced by your own
20: * identifying information: "Portions Copyrighted [year]
21: * [name of copyright owner]"
22: *
23: * Contributor(s):
24: *
25: * If you wish your version of this file to be governed by only the CDDL or
26: * only the GPL Version 2, indicate your decision by adding "[Contributor]
27: * elects to include this software in this distribution under the [CDDL or GPL
28: * Version 2] license." If you don't indicate a single choice of license, a
29: * recipient has the option to distribute your version of this file under
30: * either the CDDL, the GPL Version 2 or to extend the choice of license to
31: * its licensees as provided above. However, if you add GPL Version 2 code
32: * and therefore, elected the GPL Version 2 license, then the option applies
33: * only if the new code is made subject to such option by the copyright
34: * holder.
35: */
36:
37: package com.sun.xml.ws.api;
38:
39: import com.sun.istack.Nullable;
40: import com.sun.istack.NotNull;
41:
42: import javax.xml.ws.WebServiceException;
43:
44: /**
45: * Extension point to plug in additional {@link BindingID} parsing logic.
46: *
47: * <p>
48: * When the JAX-WS RI is asked to parse a binding ID string into a {@link BindingID}
49: * object, it uses service idiom to look for the implementations of this class
50: * in the <tt>META-INF/services/...</tt>.
51: *
52: * @since JAX-WS 2.0.next
53: * @author Kohsuke Kawaguchi
54: * @see BindingID#parse(String)
55: */
56: public abstract class BindingIDFactory {
57: /**
58: * Parses a binding ID string into {@link BindingID} if possible.
59: *
60: * @return
61: * a non-null return value would cause the JAX-WS RI to consider
62: * the parsing to be successful. No furhter {@link BindingIDFactory}
63: * will be consulted.
64: *
65: * <p>
66: * Retruning a null value indicates that this factory doesn't understand
67: * this string, in which case the JAX-WS RI will keep asking next
68: * {@link BindingIDFactory}.
69: *
70: * @throws WebServiceException
71: * if the implementation understood the lexical value but it is not correct,
72: * this exception can be thrown to abort the parsing with error.
73: * No further {@link BindingIDFactory} will be consulted, and
74: * {@link BindingID#parse(String)} will throw the exception.
75: */
76: public abstract @Nullable
77: BindingID parse(@NotNull
78: String lexical) throws WebServiceException;
79: }
|