/*
* $Id$
*
* Copyright 2006, The jCoderZ.org Project. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are
* met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the following
* disclaimer in the documentation and/or other materials
* provided with the distribution.
* * Neither the name of the jCoderZ.org Project nor the names of
* its contributors may be used to endorse or promote products
* derived from this software without specific prior written
* permission.
*
* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS "AS IS" AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
* BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
* OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
* ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jcoderz.commons;
import java.io.Serializable;
import java.util.List;
import java.util.Set;
import java.util.logging.Logger;
/**
* This is the Base class for all runtime exceptions.
*
* <p>In the {@link org.jcoderz.commons package overview} you can find a
* general statement when to use runtime exceptions.</p>
*
* <p>This class can never be directly used. Services must implement a
* general service specific Exception from which they can derive more
* concrete service specific exceptions. There are some common used
* exceptions available as direct subclasses of this class. If
* appropriate this classes must be used prior generating own
* classes.</p>
*
* <p>Most functionality is implemented and documented by the
* {@link org.jcoderz.commons.LoggableImpl} which is used a member of
* objects of this class. Other stuff is handled by the base class
* {@link java.lang.Exception}.</p>
*
*
* @see org.jcoderz.commons
* @author Andreas Mandel
*/
public class BaseRuntimeException
extends RuntimeException
implements Loggable
{
private static final long serialVersionUID = 2L;
private static final String CLASSNAME = BaseRuntimeException.class.getName();
private static final Logger LOGGER = Logger.getLogger(CLASSNAME);
/** The loggable implementation. */
private final LoggableImpl mLoggable;
/**
* Constructor getting an log message info.
*
* @param messageInfo the log message info for this exception
*/
protected BaseRuntimeException (LogMessageInfo messageInfo)
{
super(messageInfo.getSymbol());
mLoggable = new LoggableImpl(this, messageInfo);
}
/**
* Constructor getting an log message info and a root exception.
*
* @param messageInfo the log message info for this exception
* @param cause the problem that caused this exception to be thrown
*/
protected BaseRuntimeException (LogMessageInfo messageInfo, Throwable cause)
{
super(messageInfo.getSymbol(), cause);
mLoggable = new LoggableImpl(this, messageInfo, cause);
}
/** {@inheritDoc} */
public Throwable initCause (Throwable cause)
{
super.initCause(cause);
mLoggable.initCause(cause);
return this;
}
/** {@inheritDoc} */
public final void addParameter (String name, Serializable value)
{
mLoggable.addParameter(name, value);
}
/** {@inheritDoc} */
public String getInstanceId ()
{
return mLoggable.getInstanceId();
}
/** {@inheritDoc} */
public final String getMessage ()
{
return mLoggable.getMessage();
}
/** {@inheritDoc} */
public final void log ()
{
mLoggable.log();
}
/** {@inheritDoc} */
public Throwable getCause ()
{
return mLoggable.getCause();
}
/** {@inheritDoc} */
public long getEventTime ()
{
return mLoggable.getEventTime();
}
/** {@inheritDoc} */
public LogMessageInfo getLogMessageInfo ()
{
return mLoggable.getLogMessageInfo();
}
/** {@inheritDoc} */
public String getNodeId ()
{
return mLoggable.getNodeId();
}
/** {@inheritDoc} */
public List getParameter (String name)
{
return mLoggable.getParameter(name);
}
/** {@inheritDoc} */
public Set getParameterNames ()
{
return mLoggable.getParameterNames();
}
/** {@inheritDoc} */
public long getThreadId ()
{
return mLoggable.getThreadId();
}
/** {@inheritDoc} */
public String getTrackingNumber ()
{
return mLoggable.getTrackingNumber();
}
/** {@inheritDoc} */
public String getSourceClass ()
{
return mLoggable.getSourceClass();
}
/** {@inheritDoc} */
public String getSourceMethod ()
{
return mLoggable.getSourceMethod();
}
/** {@inheritDoc} */
public String getThreadName ()
{
return mLoggable.getThreadName();
}
/** {@inheritDoc} */
public String toString ()
{
return mLoggable.toString();
}
/** {@inheritDoc} */
public String toDetailedString ()
{
return mLoggable.toDetailedString();
}
protected final void logCreation ()
{
if (LOGGER.isLoggable(
RteLogMessage.RuntimeExceptionCreated.LOG_LEVEL))
{
final LogEvent logEvent
= new LogEvent(RteLogMessage.RUNTIME_EXCEPTION_CREATED, this);
RteLogMessage.ExceptionCreated.addParameters(
logEvent, mLoggable.getLogMessageInfo().getSymbol(),
mLoggable.getMessage());
LOGGER.logp(logEvent.getLogMessageInfo().getLogLevel(),
logEvent.getSourceClass(), logEvent.getSourceMethod(),
logEvent.getMessage(), logEvent);
}
}
LoggableImpl getExceptionImpl ()
{
return mLoggable;
}
}