com.ibm.commerce.ras
Interface ILoggingService

All Known Implementing Classes:
ECLoggingProvider

public interface ILoggingService

ILoggingService defines the methods to configure the message logging service.


Field Summary
static java.lang.String COPYRIGHT
          IBM copyright notice field.
 
Method Summary
 void disable(long messageSeverity)
          Disables a specific message severity based on a message severity Id.
 void disable(java.lang.String messageSeverity)
          Disables a specific message severity based on a message severity name.
 void disableLogging()
          Disables message logging
 void enable(long messageSeverity)
          Enables a specific message severity based on a message severity Id.
 void enable(java.lang.String messageSeverity)
          Enables a specific message severity based on a message severity Id.
 void enableLogging()
          Enables message logging.
 boolean isLoggable(ECMessage message)
          Determines if a log entry will be processed by the logger and any of the handlers.
 boolean isLoggingEnabled()
          Checks if a message logging is enabled.
 void out(ECMessage msg, java.lang.String className, java.lang.String methodName)
          Writes the specified ECMessage to the log file.
 void out(ECMessage msg, java.lang.String className, java.lang.String methodName, java.lang.Object[] parms)
          Writes the specified ECMessage to the log file.
 void out(ECMessage msg, java.lang.String className, java.lang.String methodName, java.lang.Object[] parms, java.lang.Throwable exc)           Writes the specified ECMessage to the log file.
 

Field Detail
public static final java.lang.String COPYRIGHT
IBM copyright notice field.
See Also:
Constant Field Values
Method Detail

disable

public void disable(long messageSeverity)
Disables a specific message severity based on a message severity Id.
Parameters:
messageSeverity - message severity Id

disable

public void disable(java.lang.String messageSeverity)
Disables a specific message severity based on a message severity name.
Parameters:
messageSeverity - message severity name

disableLogging

public void disableLogging()
Disables message logging

enable

public void enable(long messageSeverity)
Enables a specific message severity based on a message severity Id.
Parameters:
messageSeverity - message severity Id

enable

public void enable(java.lang.String messageSeverity)
Enables a specific message severity based on a message severity Id.
Parameters:
messageSeverity - message severity name

enableLogging

public void enableLogging()
Enables message logging.

isLoggable

public boolean isLoggable(ECMessage message)
Determines if a log entry will be processed by the logger and any of the handlers.
Parameters:
message - message object.
Returns:
true if the logger is enabled and at least one handler will process the log entry; false otherwise.

isLoggingEnabled

public boolean isLoggingEnabled()
Checks if a message logging is enabled.
Returns:
true if message logging is enabled; false otherwise

out

public void out(ECMessage msg,
                java.lang.String className,
                java.lang.String methodName)
Writes the specified ECMessage to the log file.
Parameters:
msg - the ECMessage object whose text is written to the log
methodName - the name of the method that issued the logging of this ECMessage

out

public void out(ECMessage msg,
                java.lang.String className,
                java.lang.String methodName,
                java.lang.Object[] parms)
Writes the specified ECMessage to the log file.
Parameters:
msg - the ECMessage object whose text is written to the log.
methodName - the name of the method that issued the logging of this ECMessage
parms - the list of parameters that will be substituted into the message text

out

public void out(ECMessage msg,
                java.lang.String className,
                java.lang.String methodName,
                java.lang.Object[] parms,
                java.lang.Throwable exc)
Writes the specified ECMessage to the log file.
Parameters:
msg - the ECMessage object whose text is written to the log.
methodName - the name of the method that issued the logging of this ECMessage
parms - the list of parameters that will be substituted into the message text