src/share/jaxws_classes/com/sun/xml/internal/ws/api/model/CheckedException.java

Tue, 09 Apr 2013 14:51:13 +0100

author
alanb
date
Tue, 09 Apr 2013 14:51:13 +0100
changeset 368
0989ad8c0860
parent 286
f50545b5e2f1
child 637
9c07ef4934dd
permissions
-rw-r--r--

8010393: Update JAX-WS RI to 2.2.9-b12941
Reviewed-by: alanb, erikj
Contributed-by: miroslav.kos@oracle.com, martin.grebac@oracle.com

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

mercurial