001/* MBeanException.java -- A user-defined management exception.
002   Copyright (C) 2006 Free Software Foundation, Inc.
003
004This file is part of GNU Classpath.
005
006GNU Classpath is free software; you can redistribute it and/or modify
007it under the terms of the GNU General Public License as published by
008the Free Software Foundation; either version 2, or (at your option)
009any later version.
010
011GNU Classpath is distributed in the hope that it will be useful, but
012WITHOUT ANY WARRANTY; without even the implied warranty of
013MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014General Public License for more details.
015
016You should have received a copy of the GNU General Public License
017along with GNU Classpath; see the file COPYING.  If not, write to the
018Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
01902110-1301 USA.
020
021Linking this library statically or dynamically with other modules is
022making a combined work based on this library.  Thus, the terms and
023conditions of the GNU General Public License cover the whole
024combination.
025
026As a special exception, the copyright holders of this library give you
027permission to link this library with independent modules to produce an
028executable, regardless of the license terms of these independent
029modules, and to copy and distribute the resulting executable under
030terms of your choice, provided that you also meet, for each linked
031independent module, the terms and conditions of the license of that
032module.  An independent module is a module which is not derived from
033or based on this library.  If you modify this library, you may extend
034this exception to your version of the library, but you are not
035obligated to do so.  If you do not wish to do so, delete this
036exception statement from your version. */
037
038package javax.management;
039
040/**
041 * Represents an arbitrary exception thrown by a management
042 * bean.  When a management bean executes code that causes
043 * an exception to be thrown, the resulting exception is
044 * wrapped inside an {@link MBeanException}.  Calling
045 * {@link getTargetException()} will return the wrapped
046 * exception.
047 *
048 * @author Andrew John Hughes (gnu_andrew@member.fsf.org)
049 * @since 1.5
050 */
051public class MBeanException
052  extends JMException
053{
054
055  /**
056   * Compatible with JDK 1.5
057   */
058  private static final long serialVersionUID = 4066342430588744142L;
059
060  /* Sun re-implemented causality -- don't know why, but
061     serialization demands we do too... */
062
063  /**
064   * The target exception.
065   *
066   * @serial the target exception.
067   */
068  private Exception exception;
069
070  /**
071   * Constructs a new <code>MBeanException</code> wrapping
072   * the specified exception.
073   *
074   * @param e the exception to be wrapped.
075   */
076  public MBeanException(Exception e)
077  {
078    super();
079    exception = e;
080  }
081
082  /**
083   * Constructs a new <code>MBeanException</code> wrapping
084   * the specified exception and using the supplied message.
085   *
086   * @param e the exception to be wrapped.
087   * @param message the error message to give to the user.
088   */
089  public MBeanException(Exception e, String message)
090  {
091    super(message);
092    exception = e;
093  }
094
095  /**
096   * Returns the true cause of this exception, the wrapped
097   * exception.
098   *
099   * @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}