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

changeset 286
f50545b5e2f1
child 368
0989ad8c0860
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/src/share/jaxws_classes/com/sun/xml/internal/ws/api/model/CheckedException.java	Tue Mar 06 16:09:35 2012 -0800
     1.3 @@ -0,0 +1,101 @@
     1.4 +/*
     1.5 + * Copyright (c) 1997, 2010, Oracle and/or its affiliates. All rights reserved.
     1.6 + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
     1.7 + *
     1.8 + * This code is free software; you can redistribute it and/or modify it
     1.9 + * under the terms of the GNU General Public License version 2 only, as
    1.10 + * published by the Free Software Foundation.  Oracle designates this
    1.11 + * particular file as subject to the "Classpath" exception as provided
    1.12 + * by Oracle in the LICENSE file that accompanied this code.
    1.13 + *
    1.14 + * This code is distributed in the hope that it will be useful, but WITHOUT
    1.15 + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    1.16 + * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
    1.17 + * version 2 for more details (a copy is included in the LICENSE file that
    1.18 + * accompanied this code).
    1.19 + *
    1.20 + * You should have received a copy of the GNU General Public License version
    1.21 + * 2 along with this work; if not, write to the Free Software Foundation,
    1.22 + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
    1.23 + *
    1.24 + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
    1.25 + * or visit www.oracle.com if you need additional information or have any
    1.26 + * questions.
    1.27 + */
    1.28 +
    1.29 +package com.sun.xml.internal.ws.api.model;
    1.30 +
    1.31 +import com.sun.xml.internal.bind.api.Bridge;
    1.32 +
    1.33 +import javax.xml.ws.WebFault;
    1.34 +import javax.xml.namespace.QName;
    1.35 +import java.rmi.RemoteException;
    1.36 +
    1.37 +/**
    1.38 + * This class provides abstractio to the  the exception class
    1.39 + * corresponding to the wsdl:fault, such as class MUST have
    1.40 + * {@link WebFault} annotation defined on it.
    1.41 + *
    1.42 + * Also the exception class must have
    1.43 + *
    1.44 + * <code>public WrapperException()String message, FaultBean){}</code>
    1.45 + *
    1.46 + * and method
    1.47 + *
    1.48 + * <code>public FaultBean getFaultInfo();</code>
    1.49 + *
    1.50 + * @author Vivek Pandey
    1.51 + */
    1.52 +public interface CheckedException {
    1.53 +    /**
    1.54 +     * Gets the root {@link SEIModel} that owns this model.
    1.55 +     */
    1.56 +    SEIModel getOwner();
    1.57 +
    1.58 +    /**
    1.59 +     * Gets the parent {@link JavaMethod} to which this checked exception belongs.
    1.60 +     */
    1.61 +    JavaMethod getParent();
    1.62 +
    1.63 +    /**
    1.64 +     * The returned exception class would be userdefined or WSDL exception class.
    1.65 +     *
    1.66 +     * @return
    1.67 +     *      always non-null same object.
    1.68 +     */
    1.69 +    Class getExceptionClass();
    1.70 +
    1.71 +    /**
    1.72 +     * The detail bean is serialized inside the detail entry in the SOAP message.
    1.73 +     * This must be known to the {@link javax.xml.bind.JAXBContext} inorder to get
    1.74 +     * marshalled/unmarshalled.
    1.75 +     *
    1.76 +     * @return the detail bean
    1.77 +     */
    1.78 +    Class getDetailBean();
    1.79 +
    1.80 +    /**
    1.81 +     * Gives the {@link com.sun.xml.internal.bind.api.Bridge} associated with the detail
    1.82 +     * @deprecated Why do you need this?
    1.83 +     */
    1.84 +    Bridge getBridge();
    1.85 +
    1.86 +    /**
    1.87 +     * Tells whether the exception class is a userdefined or a WSDL exception.
    1.88 +     * A WSDL exception class follows the pattern defined in JSR 224. According to that
    1.89 +     * a WSDL exception class must have:
    1.90 +     *
    1.91 +     * <code>public WrapperException()String message, FaultBean){}</code>
    1.92 +     *
    1.93 +     * and accessor method
    1.94 +     *
    1.95 +     * <code>public FaultBean getFaultInfo();</code>
    1.96 +     */
    1.97 +    ExceptionType getExceptionType();
    1.98 +
    1.99 +    /**
   1.100 +     * Gives the wsdl:portType/wsdl:operation/wsdl:fault@message value - that is the wsdl:message
   1.101 +     * referenced by wsdl:fault
   1.102 +     */
   1.103 +    String getMessageName();
   1.104 +}

mercurial