com.sun.jbi.ui.common.JBIRemoteException Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jbi-admin-common Show documentation
The "jbi-admin-common" Common CLI code
The newest version!
/*
 * BEGIN_HEADER - DO NOT EDIT
 *
 * The contents of this file are subject to the terms
 * of the Common Development and Distribution License
 * (the "License").  You may not use this file except
 * in compliance with the License.
 *
 * You can obtain a copy of the license at
 * https://open-esb.dev.java.net/public/CDDLv1.0.html.
 * See the License for the specific language governing
 * permissions and limitations under the License.
 *
 * When distributing Covered Code, include this CDDL
 * HEADER in each file and include the License file at
 * https://open-esb.dev.java.net/public/CDDLv1.0.html.
 * If applicable add the following below this CDDL HEADER,
 * with the fields enclosed by brackets "[]" replaced with
 * your own identifying information: Portions Copyright
 * [year] [name of copyright owner]
 */

/*
 * @(#)JBIRemoteException.java
 * Copyright 2004-2007 Sun Microsystems, Inc. All Rights Reserved.
 *
 * END_HEADER - DO NOT EDIT
 */
package com.sun.jbi.ui.common;

import java.io.PrintStream;
import java.io.PrintWriter;
import java.io.Serializable;
import java.io.StringWriter;
import java.util.ArrayList;
import javax.management.MBeanException;
import javax.management.RuntimeMBeanException;
import javax.management.RuntimeOperationsException;

/**
 * A Remote Exception class that saves the cause exception stack trace in a
 * buffer for serialization. By throwing this exception on jmx server side on
 * mbean operations and attributes, we don't have to include the cause exception
 * classes on the client side. This class also allows the server side code to
 * add error code, so that the remote client can get the error code and display
 * the message from its local bundle.
 * 
 * @author graj
 */

public class JBIRemoteException extends Exception implements Serializable {
    /** aCuase StackTrace */
    protected StringBuffer mCauseStackTrace;

    /** aCuase Message trace */
    protected String[] mCauseMessageTrace;

    /**
     * Determines if a de-serialized file is compatible with this class.
     * 
     * 1. Run serialver -show from the command line 
     * 2. Point the tool to the class file including the package, 
     * for example:
     * com.sun.jbi.ui.common.JBIRemoteException - without the .class The
     * serialver docs for Windows OS is at:
     * http://java.sun.com/j2se/1.5.0/docs/tooldocs/windows/serialver.html and
     * Unix OS is at:
     * http://java.sun.com/j2se/1.5.0/docs/tooldocs/solaris/serialver.html
     * 
     * Maintainers must change this value if and only if the new version of this
     * class is not compatible with old versions. See Sun docs for  details. 
     */
    static final long serialVersionUID = 4431187824092164710L;

    /**
     * Creates a new instance of JBIException with an exception message.
     * 
     * @param aMessage
     *            String describing this exception.
     */
    public JBIRemoteException(String aMessage) {
        this(aMessage, (Throwable) null);
    }

    /**
     * Creates a new instance of JBIException with the specified cause.
     * 
     * @param aCause
     *            Throwable which represents an underlying problem (or null).
     */
    public JBIRemoteException(Throwable aCause) {
        this((String) null, aCause);
    }

    /**
     * Creates a new instance of JBIException with the specified message and
     * cause.
     * 
     * @param aMessage
     *            String describing this exception.
     * @param aCause
     *            Throwable which represents an underlying problem (or null).
     */
    public JBIRemoteException(String aMessage, Throwable aCause) {
        super(aMessage);
        initCauseTrace(aCause);
        // if ( aCause != null )
        // {
        // aCause.printStackTrace();
        // }
    }

    /**
     * Creates a new instance of JBIException.
     * 
     * @param exception
     */
    public JBIRemoteException(JBIRemoteException exception) {
        this.mCauseMessageTrace = exception.getCauseMessageTrace();
        this.mCauseStackTrace = exception.getCauseStackTrace();
    }

