Source for javax.management.MBeanException

   1: /* MBeanException.java -- A user-defined management exception.
   2:    Copyright (C) 2006 Free Software Foundation, Inc.
   3: 
   4: This file is part of GNU Classpath.
   5: 
   6: GNU Classpath is free software; you can redistribute it and/or modify
   7: it under the terms of the GNU General Public License as published by
   8: the Free Software Foundation; either version 2, or (at your option)
   9: any later version.
  10: 
  11: GNU Classpath is distributed in the hope that it will be useful, but
  12: WITHOUT ANY WARRANTY; without even the implied warranty of
  13: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14: General Public License for more details.
  15: 
  16: You should have received a copy of the GNU General Public License
  17: along with GNU Classpath; see the file COPYING.  If not, write to the
  18: Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19: 02110-1301 USA.
  20: 
  21: Linking this library statically or dynamically with other modules is
  22: making a combined work based on this library.  Thus, the terms and
  23: conditions of the GNU General Public License cover the whole
  24: combination.
  25: 
  26: As a special exception, the copyright holders of this library give you
  27: permission to link this library with independent modules to produce an
  28: executable, regardless of the license terms of these independent
  29: modules, and to copy and distribute the resulting executable under
  30: terms of your choice, provided that you also meet, for each linked
  31: independent module, the terms and conditions of the license of that
  32: module.  An independent module is a module which is not derived from
  33: or based on this library.  If you modify this library, you may extend
  34: this exception to your version of the library, but you are not
  35: obligated to do so.  If you do not wish to do so, delete this
  36: exception statement from your version. */
  37: 
  38: package javax.management;
  39: 
  40: /**
  41:  * Represents an arbitrary exception thrown by a management
  42:  * bean.  When a management bean executes code that causes
  43:  * an exception to be thrown, the resulting exception is
  44:  * wrapped inside an {@link MBeanException}.  Calling
  45:  * {@link getTargetException()} will return the wrapped
  46:  * exception.
  47:  *
  48:  * @author Andrew John Hughes (gnu_andrew@member.fsf.org)
  49:  * @since 1.5
  50:  */
  51: public class MBeanException
  52:   extends JMException
  53: {
  54: 
  55:   /**
  56:    * Compatible with JDK 1.5
  57:    */
  58:   private static final long serialVersionUID = 4066342430588744142L;
  59: 
  60:   /* Sun re-implemented causality -- don't know why, but
  61:      serialization demands we do too... */
  62: 
  63:   /**
  64:    * The target exception.
  65:    *
  66:    * @serial the target exception.
  67:    */
  68:   private Exception exception;
  69: 
  70:   /**
  71:    * Constructs a new <code>MBeanException</code> wrapping
  72:    * the specified exception.
  73:    *
  74:    * @param e the exception to be wrapped.
  75:    */
  76:   public MBeanException(Exception e)
  77:   {
  78:     super();
  79:     exception = e;
  80:   }
  81: 
  82:   /**
  83:    * Constructs a new <code>MBeanException</code> wrapping
  84:    * the specified exception and using the supplied message.
  85:    *
  86:    * @param e the exception to be wrapped.
  87:    * @param message the error message to give to the user.
  88:    */
  89:   public MBeanException(Exception e, String message)
  90:   {
  91:     super(message);
  92:     exception = e;
  93:   }
  94: 
  95:   /**
  96:    * Returns the true cause of this exception, the wrapped
  97:    * exception.
  98:    *
  99:    * @return the wrapped exception.
 100:    */
 101:   public Throwable getCause()
 102:   {
 103:     return exception;
 104:   }
 105: 
 106:   /**
 107:    * Returns the true cause of this exception, the wrapped
 108:    * exception.
 109:    *
 110:    * @return the wrapped exception.
 111:    */
 112:   public Exception getTargetException()
 113:   {
 114:     return exception;
 115:   }
 116: 
 117: }