org.mule.api.MuleException Maven / Gradle / Ivy
/*
* $Id: MuleException.java 24123 2012-03-22 04:24:37Z dfeist $
* --------------------------------------------------------------------------------------
* Copyright (c) MuleSoft, Inc. All rights reserved. http://www.mulesoft.com
*
* The software in this package is published under the terms of the CPAL v1.0
* license, a copy of which has been included with this distribution in the
* LICENSE.txt file.
*/
package org.mule.api;
import java.io.PrintWriter;
import java.io.StringWriter;
import java.util.HashMap;
import java.util.Iterator;
import java.util.Map;
import java.util.Set;
import org.mule.config.DefaultMuleConfiguration;
import org.mule.config.ExceptionHelper;
import org.mule.config.i18n.CoreMessages;
import org.mule.config.i18n.Message;
import org.mule.config.i18n.MessageFactory;
import org.mule.util.StringUtils;
import org.mule.util.SystemUtils;
/**
* MuleException is the base exception type for the Mule server any
* other exceptions thrown by Mule code will be based on this exception,
*/
public abstract class MuleException extends Exception
{
private final Map info = new HashMap();
private int errorCode = -1;
private String message = null;
private Message i18nMessage;
/**
* @param message the exception message
*/
public MuleException(Message message)
{
super();
setMessage(message);
}
/**
* @param message the exception message
* @param cause the exception that cause this exception to be thrown
*/
public MuleException(Message message, Throwable cause)
{
super(ExceptionHelper.unwrap(cause));
setMessage(message);
}
public MuleException(Throwable cause)
{
super(ExceptionHelper.unwrap(cause));
if (cause != null)
{
setMessage(MessageFactory.createStaticMessage(cause.getMessage() + " ("
+ cause.getClass().getName() + ")"));
}
else
{
initialise();
}
}
protected MuleException()
{
super();
initialise();
}
protected void setMessage(Message message)
{
initialise();
this.message = message.getMessage();
i18nMessage = message;
}
protected void setMessage(String message)
{
initialise();
this.message = message;
if (i18nMessage == null)
{
i18nMessage = MessageFactory.createStaticMessage(message);
}
}
public int getExceptionCode()
{
return errorCode;
}
public Message getI18nMessage()
{
return i18nMessage;
}
public int getMessageCode()
{
return (i18nMessage == null ? 0 : i18nMessage.getCode());
}
public void addInfo(String name, Object info)
{
this.info.put(name, info);
}
protected void appendMessage(String s)
{
message += s;
}
protected void prependMessage(String s)
{
message = message + ". " + s;
}
protected void setExceptionCode(int code)
{
errorCode = code;
}
@Override
public final String getMessage()
{
return message;
}
protected void initialise()
{
setExceptionCode(ExceptionHelper.getErrorCode(getClass()));
String javadoc = ExceptionHelper.getJavaDocUrl(getClass());
String doc = ExceptionHelper.getDocUrl(getClass());
if (javadoc != null)
{
// info.put(ClassHelper.getClassName(getClass()) + " JavaDoc", javadoc);
info.put("JavaDoc", javadoc);
}
if (doc != null)
{
// info.put(ClassHelper.getClassName(getClass()) + " Other Doc", doc);
info.put("Other Doc", doc);
}
}
public String getDetailedMessage()
{
if (DefaultMuleConfiguration.verboseExceptions)
{
return getVerboseMessage();
}
else
{
return getSummaryMessage();
}
}
public String getVerboseMessage()
{
MuleException e = ExceptionHelper.getRootMuleException(this);
if (!e.equals(this))
{
return getMessage();
}
StringBuffer buf = new StringBuffer(1024);
buf.append(SystemUtils.LINE_SEPARATOR).append(StringUtils.repeat('*', 80)).append(
SystemUtils.LINE_SEPARATOR);
buf.append("Message : ").append(message).append(SystemUtils.LINE_SEPARATOR);
buf.append("Type : ")
.append(getClass().getName())
.append(SystemUtils.LINE_SEPARATOR);
buf.append("Code : ").append("MULE_ERROR-").append(
getExceptionCode() + getMessageCode()).append(SystemUtils.LINE_SEPARATOR);
// buf.append("Msg Code :
// ").append(getMessageCode()).append(SystemUtils.LINE_SEPARATOR);
Map info = ExceptionHelper.getExceptionInfo(this);
for( Map.Entry entry : (Set)info.entrySet() )
{
String s = (String) entry.getKey();
int pad = 22 - s.length();
buf.append(s);
if (pad > 0)
{
buf.append(StringUtils.repeat(' ', pad));
}
buf.append(": ");
buf.append(entry.getValue()).append(SystemUtils.LINE_SEPARATOR);
}
// print exception stack
buf.append(StringUtils.repeat('*', 80)).append(SystemUtils.LINE_SEPARATOR);
buf.append(CoreMessages.exceptionStackIs()).append(SystemUtils.LINE_SEPARATOR);
buf.append(StringUtils.abbreviate(ExceptionHelper.getExceptionStack(this), 5000));
buf.append(StringUtils.repeat('*', 80)).append(SystemUtils.LINE_SEPARATOR);
buf.append(CoreMessages.rootStackTrace()).append(SystemUtils.LINE_SEPARATOR);
Throwable root = ExceptionHelper.getRootException(this);
StringWriter w = new StringWriter();
PrintWriter p = new PrintWriter(w);
root.printStackTrace(p);
buf.append(StringUtils.abbreviate(w.toString(), 5000)).append(SystemUtils.LINE_SEPARATOR);
buf.append(StringUtils.repeat('*', 80)).append(SystemUtils.LINE_SEPARATOR);
return buf.toString();
}
public String getSummaryMessage()
{
MuleException e = ExceptionHelper.getRootMuleException(this);
if (!e.equals(this))
{
return getMessage();
}
StringBuffer buf = new StringBuffer(1024);
buf.append(SystemUtils.LINE_SEPARATOR).append(StringUtils.repeat('*', 80)).append(
SystemUtils.LINE_SEPARATOR);
buf.append("Message : ").append(message).append(SystemUtils.LINE_SEPARATOR);
buf.append("Code : ").append("MULE_ERROR-").append(
getExceptionCode() + getMessageCode()).append(SystemUtils.LINE_SEPARATOR);
// print exception stack
buf.append(StringUtils.repeat('-', 80)).append(SystemUtils.LINE_SEPARATOR);
buf.append(CoreMessages.exceptionStackIs()).append(SystemUtils.LINE_SEPARATOR);
buf.append(StringUtils.abbreviate(ExceptionHelper.getExceptionStack(this), 5000));
buf.append(StringUtils.repeat('-', 80)).append(SystemUtils.LINE_SEPARATOR);
buf.append(CoreMessages.rootStackTrace()).append(SystemUtils.LINE_SEPARATOR);
Throwable root = ExceptionHelper.getRootException(this);
Throwable rootSummary = ExceptionHelper.summarise(root, 3);
StringWriter w = new StringWriter();
PrintWriter p = new PrintWriter(w);
rootSummary.printStackTrace(p);
buf.append(StringUtils.abbreviate(w.toString(), 5000));
buf.append(
" + "
+ root.getStackTrace().length
+ " more (set debug level logging or '-Dmule.verbose.exceptions=true' for everything)")
.append(SystemUtils.LINE_SEPARATOR);
buf.append(StringUtils.repeat('*', 80)).append(SystemUtils.LINE_SEPARATOR);
return buf.toString();
}
@Override
public boolean equals(Object o)
{
if (this == o)
{
return true;
}
if (!(o instanceof MuleException))
{
return false;
}
final MuleException exception = (MuleException) o;
if (errorCode != exception.errorCode)
{
return false;
}
if (i18nMessage != null ? !i18nMessage.equals(exception.i18nMessage) : exception.i18nMessage != null)
{
return false;
}
if (message != null ? !message.equals(exception.message) : exception.message != null)
{
return false;
}
return true;
}
@Override
public int hashCode()
{
int result;
result = errorCode;
result = 29 * result + (message != null ? message.hashCode() : 0);
result = 29 * result + (i18nMessage != null ? i18nMessage.hashCode() : 0);
return result;
}
public Map getInfo()
{
return info;
}
}