com.avaya.collaboration.util.logger

Class Logger

java.lang.Object

com.avaya.common.logging.client.Logger

com.avaya.common.logging.client.ExtendedCommonLogger

com.avaya.collaboration.util.logger.Logger

public class Logger
extends com.avaya.common.logging.client.ExtendedCommonLogger

A service should use this class for debug logging. This logger provides a number of different levels to indicate the severity of the log message; from most severe to least severe, the levels are:

• FATAL - indicates a very severe event that will cause the service to fail
• ERROR - indicates a serious ERROR, but the service might continue
• WARN - indicates a possibly harmful problem, but the service continues
• INFO - indicates an information message
• FINE - indicates a message of finer granularity than INFO
• FINER - indicates a message of finer granularity than FINE
• FINEST - indicates a message at the finest granularity

Avaya Breeze generally runs at the INFO level. This means that any log at level INFO or higher (INFO, WARN, ERROR, FATAL) would be logged by default. When running at the INFO level, logs of FINE, FINER, or FINEST will not appear in the log files. In a normal run state, logs should be rare, for example to indicate that the service initialized correctly or to log significant events. The log level can be changed while running, so that logging provides increasingly more information.

The log methods are generally invoked with a String message to be logged. The methods also take a Throwable, which will cause the stack trace to be added to the log.

Example:

 try
 {
     // some code that can throw an exception
 }
 catch (final Exception e)
 {
     logger.error("Caught exception trying to calculate x: ", e);
 }
 

This class is a wrapper on the log4j logger. The log4j.properties file can be found under /opt/Avaya/Common/conf/ on Avaya Breeze.

Since:

2.0

Constructor Summary

Constructors

Constructor and Description
Logger(String loggerType)

Method Summary

Methods

Modifier and Type	Method and Description
void	error(Object message) This method logs a message at the ERROR level.
void	error(Object message, Throwable throwable) This method logs a message at the ERROR level and adds the stack trace for the Throwable.
void	fatal(Object message) This method logs a message at the FATAL level.
void	fatal(Object message, Throwable throwable) This method logs a message at the FATAL level and adds the stack trace for the Throwable.
void	fine(Object message) This method logs a message at the FINE level.
void	fine(Object message, Throwable throwable) This method logs a message at the FINE level and adds the stack trace for the Throwable.
void	finer(Object message) This method logs a message at the FINER level.
void	finer(Object message, Throwable throwable) This method logs a message at the FINER level and adds the stack trace for the Throwable.
void	finest(Object message) This method logs a message at the FINEST level.
void	finest(Object message, Throwable throwable) This method logs a message at the FINEST level and adds the stack trace for the Throwable.
static Logger	getLogger(Class classInstance) This methods returns a service-specific Logger for the calling service.
static Logger	getLogger(String serviceName) This methods returns a Logger for the requested service.
void	info(Object message) This method logs a message at the INFO level.
void	info(Object message, Throwable throwable) This method logs a message at the INFO level and adds the stack trace for the Throwable.
boolean	isFineEnabled() This method returns whether the FINE level is enabled.
boolean	isFinerEnabled() This method returns whether the FINER level is enabled.
boolean	isFinestEnabled() This method returns whether the FINEST level is enabled.
boolean	isInfoEnabled() This method returns whether the INFO level is enabled.
void	logEvent(String eventId, Object[] argument) Logs an event, which will be converted into an alarm by CE.
void	setPrefix(String prefix)
void	warn(Object message) This method logs a message at the WARN level.
void	warn(Object message, Throwable throwable) This method logs a message at the WARN level, and adds the stack trace for the Throwable.

Methods inherited from class com.avaya.common.logging.client.ExtendedCommonLogger

getPrivateLogger

Methods inherited from class com.avaya.common.logging.client.Logger

addAppender, getAllAppenders, getAppender, getHostname, getInstanceHostname, getInstanceLogProductType, getInstanceProcessId, getInstanceProcessName, getInstanceTimeZone, getLogger, getLogger, getLogProductType, getProcessId, getProcessName, getRootLogger, getTimeZone, isEnabledFor, logEvent, logEvent, removeAppender, setAdditivity, setHostname, setInstanceHostname, setInstanceLogProductType, setInstanceProcessId, setInstanceProcessName, setInstanceTimeZone, setLevel, setLogProductType, setProcessId, setProcessName, setTimeZone

Methods inherited from class java.lang.Object

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

Constructor Detail

Logger

public Logger(String loggerType)

Method Detail

getLogger

public static Logger getLogger(Class classInstance)

This methods returns a service-specific Logger for the calling service.

Parameters:

classInstance - The class for the logger.

Returns:

A Logger specific to the service.

