com.ibm.commerce.ras
Interface ILoggingService

All Known Implementing Classes:
ECLoggingProvider

public interface ILoggingService

ILoggingService defines the methods to configure the Logging service.


Field Summary
static java.lang.String COPYRIGHT
           
 
Method Summary
 void disable(long messageSeverity)
          This method is called to disable a specific message severity
 void disable(java.lang.String messageSeverity)
          This method is called to disable a specific message severity
 void disableLogging()
          This method is called to disable message logging
 void enable(long messageSeverity)
          This method is called to enable a specific message severity
 void enable(java.lang.String messageSeverity)
          This method is called to enable a specific message severity
 void enableLogging()
          This method is called to enable message logging
 boolean isLoggable(ECMessage message)
          Determines if a log entry will be processed by the logger and any of the handlers.
 boolean isLoggingEnabled()
          This method is called to check if a specific message severity 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

COPYRIGHT

public static final java.lang.String COPYRIGHT
Method Detail

disable

public void disable(long messageSeverity)
This method is called to disable a specific message severity
Parameters:
message - severity long

disable

public void disable(java.lang.String messageSeverity)
This method is called to disable a specific message severity
Parameters:
message - severity String

disableLogging

public void disableLogging()
This method is called to disable message logging

enable

public void enable(long messageSeverity)
This method is called to enable a specific message severity
Parameters:
message - severity long

enable

public void enable(java.lang.String messageSeverity)
This method is called to enable a specific message severity
Parameters:
message - severity String

enableLogging

public void enableLogging()
This method is called to enable message logging

isLoggable

public boolean isLoggable(ECMessage message)
Determines if a log entry will be processed by the logger and any of the handlers. Wrapping a message or trace call with this method can improve performance. Log entries that will not be processed need not even be built. For example:
 if (isLoggable(RASTraceEvent.TYPE_PUBLIC)
   trace(RASTraceEvent.TYPE_PUBLIC...);
 
Parameters:
type - The type of the log entry. The set of possible values is defined by the RASIMessageEvent.TYPE_XXXX or RASITraceEvent.TYPE_XXXX constants.
Returns:
true if the logger is enabled and at least one handler will process the log entry; false, otherwise.

isLoggingEnabled

public boolean isLoggingEnabled()
This method is called to check if a specific message severity is enabled.

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.
classname - The name of the class that issued the logging of this ECMessage.
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.
classname - The name of the class that issued the logging of this ECMessage.
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.
classname - The name of the class that issued the logging of this ECMessage.
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.
Throwable - exception.