001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common Development
008: * and Distribution License("CDDL") (collectively, the "License"). You
009: * may not use this file except in compliance with the License. You can obtain
010: * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
011: * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
012: * language governing permissions and limitations under the License.
013: *
014: * When distributing the software, include this License Header Notice in each
015: * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
016: * Sun designates this particular file as subject to the "Classpath" exception
017: * as provided by Sun in the GPL Version 2 section of the License file that
018: * accompanied this code. If applicable, add the following below the License
019: * Header, with the fields enclosed by brackets [] replaced by your own
020: * identifying information: "Portions Copyrighted [year]
021: * [name of copyright owner]"
022: *
023: * Contributor(s):
024: *
025: * If you wish your version of this file to be governed by only the CDDL or
026: * only the GPL Version 2, indicate your decision by adding "[Contributor]
027: * elects to include this software in this distribution under the [CDDL or GPL
028: * Version 2] license." If you don't indicate a single choice of license, a
029: * recipient has the option to distribute your version of this file under
030: * either the CDDL, the GPL Version 2 or to extend the choice of license to
031: * its licensees as provided above. However, if you add GPL Version 2 code
032: * and therefore, elected the GPL Version 2 license, then the option applies
033: * only if the new code is made subject to such option by the copyright
034: * holder.
035: */
036:
037: package com.sun.xml.ws.api.model;
038:
039: import com.sun.istack.NotNull;
040: import com.sun.xml.bind.api.Bridge;
041: import com.sun.xml.bind.api.JAXBRIContext;
042: import com.sun.xml.bind.api.TypeReference;
043: import com.sun.xml.ws.api.model.wsdl.WSDLPort;
044: import com.sun.xml.ws.util.Pool;
045:
046: import javax.xml.namespace.QName;
047: import javax.xml.ws.Dispatch;
048: import javax.xml.ws.Provider;
049: import java.lang.reflect.Method;
050: import java.util.Collection;
051:
052: /**
053: * Represents abstraction of SEI.
054: *
055: * <p>
056: * This interface would be used to access which Java concepts correspond to
057: * which WSDL concepts, such as which <code>wsdl:port</code> corresponds to
058: * a SEI, or which <code>wsdl:operation</code> corresponds to {@link JavaMethod}.
059: *
060: * <P>
061: * It also retains information about the databinding done for a SEI;
062: * such as {@link JAXBRIContext} and {@link Bridge}.
063: *
064: * <p>
065: * This model is constructed only when there is a Java SEI. Therefore it's
066: * not available with {@link Dispatch} or {@link Provider}. Technologies that
067: * need to work regardless of such surface API difference shall not be using
068: * this model.
069: *
070: * @author Vivek Pandey
071: */
072: public interface SEIModel {
073: Pool.Marshaller getMarshallerPool();
074:
075: /**
076: * JAXBContext that will be used to marshall/unmarshall the java classes found in the SEI.
077: *
078: * @return the <code>{@link JAXBRIContext}</code>
079: */
080: JAXBRIContext getJAXBContext();
081:
082: /**
083: * Get the Bridge associated with the {@link TypeReference}
084: *
085: * @param type
086: * @return the <code>{@link Bridge}</code> for the <code>type</code>
087: */
088: // Bridge getBridge(TypeReference type);
089: /**
090: * Its a known fault if the exception thrown by {@link Method} is annotated with the
091: * {@link javax.xml.ws.WebFault#name()} thas equal to the name passed as parameter.
092: *
093: * @param name is the qualified name of fault detail element as specified by wsdl:fault@element value.
094: * @param method is the Java {@link Method}
095: * @return true if <code>name</code> is the name
096: * of a known fault name for the <code>method</code>
097: */
098: // boolean isKnownFault(QName name, Method method);
099: /**
100: * Checks if the {@link JavaMethod} for the {@link Method} knowns the exception class.
101: *
102: * @param m {@link Method} to pickup the right {@link JavaMethod} model
103: * @param ex exception class
104: * @return true if <code>ex</code> is a Checked Exception
105: * for <code>m</code>
106: */
107: // boolean isCheckedException(Method m, Class ex);
108: /**
109: * This method will be useful to get the {@link JavaMethod} corrrespondiong to
110: * a {@link Method} - such as on the client side.
111: *
112: * @param method for which {@link JavaMethod} is asked for
113: * @return the {@link JavaMethod} representing the <code>method</code>
114: */
115: JavaMethod getJavaMethod(Method method);
116:
117: /**
118: * Gives a {@link JavaMethod} for a given {@link QName}. The {@link QName} will
119: * be equivalent to the SOAP Body or Header block or can simply be the name of an
120: * infoset that corresponds to the payload.
121: *
122: * @param name
123: * @return the <code>JavaMethod</code> associated with the
124: * operation named name
125: */
126: public JavaMethod getJavaMethod(QName name);
127:
128: /**
129: * Gives all the {@link JavaMethod} for a wsdl:port for which this {@link SEIModel} is
130: * created.
131: *
132: * @return a {@link Collection} of {@link JavaMethod}
133: * associated with the {@link SEIModel}
134: */
135: Collection<? extends JavaMethod> getJavaMethods();
136:
137: /**
138: * Location of the WSDL that defines the port associated with the {@link SEIModel}
139: *
140: * @return wsdl location uri - always non-null
141: */
142: @NotNull
143: String getWSDLLocation();
144:
145: /**
146: * wsdl:service qualified name for the port associated with the {@link SEIModel)
147: *
148: * @return wsdl:service@name value - always non-null
149: */
150: @NotNull
151: QName getServiceQName();
152:
153: /**
154: * Gets the {@link WSDLPort} that represents the port that this SEI binds to.
155: */
156: @NotNull
157: WSDLPort getPort();
158:
159: /**
160: * Value of the wsdl:port name associated with the {@link SEIModel)
161: *
162: * @return wsdl:service/wsdl:port@name value, always non-null
163: */
164: @NotNull
165: QName getPortName();
166:
167: /**
168: * Value of wsdl:portType bound to the port associated with the {@link SEIModel)
169: *
170: * @return
171: */
172: @NotNull
173: QName getPortTypeName();
174:
175: /**
176: * Gives the wsdl:binding@name value
177: */
178: @NotNull
179: QName getBoundPortTypeName();
180:
181: /**
182: * Namespace of the wsd;:port associated with the {@link SEIModel)
183: */
184: @NotNull
185: String getTargetNamespace();
186: }
|