src/share/jaxws_classes/com/sun/xml/internal/ws/api/message/ExceptionHasMessage.java

Print this page


   1 /*
   2  * Copyright (c) 1997, 2010, 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.message;
  27 
  28 import com.sun.xml.internal.ws.util.exception.JAXWSExceptionBase;
  29 import com.sun.xml.internal.ws.protocol.soap.VersionMismatchException;
  30 
  31 /**
  32  * This class represents an Exception that needs to be marshalled
  33  * with a specific protocol wire format. For example, the SOAP's
  34  * VersionMismatchFault needs to be written with a correct fault code.
  35  * In that case, decoder could throw {@link VersionMismatchException},
  36  * and the correspoinding fault {@link Message} from {@link ExceptionHasMessage::getFaultMessage}
  37  * is sent on the wire.
  38  *
  39  * @author Jitendra Kotamraju
  40  */
  41 public abstract class ExceptionHasMessage extends JAXWSExceptionBase {
  42 
  43     public ExceptionHasMessage(String key, Object... args) {
  44         super(key, args);
  45     }
  46 
  47     /**
  48      * Returns the exception into a fault Message
  49      *
  50      * @return Message for this exception
  51      */
  52     public abstract Message getFaultMessage();
  53 }
   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.message;
  27 
  28 import com.sun.xml.internal.ws.util.exception.JAXWSExceptionBase;
  29 import com.sun.xml.internal.ws.protocol.soap.VersionMismatchException;
  30 
  31 /**
  32  * This class represents an Exception that needs to be marshalled
  33  * with a specific protocol wire format. For example, the SOAP's
  34  * VersionMismatchFault needs to be written with a correct fault code.
  35  * In that case, decoder could throw {@link VersionMismatchException},
  36  * and the corresponding fault {@link Message} from {@link ExceptionHasMessage#getFaultMessage()}
  37  * is sent on the wire.
  38  *
  39  * @author Jitendra Kotamraju
  40  */
  41 public abstract class ExceptionHasMessage extends JAXWSExceptionBase {
  42 
  43     public ExceptionHasMessage(String key, Object... args) {
  44         super(key, args);
  45     }
  46 
  47     /**
  48      * Returns the exception into a fault Message
  49      *
  50      * @return Message for this exception
  51      */
  52     public abstract Message getFaultMessage();
  53 }