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.xml.bind.api.Bridge;
040:
041: import javax.xml.ws.WebFault;
042: import javax.xml.namespace.QName;
043: import java.rmi.RemoteException;
044:
045: /**
046: * This class provides abstractio to the the exception class
047: * corresponding to the wsdl:fault, such as class MUST have
048: * {@link WebFault} annotation defined on it.
049: *
050: * Also the exception class must have
051: *
052: * <code>public WrapperException()String message, FaultBean){}</code>
053: *
054: * and method
055: *
056: * <code>public FaultBean getFaultInfo();</code>
057: *
058: * @author Vivek Pandey
059: */
060: public interface CheckedException {
061: /**
062: * Gets the root {@link SEIModel} that owns this model.
063: */
064: SEIModel getOwner();
065:
066: /**
067: * Gets the parent {@link JavaMethod} to which this checked exception belongs.
068: */
069: JavaMethod getParent();
070:
071: /**
072: * The returned exception class would be userdefined or WSDL exception class.
073: *
074: * @return
075: * always non-null same object.
076: */
077: Class getExceptionClass();
078:
079: /**
080: * The detail bean is serialized inside the detail entry in the SOAP message.
081: * This must be known to the {@link javax.xml.bind.JAXBContext} inorder to get
082: * marshalled/unmarshalled.
083: *
084: * @return the detail bean
085: */
086: Class getDetailBean();
087:
088: /**
089: * Gives the {@link com.sun.xml.bind.api.Bridge} associated with the detail
090: */
091: Bridge getBridge();
092:
093: /**
094: * Tells whether the exception class is a userdefined or a WSDL exception.
095: * A WSDL exception class follows the pattern defined in JSR 224. According to that
096: * a WSDL exception class must have:
097: *
098: * <code>public WrapperException()String message, FaultBean){}</code>
099: *
100: * and accessor method
101: *
102: * <code>public FaultBean getFaultInfo();</code>
103: */
104: ExceptionType getExceptionType();
105:
106: /**
107: * Gives the wsdl:portType/wsdl:operation/wsdl:fault@message value - that is the wsdl:message
108: * referenced by wsdl:fault
109: */
110: String getMessageName();
111: }
|