org.gridgain.grid.logger.java

Class GridJavaLogger

java.lang.Object

org.gridgain.grid.util.lang.GridMetadataAwareAdapter

org.gridgain.grid.logger.java.GridJavaLogger

All Implemented Interfaces:

Serializable, GridMetadataAware, GridLogger, GridLoggerNodeIdAware

public class GridJavaLogger
extends GridMetadataAwareAdapter
implements GridLogger, GridLoggerNodeIdAware

Logger to use with Java logging. Implementation simply delegates to Java Logging.

Here is an example of configuring Java logger in GridGain configuration Spring file to work over log4j implementation. Note that we use the same configuration file as we provide by default:

      ...
      <property name="gridLogger">
          <bean class="org.gridgain.grid.logger.java.GridJavaLogger">
              <constructor-arg type="java.util.logging.Logger">
                  <bean class="java.util.logging.Logger">
                      <constructor-arg type="java.lang.String" value="global"/>
                  </bean>
              </constructor-arg>
          </bean>
      </property>
      ...
 

or

      ...
      <property name="gridLogger">
          <bean class="org.gridgain.grid.logger.java.GridJavaLogger"/>
      </property>
      ...
 

And the same configuration if you'd like to configure GridGain in your code:

      GridConfiguration cfg = new GridConfiguration();
      ...
      GridLogger log = new GridJavaLogger(Logger.global);
      ...
      cfg.setGridLogger(log);
 

or which is actually the same:

      GridConfiguration cfg = new GridConfiguration();
      ...
      GridLogger log = new GridJavaLogger();
      ...
      cfg.setGridLogger(log);
 

Please take a look at GridLoggerResource annotation about logger injection.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GridJavaLogger() Creates new logger.
GridJavaLogger(boolean init) Creates new logger.
GridJavaLogger(Logger impl) Creates new logger with given implementation.

Method Summary

Methods

Modifier and Type	Method and Description
void	debug(String msg) Logs out debug message.
void	error(String msg) Logs out error message.
void	error(String msg, Throwable e) Logs error message with optional exception.
String	fileName() Gets name of the file being logged to if one is configured or null otherwise.
GridLogger	getLogger(Object ctgr) Creates new logger with given category based off the current instance.
UUID	getNodeId() Gets node ID.
void	info(String msg) Logs out information message.
static boolean	isConfigured() Checks if logger is already configured within this VM or not.
boolean	isDebugEnabled() Tests whether debug level is enabled.
boolean	isInfoEnabled() Tests whether info level is enabled.
boolean	isQuiet() Tests whether info and debug levels are turned off.
boolean	isTraceEnabled() Tests whether trace level is enabled.
void	setNodeId(UUID nodeId) Sets node ID.
void	trace(String msg) Logs out trace message.
void	warning(String msg) Logs out warning message.
void	warning(String msg, Throwable e) Logs out warning message with optional exception.

Methods inherited from class org.gridgain.grid.util.lang.GridMetadataAwareAdapter

addMeta, addMetaIfAbsent, addMetaIfAbsent, allMeta, clone, copyMeta, copyMeta, hasMeta, hasMeta, meta, putMetaIfAbsent, putMetaIfAbsent, readExternalMeta, removeMeta, removeMeta, replaceMeta, writeExternalMeta

Methods inherited from class java.lang.Object

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

Constructor Detail

GridJavaLogger

public GridJavaLogger()

Creates new logger.

GridJavaLogger

public GridJavaLogger(boolean init)

Creates new logger.

Parameters:

init - If true, then a default console appender will be created. If false, then no implicit initialization will take place, and java logger should be configured prior to calling this constructor.

GridJavaLogger

public GridJavaLogger(Logger impl)

Creates new logger with given implementation.

Parameters:

impl - Java Logging implementation to use.

Method Detail

isConfigured

public static boolean isConfigured()

Checks if logger is already configured within this VM or not.

Returns:

True if logger was already configured, false otherwise.

getLogger

public GridLogger getLogger(Object ctgr)

Creates new logger with given category based off the current instance.

Specified by:

getLogger in interface GridLogger

Parameters:

ctgr - Category for new logger.

Returns:

New logger with given category.

trace

public void trace(String msg)

Logs out trace message.

Specified by:

trace in interface GridLogger

Parameters:

msg - Trace message.

debug

public void debug(String msg)

Logs out debug message.

Specified by:

debug in interface GridLogger

Parameters:

msg - Debug message.

info

public void info(String msg)

Logs out information message.

Specified by:

info in interface GridLogger

Parameters:

msg - Information message.

warning

public void warning(String msg)

Logs out warning message.

Specified by:

warning in interface GridLogger

Parameters:

msg - Warning message.

warning

public void warning(String msg,
           @Nullable
           Throwable e)

Logs out warning message with optional exception.

Specified by:

warning in interface GridLogger

Parameters:

msg - Warning message.

e - Optional exception (can be null).

error

public void error(String msg)

Logs out error message.

Specified by:

error in interface GridLogger

Parameters:

msg - Error message.

isQuiet

public boolean isQuiet()

Tests whether info and debug levels are turned off.

Specified by:

isQuiet in interface GridLogger

Returns:

Whether info and debug levels are turned off.

error

public void error(String msg,
         @Nullable
         Throwable e)

Logs error message with optional exception.

Specified by:

error in interface GridLogger

Parameters:

msg - Error message.

e - Optional exception (can be null).

isTraceEnabled

public boolean isTraceEnabled()

Tests whether trace level is enabled.

Specified by:

isTraceEnabled in interface GridLogger

Returns:

true in case when trace level is enabled, false otherwise.

isDebugEnabled

public boolean isDebugEnabled()

Tests whether debug level is enabled.

Specified by:

isDebugEnabled in interface GridLogger

Returns:

true in case when debug level is enabled, false otherwise.

isInfoEnabled

public boolean isInfoEnabled()

Tests whether info level is enabled.

Specified by:

isInfoEnabled in interface GridLogger

Returns:

true in case when info level is enabled, false otherwise.

fileName

@Nullable
public String fileName()

Gets name of the file being logged to if one is configured or null otherwise.

Specified by:

fileName in interface GridLogger

Returns:

Name of the file being logged to if one is configured or null otherwise.

setNodeId

public void setNodeId(UUID nodeId)

Sets node ID.

Specified by:

setNodeId in interface GridLoggerNodeIdAware

Parameters:

nodeId - Node ID.

getNodeId

public UUID getNodeId()

Gets node ID.

Specified by:

getNodeId in interface GridLoggerNodeIdAware

Returns:

Node ID.