org.openmdx.kernel.exception.Throwables Maven / Gradle / Ivy
/*
* ====================================================================
* Project: openMDX, http://www.openmdx.org/
* Description: Throwables
* Owner: OMEX AG, Switzerland, http://www.omex.ch
* ====================================================================
*
* This software is published under the BSD license as listed below.
*
* Copyright (c) 2004-2011, OMEX AG, Switzerland
* 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 openMDX team 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 COPYRIGHT HOLDERS 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 COPYRIGHT OWNER OR 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.
*
* ------------------
*
* This product includes or is based on software developed by other
* organizations as listed in the NOTICE file.
*/
package org.openmdx.kernel.exception;
import java.util.logging.Level;
import org.openmdx.kernel.exception.BasicException;
import org.openmdx.kernel.log.SysLog;
/**
* JRE dependent exception handling methods.
*/
public class Throwables {
private Throwables() {
// Avoid instantiation
}
/**
* Log the throwable at warning level.
*
* @param throwable
*
* @return the throwable
*/
public static T log(
T throwable
){
BasicException exceptionStack = BasicException.toExceptionStack(throwable);
SysLog.log(
Level.WARNING,
exceptionStack.getDescription(),
exceptionStack
);
return throwable;
}
/**
* Set a Throwable's exception stack.
*
* @param throwable A throwable from which the backtrace and other exception
* information is used.
* @param cause An embedded exception
* @param exceptionDomain An exception domain. A null objects references
* the default exception domain with negative exception codes only.
* @param exceptionCode An exception code. Negative codes describe common
* exceptions codes. Positive exception codes are specific for a given
* exception domain.
* @param parameters Any exception parameters, maybe null
*/
public static T initCause (
T throwable,
Throwable cause,
String exceptionDomain,
int exceptionCode,
BasicException.Parameter... parameters
) {
throwable.initCause(
new BasicException(
cause,
exceptionDomain,
exceptionCode,
parameters,
null,
throwable
)
);
return throwable;
}
/**
* Set a Throwable's exception stack.
*
* @param throwable A throwable from which the backtrace and other exception
* information is used.
* @param cause An embedded exception
* @param exceptionDomain An exception domain. A null objects references
* the default exception domain with negative exception codes only.
* @param exceptionCode An exception code. Negative codes describe common
* exceptions codes. Positive exception codes are specific for a given
* exception domain.
* @param description the detail message
* @param parameters Any exception parameters, maybe null
*/
public static T initCause (
T throwable,
Throwable cause,
String exceptionDomain,
int exceptionCode,
String description,
BasicException.Parameter... parameters
) {
throwable.initCause(
new BasicException(
cause,
exceptionDomain,
exceptionCode,
parameters,
description,
throwable
)
);
return throwable;
}
/**
* Returns the cause belonging to a specific exception domain.
*
* @param exceptionDomain
* the desired exception domain,
* or null to retrieve the initial cause.
*
* @return Either the cause belonging to a specific exception domain
* or the initial cause if exceptionDomain is
* null.
*/
public static BasicException getCause(
Throwable throwable,
String exceptionDomain
){
BasicException exceptionStack = null;
Cause: for(
Throwable cursor = throwable;
cursor != null;
cursor = cursor.getCause()
){
if(cursor instanceof BasicException) {
exceptionStack = (BasicException) cursor;
} else if(cursor instanceof BasicException.Holder) {
exceptionStack = ((BasicException.Holder)cursor).getCause();
} else {
continue Cause;
}
if(
exceptionDomain != null && (
exceptionDomain.equals(exceptionStack.getExceptionDomain()) || (
exceptionDomain.equals(BasicException.Code.DEFAULT_DOMAIN) &&
exceptionStack.getExceptionCode() <= 0
)
)
) return exceptionStack;
}
return exceptionDomain == null ? exceptionStack : null;
}
/**
* Compose the exception's message
*
* @param exception
*
* @return the exception message consisting of exception domain, exception
* code and description
*/
public static String getMessage(
BasicException.Holder exception
){
BasicException cause = exception.getCause();
if(cause == null) {
return null;
} else {
String message = cause.getMessage();
String description = cause.getDescription();
return description == null ? message : (message + ": " + description);
}
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy