View Javadoc
1   /*
2    * Copyright (c) 1997, 2012, 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  
30  import javax.xml.ws.WebFault;
31  import javax.xml.namespace.QName;
32  import java.rmi.RemoteException;
33  
34  /**
35   * This class provides abstractio to the  the exception class
36   * corresponding to the wsdl:fault, such as class MUST have
37   * {@link WebFault} annotation defined on it.
38   *
39   * Also the exception class must have
40   *
41   * <code>public WrapperException()String message, FaultBean){}</code>
42   *
43   * and method
44   *
45   * <code>public FaultBean getFaultInfo();</code>
46   *
47   * @author Vivek Pandey
48   */
49  public interface CheckedException {
50      /**
51       * Gets the root {@link SEIModel} that owns this model.
52       */
53      SEIModel getOwner();
54  
55      /**
56       * Gets the parent {@link JavaMethod} to which this checked exception belongs.
57       */
58      JavaMethod getParent();
59  
60      /**
61       * The returned exception class would be userdefined or WSDL exception class.
62       *
63       * @return
64       *      always non-null same object.
65       */
66      Class getExceptionClass();
67  
68      /**
69       * The detail bean is serialized inside the detail entry in the SOAP message.
70       * This must be known to the {@link javax.xml.bind.JAXBContext} inorder to get
71       * marshalled/unmarshalled.
72       *
73       * @return the detail bean
74       */
75      Class getDetailBean();
76  
77      /**
78       * Gives the {@link com.sun.xml.internal.bind.api.Bridge} associated with the detail
79       * @deprecated Why do you need this?
80       */
81      Bridge getBridge();
82  
83      /**
84       * Tells whether the exception class is a userdefined or a WSDL exception.
85       * A WSDL exception class follows the pattern defined in JSR 224. According to that
86       * a WSDL exception class must have:
87       *
88       * <code>public WrapperException()String message, FaultBean){}</code>
89       *
90       * and accessor method
91       *
92       * <code>public FaultBean getFaultInfo();</code>
93       */
94      ExceptionType getExceptionType();
95  
96      /**
97       * Gives the wsdl:portType/wsdl:operation/wsdl:fault@message value - that is the wsdl:message
98       * referenced by wsdl:fault
99       */
100     String getMessageName();
101 }