    /**
     * initializes the stacktrace and messages from cause
     * 
     * @param aCause
     *            a cause
     */
    public void initCauseTrace(Throwable aCause) {
        this.mCauseStackTrace = null;
        this.mCauseMessageTrace = null;
        if (aCause == null) {
            return;
        }

        // save the stack trace
        StringWriter traceWriter = new StringWriter();
        PrintWriter printWriter = new PrintWriter(traceWriter);
        aCause.printStackTrace(printWriter);
        printWriter.close();
        this.mCauseStackTrace = traceWriter.getBuffer();

        ArrayList list = new ArrayList();

        for (Throwable nextCause = aCause; nextCause != null; nextCause = nextCause
                .getCause()) {
            list.add(nextCause.getMessage());
        }
        this.mCauseMessageTrace = (String[]) list.toArray(new String[0]);
    }

    /**
     * Returns the detail message string of this throwable.
     * 
     * @return the detail message string of this Throwable instance
     *         (which may be null). + the cause messages
     */
    public String getMessage() {
        String mainMsg = super.getMessage();

        if (this.mCauseMessageTrace == null
                || this.mCauseMessageTrace.length <= 0) {
            return mainMsg;
        }

        boolean hasMainMsg = (mainMsg != null);

        StringWriter stringWriter = new StringWriter();
        PrintWriter msgWriter = new PrintWriter(stringWriter);
        if (hasMainMsg) {
            msgWriter.println(mainMsg);
            msgWriter.print(Util.getCommonI18NBundle().getMessage(
                    "jbi.remote.exception.msg.root.cause.msg",
                    this.mCauseMessageTrace[0]));
        } else {
            msgWriter.print(this.mCauseMessageTrace[0]);
        }

        for (int i = 1; i < this.mCauseMessageTrace.length; ++i) {
            msgWriter.println();
            msgWriter.print(Util.getCommonI18NBundle().getMessage(
                    "jbi.remote.exception.msg.root.cause.msg",
                    this.mCauseMessageTrace[i]));
        }
        msgWriter.close();
        return stringWriter.toString();
    }

    /**
     * gets the cuase trace in a string buffer
     * 
     * @return trace in a string buffer
     */
    public String[] getCauseMessageTrace() {
        return this.mCauseMessageTrace;
    }

    /**
     * gets the cuase trace in a string buffer
     * 
     * @return trace in a string buffer
     */
    public StringBuffer getCauseStackTrace() {
        return this.mCauseStackTrace;
    }

    /**
     * override method
     * 
     * @param s
     *            writer
     */
    public void printStackTrace(PrintWriter s) {
        super.printStackTrace(s);
        // s.println("Error Code : " + this.mErrorCode);
        synchronized (s) {
            if (this.mCauseStackTrace != null) {
                s.println(this.mCauseStackTrace.toString());
            }
        }
    }

    /**
     * override method
     * 
     * @param s
     *            stream
     */
    public void printStackTrace(PrintStream s) {
        super.printStackTrace(s);
        // s.println("Error Code : " + this.mErrorCode);
        synchronized (s) {
            if (this.mCauseStackTrace != null) {
                s.println(this.mCauseStackTrace.toString());
            }
        }
    }

    /**
     * retrieves the exception message and try to construct the jbi mgmt message
     * 
     * @return JBIManagementMessage object
     */
    public JBIManagementMessage extractJBIManagementMessage() {
        String exMessage = null;
        String[] msgs = getCauseMessageTrace();
        if (msgs != null && msgs.length > 0) {
            exMessage = msgs[0];
        }

        if (exMessage == null) {
            return null;
        }

        JBIManagementMessage mgmtMsg = JBIManagementMessage
                .createJBIManagementMessage(exMessage);

        return mgmtMsg;
    }

    /**
     * filters the jmx exception and wraps the root cause user exception int the
     * JBIRemoteException
     * 
     * @param jmxEx
     *            exception
     * @return remote exception
     */
    public static JBIRemoteException filterJmxExceptions(Exception jmxEx) {
        Throwable rootCause = jmxEx;
        Throwable cause = rootCause;
        for (;;) {
            if (cause == null
                    || !(cause instanceof MBeanException
                            || cause instanceof RuntimeMBeanException || cause instanceof RuntimeOperationsException)) {
                break;
            }
            rootCause = cause.getCause();
            cause = rootCause;
        }
        if (rootCause instanceof JBIRemoteException) {
            return (JBIRemoteException) rootCause;
        } else {
            return new JBIRemoteException(rootCause);
        }
    }

}