org.josef.jpa

Class JpaLogUtil

java.lang.Object

org.josef.jpa.JpaLogUtil

@Status(stage=TEST,
        unitTests=ABSENT)
 @Review(by="Kees Schotanus",
        at="2011-05-12")
public final class JpaLogUtil
extends Object

JPA Log Utility Class.

Version:

1.0 $Revision: 6483 $

Author:

Kees Schotanus

Method Summary

Modifier and Type	Method and Description
static boolean	isEnabled(org.apache.logging.log4j.Level level) Determines whether a log message will be written when the supplied level is used.
static void	logAction(PersistAction action, String message) Logs the execution of the supplied action.
static void	logSuccessfulAction(PersistAction action, String message) Logs the successful execution of the supplied action.
static void	logUnsuccessfulAction(PersistAction action, org.apache.logging.log4j.Level logLevel, String message, Throwable cause) Logs the unsuccessful execution of the supplied action, using the supplied logLevel.
static void	logUnsuccessfulAction(PersistAction action, String message, Throwable cause) Logs the unsuccessful execution of the supplied action.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

isEnabled

public static boolean isEnabled(org.apache.logging.log4j.Level level)

Determines whether a log message will be written when the supplied level is used.

Parameters:

level - The log level to check whether it is loggable.

Returns:

True when loggable, otherwise false.

logAction

public static void logAction(PersistAction action,
                             String message)

Logs the execution of the supplied action.
The log level used is: Level.DEBUG.

Parameters:

action - The action to log.

message - The message to log.

logSuccessfulAction

public static void logSuccessfulAction(PersistAction action,
                                       String message)

Logs the successful execution of the supplied action.
The log level used is: Level.DEBUG.

Parameters:

action - The action to log.

message - The message to log.

logUnsuccessfulAction

public static void logUnsuccessfulAction(PersistAction action,
                                         String message,
                                         Throwable cause)

Logs the unsuccessful execution of the supplied action.
The log level used is: Level.ERROR.

Parameters:

action - The action to log.

message - The message to log.

cause - The throwable that caused the failure.

logUnsuccessfulAction

public static void logUnsuccessfulAction(PersistAction action,
                                         org.apache.logging.log4j.Level logLevel,
                                         String message,
                                         Throwable cause)

Logs the unsuccessful execution of the supplied action, using the supplied logLevel.

Parameters:

action - The action to log.

logLevel - The log level to use.

message - The message to log.

cause - The throwable that caused the failure.