com.tivoli.jflt
Interface GenericLogger

All Known Implementing Classes:
GenericLoggerSupport

public interface GenericLogger
extends BasicLogger

Methods of this interface are used to provide message logging to the users of an application. All the application's classes should use this interface for handling logging messages.

Version:
1.1
Author:
Cosimo Vampo, Raimondo Castino

Method Summary
 LogCatalog getMessageCatalog()
          Returns the message logging catalog associated with loggers.
 void log(long type, java.lang.Object loggingClass, java.lang.String loggingMethod, java.lang.String text)
          Logs a text message.
 void message(long type, java.lang.Object loggingClass, java.lang.String loggingMethod, java.lang.String key)
          Logs a message, by key, with no parameters.
 void message(long type, java.lang.Object loggingClass, java.lang.String loggingMethod, java.lang.String key, java.lang.Object parm1)
          Logs a message, by key, with one parameter.
 void message(long type, java.lang.Object loggingClass, java.lang.String loggingMethod, java.lang.String key, java.lang.Object[] parms)
          Logs a message, by key, with an array of parameters.
 void message(long type, java.lang.Object loggingClass, java.lang.String loggingMethod, java.lang.String key, java.lang.Object parm1, java.lang.Object parm2)
          Logs a message, by key, with two parameters.
 
Methods inherited from interface com.tivoli.jflt.BasicLogger
isLogging, setLogging
 

Method Detail

message

public void message(long type,
                    java.lang.Object loggingClass,
                    java.lang.String loggingMethod,
                    java.lang.String key)
Logs a message, by key, with no parameters.
Parameters:
type - The message type.
loggingClass - The class name or handle of the logging class.
loggingMethod - The name of the logging method.
key - The message key.

message

public void message(long type,
                    java.lang.Object loggingClass,
                    java.lang.String loggingMethod,
                    java.lang.String key,
                    java.lang.Object parm1)
Logs a message, by key, with one parameter.
Parameters:
type - The message type.
loggingClass - The class name or handle of the logging class.
loggingMethod - The name of the logging method.
key - The message key.
parm1 - An element to be inserted into the message.

message

public void message(long type,
                    java.lang.Object loggingClass,
                    java.lang.String loggingMethod,
                    java.lang.String key,
                    java.lang.Object parm1,
                    java.lang.Object parm2)
Logs a message, by key, with two parameters.
Parameters:
type - The message type.
loggingClass - The class name or handle of the logging class.
loggingMethod - The name of the logging method.
key - The message key.
parm1 - An element to be inserted into the message.
parm2 - An element to be inserted into the message.

message

public void message(long type,
                    java.lang.Object loggingClass,
                    java.lang.String loggingMethod,
                    java.lang.String key,
                    java.lang.Object[] parms)
Logs a message, by key, with an array of parameters.
Parameters:
type - The message type.
loggingClass - The class name or handle of the logging class.
loggingMethod - The name of the logging method.
key - The message key.
parms - An array of elements to be inserted into the message.

log

public void log(long type,
                java.lang.Object loggingClass,
                java.lang.String loggingMethod,
                java.lang.String text)
Logs a text message.
Specified by:
log in interface BasicLogger
Parameters:
type - The message type.
loggingClass - The class name or handle of the logging class.
loggingMethod - The name of the logging method.
text - The message text.

getMessageCatalog

public LogCatalog getMessageCatalog()
Returns the message logging catalog associated with loggers.
Returns:
An implementation of the LogCatalog interface.