1 /* 2 * Copyright (c) 1997, 2014, Oracle and/or its affiliates. All rights reserved. 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * This code is free software; you can redistribute it and/or modify it 6 * under the terms of the GNU General Public License version 2 only, as 7 * published by the Free Software Foundation. Oracle designates this 8 * particular file as subject to the "Classpath" exception as provided 9 * by Oracle in the LICENSE file that accompanied this code. 10 * 11 * This code is distributed in the hope that it will be useful, but WITHOUT 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 14 * version 2 for more details (a copy is included in the LICENSE file that 15 * accompanied this code). 16 * 17 * You should have received a copy of the GNU General Public License version 18 * 2 along with this work; if not, write to the Free Software Foundation, 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 20 * 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 22 * or visit www.oracle.com if you need additional information or have any 23 * questions. 24 */ 25 26 package com.sun.xml.internal.ws.api.model; 27 28 import com.sun.xml.internal.bind.api.Bridge; 29 import com.sun.xml.internal.ws.spi.db.TypeInfo; 30 31 import javax.xml.ws.WebFault; 32 33 /** 34 * This class provides abstractio to the the exception class 35 * corresponding to the wsdl:fault, such as class MUST have 36 * {@link WebFault} annotation defined on it. 37 * 38 * Also the exception class must have 39 * 40 * <code>public WrapperException()String message, FaultBean){}</code> 41 * 42 * and method 43 * 44 * <code>public FaultBean getFaultInfo();</code> 45 * 46 * @author Vivek Pandey 47 */ 48 public interface CheckedException { 49 /** 50 * Gets the root {@link SEIModel} that owns this model. 51 */ 52 SEIModel getOwner(); 53 54 /** 55 * Gets the parent {@link JavaMethod} to which this checked exception belongs. 56 */ 57 JavaMethod getParent(); 58 59 /** 60 * The returned exception class would be userdefined or WSDL exception class. 61 * 62 * @return 63 * always non-null same object. 64 */ 65 Class getExceptionClass(); 66 67 /** 68 * The detail bean is serialized inside the detail entry in the SOAP message. 69 * This must be known to the {@link javax.xml.bind.JAXBContext} inorder to get 70 * marshalled/unmarshalled. 71 * 72 * @return the detail bean 73 */ 74 Class getDetailBean(); 75 76 /** 77 * Gives the {@link com.sun.xml.internal.bind.api.Bridge} associated with the detail 78 * @deprecated Why do you need this? 79 */ 80 Bridge getBridge(); 81 82 /** 83 * Tells whether the exception class is a userdefined or a WSDL exception. 84 * A WSDL exception class follows the pattern defined in JSR 224. According to that 85 * a WSDL exception class must have: 86 * 87 * <code>public WrapperException()String message, FaultBean){}</code> 88 * 89 * and accessor method 90 * 91 * <code>public FaultBean getFaultInfo();</code> 92 */ 93 ExceptionType getExceptionType(); 94 95 /** 96 * Gives the wsdl:portType/wsdl:operation/wsdl:fault@message value - that is the wsdl:message 97 * referenced by wsdl:fault 98 */ 99 String getMessageName(); 100 101 /** 102 * Gives the {@link com.sun.xml.internal.ws.spi.db.TypeInfo} of the detail 103 */ 104 TypeInfo getDetailType(); 105 }