/* * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as * published by the Free Software Foundation. Oracle designates this * particular file as subject to the "Classpath" exception as provided * by Oracle in the LICENSE file that accompanied this code. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License * version 2 for more details (a copy is included in the LICENSE file that * accompanied this code). * * You should have received a copy of the GNU General Public License version * 2 along with this work; if not, write to the Free Software Foundation, * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. * * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA * or visit www.oracle.com if you need additional information or have any * questions. */ package com.sun.xml.internal.ws.api.model; import com.sun.istack.internal.NotNull; import com.sun.xml.internal.bind.api.Bridge; import com.sun.xml.internal.bind.api.JAXBRIContext; import com.sun.xml.internal.bind.api.TypeReference; import com.sun.xml.internal.ws.api.model.wsdl.WSDLPort; import com.sun.xml.internal.ws.util.Pool; import javax.xml.bind.JAXBContext; import javax.xml.namespace.QName; import javax.xml.ws.Dispatch; import javax.xml.ws.Provider; import java.lang.reflect.Method; import java.util.Collection; /** * Represents abstraction of SEI. * *
* This interface would be used to access which Java concepts correspond to
* which WSDL concepts, such as which wsdl:port
corresponds to
* a SEI, or which wsdl:operation
corresponds to {@link JavaMethod}.
*
*
* It also retains information about the databinding done for a SEI; * such as {@link JAXBRIContext} and {@link Bridge}. * *
* This model is constructed only when there is a Java SEI. Therefore it's
* not available with {@link Dispatch} or {@link Provider}. Technologies that
* need to work regardless of such surface API difference shall not be using
* this model.
*
* @author Vivek Pandey
*/
public interface SEIModel {
Pool.Marshaller getMarshallerPool();
/**
* JAXBContext that will be used to marshall/unmarshall the java classes found in the SEI.
*
* @return the {@link JAXBRIContext}
* @deprecated Why do you need this?
*/
JAXBContext getJAXBContext();
/**
* Get the Bridge associated with the {@link TypeReference}
*
* @param type
* @return the {@link Bridge}
for the type
*/
// Bridge getBridge(TypeReference type);
/**
* Its a known fault if the exception thrown by {@link Method} is annotated with the
* {@link javax.xml.ws.WebFault#name()} thas equal to the name passed as parameter.
*
* @param name is the qualified name of fault detail element as specified by wsdl:fault@element value.
* @param method is the Java {@link Method}
* @return true if name
is the name
* of a known fault name for the method
*/
// boolean isKnownFault(QName name, Method method);
/**
* Checks if the {@link JavaMethod} for the {@link Method} knowns the exception class.
*
* @param m {@link Method} to pickup the right {@link JavaMethod} model
* @param ex exception class
* @return true if ex
is a Checked Exception
* for m
*/
// boolean isCheckedException(Method m, Class ex);
/**
* This method will be useful to get the {@link JavaMethod} corrrespondiong to
* a {@link Method} - such as on the client side.
*
* @param method for which {@link JavaMethod} is asked for
* @return the {@link JavaMethod} representing the method
*/
JavaMethod getJavaMethod(Method method);
/**
* Gives a {@link JavaMethod} for a given {@link QName}. The {@link QName} will
* be equivalent to the SOAP Body or Header block or can simply be the name of an
* infoset that corresponds to the payload.
* @param name
* @return the JavaMethod
associated with the
* operation named name
*/
public JavaMethod getJavaMethod(QName name);
/**
* Gives the JavaMethod associated with the wsdl operation
* @param operationName QName of the wsdl operation
* @return
*/
public JavaMethod getJavaMethodForWsdlOperation(QName operationName);
/**
* Gives all the {@link JavaMethod} for a wsdl:port for which this {@link SEIModel} is
* created.
*
* @return a {@link Collection} of {@link JavaMethod}
* associated with the {@link SEIModel}
*/
Collection extends JavaMethod> getJavaMethods();
/**
* Location of the WSDL that defines the port associated with the {@link SEIModel}
*
* @return wsdl location uri - always non-null
*/
@NotNull String getWSDLLocation();
/**
* wsdl:service qualified name for the port associated with the {@link SEIModel}
*
* @return wsdl:service@name value - always non-null
*/
@NotNull QName getServiceQName();
/**
* Gets the {@link WSDLPort} that represents the port that this SEI binds to.
*/
@NotNull WSDLPort getPort();
/**
* Value of the wsdl:port name associated with the {@link SEIModel}
*
* @return wsdl:service/wsdl:port@name value, always non-null
*/
@NotNull QName getPortName();
/**
* Value of wsdl:portType bound to the port associated with the {@link SEIModel}
*
* @return
*/
@NotNull QName getPortTypeName();
/**
* Gives the wsdl:binding@name value
*/
@NotNull QName getBoundPortTypeName();
/**
* Namespace of the wsd;:port associated with the {@link SEIModel}
*/
@NotNull String getTargetNamespace();
}