getLogger

public static Logger getLogger(String serviceName)

This methods returns a Logger for the requested service. This method should be used only when one service needs to log a message for or as another service.
Most services should use the getLogger(Class classInstance) method.

Parameters:

serviceName - The name of the service

Returns:

A Logger specific to the service.

error

public void error(Object message)

This method logs a message at the ERROR level.

Overrides:

error in class com.avaya.common.logging.client.Logger

Parameters:

message - Message to be logged.

error

public void error(Object message,
         Throwable throwable)

This method logs a message at the ERROR level and adds the stack trace for the Throwable.

Overrides:

error in class com.avaya.common.logging.client.Logger

Parameters:

message - Message to be logged.

throwable - Throwable to be logged.

fatal

public void fatal(Object message)

This method logs a message at the FATAL level.

Overrides:

fatal in class com.avaya.common.logging.client.Logger

Parameters:

message - Message to be logged.

fatal

public void fatal(Object message,
         Throwable throwable)

This method logs a message at the FATAL level and adds the stack trace for the Throwable.

Overrides:

fatal in class com.avaya.common.logging.client.Logger

Parameters:

message - Message to be logged.

throwable - Throwable to be logged.

fine

public void fine(Object message)

This method logs a message at the FINE level.

Overrides:

fine in class com.avaya.common.logging.client.Logger

Parameters:

message - Message to be logged.

fine

public void fine(Object message,
        Throwable throwable)

This method logs a message at the FINE level and adds the stack trace for the Throwable.

Overrides:

fine in class com.avaya.common.logging.client.Logger

Parameters:

message - Message to be logged.

throwable - Throwable to be logged

finer

public void finer(Object message)

This method logs a message at the FINER level.

Overrides:

finer in class com.avaya.common.logging.client.Logger

Parameters:

message - Message to be logged.

finer

public void finer(Object message,
         Throwable throwable)

This method logs a message at the FINER level and adds the stack trace for the Throwable.

Overrides:

finer in class com.avaya.common.logging.client.Logger

Parameters:

message - Message to be logged.

throwable - Throwable to be logged

finest

public void finest(Object message)

This method logs a message at the FINEST level.

Overrides:

finest in class com.avaya.common.logging.client.Logger

Parameters:

message - Message to be logged.

finest

public void finest(Object message,
          Throwable throwable)

This method logs a message at the FINEST level and adds the stack trace for the Throwable.

Overrides:

finest in class com.avaya.common.logging.client.Logger

Parameters:

message - Message to be logged.

throwable - Throwable to be logged

info

public void info(Object message)

This method logs a message at the INFO level.

Overrides:

info in class com.avaya.common.logging.client.Logger

Parameters:

message - Message to be logged.

info

public void info(Object message,
        Throwable throwable)

This method logs a message at the INFO level and adds the stack trace for the Throwable.

Overrides:

info in class com.avaya.common.logging.client.Logger

Parameters:

message - Message to be logged.

throwable - Throwable to be logged

warn

public void warn(Object message,
        Throwable throwable)

This method logs a message at the WARN level, and adds the stack trace for the Throwable.

Overrides:

warn in class com.avaya.common.logging.client.Logger

Parameters:

message - Message to be logged.

warn

public void warn(Object message)

This method logs a message at the WARN level.

Overrides:

warn in class com.avaya.common.logging.client.Logger

Parameters:

message - Message to be logged.

isFineEnabled

public boolean isFineEnabled()

This method returns whether the FINE level is enabled.

Overrides:

isFineEnabled in class com.avaya.common.logging.client.Logger

Returns:

Whether the FINE level is enabled.

isFinerEnabled

public boolean isFinerEnabled()

This method returns whether the FINER level is enabled.

Overrides:

isFinerEnabled in class com.avaya.common.logging.client.Logger

Returns:

Whether the FINER level is enabled.

isFinestEnabled

public boolean isFinestEnabled()

This method returns whether the FINEST level is enabled.

Overrides:

isFinestEnabled in class com.avaya.common.logging.client.Logger

Returns:

Whether the FINEST level is enabled.

isInfoEnabled

public boolean isInfoEnabled()

This method returns whether the INFO level is enabled.

Overrides:

isInfoEnabled in class com.avaya.common.logging.client.Logger

Returns:

Whether the INFO level is enabled.

logEvent

public final void logEvent(String eventId,
            Object[] argument)

Logs an event, which will be converted into an alarm by CE.

See the Dynamic Alarms section of the Service Developer's Guide for more details.

Parameters:

eventId - Event code which maps to an alarm defined in the alarms.xml file.

argument - The arguments associated with this event

setPrefix

public void setPrefix(String prefix)