Tue, 09 Apr 2013 14:51:13 +0100
8010393: Update JAX-WS RI to 2.2.9-b12941
Reviewed-by: alanb, erikj
Contributed-by: miroslav.kos@oracle.com, martin.grebac@oracle.com
ohair@286 | 1 | /* |
alanb@368 | 2 | * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved. |
ohair@286 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
ohair@286 | 4 | * |
ohair@286 | 5 | * This code is free software; you can redistribute it and/or modify it |
ohair@286 | 6 | * under the terms of the GNU General Public License version 2 only, as |
ohair@286 | 7 | * published by the Free Software Foundation. Oracle designates this |
ohair@286 | 8 | * particular file as subject to the "Classpath" exception as provided |
ohair@286 | 9 | * by Oracle in the LICENSE file that accompanied this code. |
ohair@286 | 10 | * |
ohair@286 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
ohair@286 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
ohair@286 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
ohair@286 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
ohair@286 | 15 | * accompanied this code). |
ohair@286 | 16 | * |
ohair@286 | 17 | * You should have received a copy of the GNU General Public License version |
ohair@286 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
ohair@286 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
ohair@286 | 20 | * |
ohair@286 | 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
ohair@286 | 22 | * or visit www.oracle.com if you need additional information or have any |
ohair@286 | 23 | * questions. |
ohair@286 | 24 | */ |
ohair@286 | 25 | |
ohair@286 | 26 | package com.sun.xml.internal.ws.api.model; |
ohair@286 | 27 | |
ohair@286 | 28 | import com.sun.istack.internal.NotNull; |
ohair@286 | 29 | import com.sun.xml.internal.bind.api.Bridge; |
ohair@286 | 30 | import com.sun.xml.internal.bind.api.JAXBRIContext; |
ohair@286 | 31 | import com.sun.xml.internal.bind.api.TypeReference; |
ohair@286 | 32 | import com.sun.xml.internal.ws.api.model.wsdl.WSDLPort; |
ohair@286 | 33 | import com.sun.xml.internal.ws.util.Pool; |
ohair@286 | 34 | |
ohair@286 | 35 | import javax.xml.bind.JAXBContext; |
ohair@286 | 36 | import javax.xml.namespace.QName; |
ohair@286 | 37 | import javax.xml.ws.Dispatch; |
ohair@286 | 38 | import javax.xml.ws.Provider; |
ohair@286 | 39 | import java.lang.reflect.Method; |
ohair@286 | 40 | import java.util.Collection; |
ohair@286 | 41 | |
ohair@286 | 42 | /** |
ohair@286 | 43 | * Represents abstraction of SEI. |
ohair@286 | 44 | * |
ohair@286 | 45 | * <p> |
ohair@286 | 46 | * This interface would be used to access which Java concepts correspond to |
ohair@286 | 47 | * which WSDL concepts, such as which <code>wsdl:port</code> corresponds to |
ohair@286 | 48 | * a SEI, or which <code>wsdl:operation</code> corresponds to {@link JavaMethod}. |
ohair@286 | 49 | * |
ohair@286 | 50 | * <P> |
ohair@286 | 51 | * It also retains information about the databinding done for a SEI; |
ohair@286 | 52 | * such as {@link JAXBRIContext} and {@link Bridge}. |
ohair@286 | 53 | * |
ohair@286 | 54 | * <p> |
ohair@286 | 55 | * This model is constructed only when there is a Java SEI. Therefore it's |
ohair@286 | 56 | * not available with {@link Dispatch} or {@link Provider}. Technologies that |
ohair@286 | 57 | * need to work regardless of such surface API difference shall not be using |
ohair@286 | 58 | * this model. |
ohair@286 | 59 | * |
ohair@286 | 60 | * @author Vivek Pandey |
ohair@286 | 61 | */ |
ohair@286 | 62 | public interface SEIModel { |
ohair@286 | 63 | Pool.Marshaller getMarshallerPool(); |
ohair@286 | 64 | |
ohair@286 | 65 | /** |
ohair@286 | 66 | * JAXBContext that will be used to marshall/unmarshall the java classes found in the SEI. |
ohair@286 | 67 | * |
ohair@286 | 68 | * @return the <code>{@link JAXBRIContext}</code> |
ohair@286 | 69 | * @deprecated Why do you need this? |
ohair@286 | 70 | */ |
ohair@286 | 71 | JAXBContext getJAXBContext(); |
ohair@286 | 72 | |
ohair@286 | 73 | /** |
ohair@286 | 74 | * Get the Bridge associated with the {@link TypeReference} |
ohair@286 | 75 | * |
ohair@286 | 76 | * @param type |
ohair@286 | 77 | * @return the <code>{@link Bridge}</code> for the <code>type</code> |
ohair@286 | 78 | */ |
ohair@286 | 79 | // Bridge getBridge(TypeReference type); |
ohair@286 | 80 | |
ohair@286 | 81 | /** |
ohair@286 | 82 | * Its a known fault if the exception thrown by {@link Method} is annotated with the |
ohair@286 | 83 | * {@link javax.xml.ws.WebFault#name()} thas equal to the name passed as parameter. |
ohair@286 | 84 | * |
ohair@286 | 85 | * @param name is the qualified name of fault detail element as specified by wsdl:fault@element value. |
ohair@286 | 86 | * @param method is the Java {@link Method} |
ohair@286 | 87 | * @return true if <code>name</code> is the name |
ohair@286 | 88 | * of a known fault name for the <code>method</code> |
ohair@286 | 89 | */ |
ohair@286 | 90 | // boolean isKnownFault(QName name, Method method); |
ohair@286 | 91 | |
ohair@286 | 92 | /** |
ohair@286 | 93 | * Checks if the {@link JavaMethod} for the {@link Method} knowns the exception class. |
ohair@286 | 94 | * |
ohair@286 | 95 | * @param m {@link Method} to pickup the right {@link JavaMethod} model |
ohair@286 | 96 | * @param ex exception class |
ohair@286 | 97 | * @return true if <code>ex</code> is a Checked Exception |
ohair@286 | 98 | * for <code>m</code> |
ohair@286 | 99 | */ |
ohair@286 | 100 | // boolean isCheckedException(Method m, Class ex); |
ohair@286 | 101 | |
ohair@286 | 102 | /** |
ohair@286 | 103 | * This method will be useful to get the {@link JavaMethod} corrrespondiong to |
ohair@286 | 104 | * a {@link Method} - such as on the client side. |
ohair@286 | 105 | * |
ohair@286 | 106 | * @param method for which {@link JavaMethod} is asked for |
ohair@286 | 107 | * @return the {@link JavaMethod} representing the <code>method</code> |
ohair@286 | 108 | */ |
ohair@286 | 109 | JavaMethod getJavaMethod(Method method); |
ohair@286 | 110 | |
ohair@286 | 111 | /** |
ohair@286 | 112 | * Gives a {@link JavaMethod} for a given {@link QName}. The {@link QName} will |
ohair@286 | 113 | * be equivalent to the SOAP Body or Header block or can simply be the name of an |
ohair@286 | 114 | * infoset that corresponds to the payload. |
ohair@286 | 115 | * @param name |
ohair@286 | 116 | * @return the <code>JavaMethod</code> associated with the |
ohair@286 | 117 | * operation named name |
ohair@286 | 118 | */ |
ohair@286 | 119 | public JavaMethod getJavaMethod(QName name); |
ohair@286 | 120 | |
ohair@286 | 121 | /** |
ohair@286 | 122 | * Gives the JavaMethod associated with the wsdl operation |
ohair@286 | 123 | * @param operationName QName of the wsdl operation |
ohair@286 | 124 | * @return |
ohair@286 | 125 | */ |
ohair@286 | 126 | public JavaMethod getJavaMethodForWsdlOperation(QName operationName); |
ohair@286 | 127 | |
ohair@286 | 128 | |
ohair@286 | 129 | /** |
ohair@286 | 130 | * Gives all the {@link JavaMethod} for a wsdl:port for which this {@link SEIModel} is |
ohair@286 | 131 | * created. |
ohair@286 | 132 | * |
ohair@286 | 133 | * @return a {@link Collection} of {@link JavaMethod} |
ohair@286 | 134 | * associated with the {@link SEIModel} |
ohair@286 | 135 | */ |
ohair@286 | 136 | Collection<? extends JavaMethod> getJavaMethods(); |
ohair@286 | 137 | |
ohair@286 | 138 | /** |
ohair@286 | 139 | * Location of the WSDL that defines the port associated with the {@link SEIModel} |
ohair@286 | 140 | * |
ohair@286 | 141 | * @return wsdl location uri - always non-null |
ohair@286 | 142 | */ |
ohair@286 | 143 | @NotNull String getWSDLLocation(); |
ohair@286 | 144 | |
ohair@286 | 145 | /** |
alanb@368 | 146 | * wsdl:service qualified name for the port associated with the {@link SEIModel} |
ohair@286 | 147 | * |
ohair@286 | 148 | * @return wsdl:service@name value - always non-null |
ohair@286 | 149 | */ |
ohair@286 | 150 | @NotNull QName getServiceQName(); |
ohair@286 | 151 | |
ohair@286 | 152 | /** |
ohair@286 | 153 | * Gets the {@link WSDLPort} that represents the port that this SEI binds to. |
ohair@286 | 154 | */ |
ohair@286 | 155 | @NotNull WSDLPort getPort(); |
ohair@286 | 156 | |
ohair@286 | 157 | /** |
alanb@368 | 158 | * Value of the wsdl:port name associated with the {@link SEIModel} |
ohair@286 | 159 | * |
ohair@286 | 160 | * @return wsdl:service/wsdl:port@name value, always non-null |
ohair@286 | 161 | */ |
ohair@286 | 162 | @NotNull QName getPortName(); |
ohair@286 | 163 | |
ohair@286 | 164 | /** |
alanb@368 | 165 | * Value of wsdl:portType bound to the port associated with the {@link SEIModel} |
ohair@286 | 166 | * |
ohair@286 | 167 | * @return |
ohair@286 | 168 | */ |
ohair@286 | 169 | @NotNull QName getPortTypeName(); |
ohair@286 | 170 | |
ohair@286 | 171 | /** |
ohair@286 | 172 | * Gives the wsdl:binding@name value |
ohair@286 | 173 | */ |
ohair@286 | 174 | @NotNull QName getBoundPortTypeName(); |
ohair@286 | 175 | |
ohair@286 | 176 | /** |
alanb@368 | 177 | * Namespace of the wsd;:port associated with the {@link SEIModel} |
ohair@286 | 178 | */ |
ohair@286 | 179 | @NotNull String getTargetNamespace(); |
ohair@286 | 180 | } |