com.tivoli.twg.log
Interface TWGRasLogger

All Known Implementing Classes:
TWGLog

public interface TWGRasLogger

Reliability, Availability, and Service (RAS) Class

This interface is used by TWGRas for outputting RAS trace messages.


Method Summary
 void formatDebug(long component, java.lang.String message)
          Format a debug message
 void formatDebug(long component, java.lang.String message, java.lang.Throwable e)
           
 void formatDebugH(long component, java.lang.String message)
           
 void formatDebugH(long component, java.lang.String message, java.lang.Throwable e)
           
 void formatDump(long component, java.lang.String message, byte[] data, int dataLength)
          Format a "dump" message
 void formatDumpH(long component, java.lang.String message, byte[] data, int dataLength)
           
 void formatEntry(long component, java.lang.String message)
          Format an "entry" trace item
 void formatEntryExit(long component, java.lang.String message)
          Format an "entry/exit" trace item
 void formatEntryExitH(long component, java.lang.String message)
           
 void formatEntryH(long component, java.lang.String message)
           
 void formatError(long component, java.lang.String message)
          Format an "error" trace item
 void formatError(long component, java.lang.String message, java.lang.Throwable e)
           
 void formatExit(long component, java.lang.String message)
          Format an "exit" trace item
 void formatExitH(long component, java.lang.String message)
           
 long getComponents()
          Return the current component mask
 int getTypes()
          Return the current type values
 void setComponent(long newComponent)
          Add one or more components to the current component mask
 void setMaxFileSize(int maxFileSize)
          Set the maximum size the log engine will allow the log file for this RAS log to grow before rolling it over to a back-up file and starting a new log file.
 void setType(int newType)
          Add one or more types to the current type mask
 void term()
           
 boolean traceOn(long component, int types)
          Determine if the specified component and type combination currently have tracing enabled
 void unsetComponent(long delComponent)
          Remove one or more components from the current component mask
 void unsetType(int delType)
          Unset TYPE(s) from the current TYPE values
 void updateParms()
           
 

Method Detail

formatEntry

public void formatEntry(long component,
                        java.lang.String message)
Format an "entry" trace item

Parameters:
component - component making the flow trace call
message - message to put in RAS log

formatEntryH

public void formatEntryH(long component,
                         java.lang.String message)

formatEntryExit

public void formatEntryExit(long component,
                            java.lang.String message)
Format an "entry/exit" trace item

Parameters:
component - component making the flow trace call
message - message to put in RAS log

formatEntryExitH

public void formatEntryExitH(long component,
                             java.lang.String message)

formatExit

public void formatExit(long component,
                       java.lang.String message)
Format an "exit" trace item

Parameters:
component - component making the flow trace call
message - message to put in RAS log

formatExitH

public void formatExitH(long component,
                        java.lang.String message)

formatDebug

public void formatDebug(long component,
                        java.lang.String message)
Format a debug message

Parameters:
component - component making the flow trace call
message - message to put in RAS log

formatDebugH

public void formatDebugH(long component,
                         java.lang.String message)

formatDebug

public void formatDebug(long component,
                        java.lang.String message,
                        java.lang.Throwable e)

formatDebugH

public void formatDebugH(long component,
                         java.lang.String message,
                         java.lang.Throwable e)

formatError

public void formatError(long component,
                        java.lang.String message)
Format an "error" trace item

Parameters:
component - component making the flow trace call
message - message to put in RAS log

formatError

public void formatError(long component,
                        java.lang.String message,
                        java.lang.Throwable e)

formatDump

public void formatDump(long component,
                       java.lang.String message,
                       byte[] data,
                       int dataLength)
Format a "dump" message

Parameters:
component - component making the dump call
message - descriptive message for the data area being dumped
dataLength - length of data area to be dumped
data - data area to be dumped

formatDumpH

public void formatDumpH(long component,
                        java.lang.String message,
                        byte[] data,
                        int dataLength)

traceOn

public boolean traceOn(long component,
                       int types)
Determine if the specified component and type combination currently have tracing enabled

Returns:
boolean indicating if tracing is currently enabled for the specified component/type(s) combination

getComponents

public long getComponents()
Return the current component mask

Returns:
current COMPONENT values

setComponent

public void setComponent(long newComponent)
Add one or more components to the current component mask


unsetComponent

public void unsetComponent(long delComponent)
Remove one or more components from the current component mask


getTypes

public int getTypes()
Return the current type values

Returns:
current type values

setType

public void setType(int newType)
Add one or more types to the current type mask


unsetType

public void unsetType(int delType)
Unset TYPE(s) from the current TYPE values


setMaxFileSize

public void setMaxFileSize(int maxFileSize)
Set the maximum size the log engine will allow the log file for this RAS log to grow before rolling it over to a back-up file and starting a new log file.

Parameters:
maxFileSize - The maximum size to allow the log file to grow before it is renamed to logName.bak and reopened. So, the maximum amount of log data ranges from maxFileSize to 2*maxFileSize.

updateParms

public void updateParms()

term

public void term()