com.tivoli.twg.log
Class TWGRas

java.lang.Object
  extended bycom.tivoli.twg.log.TWGRas

public abstract class TWGRas
extends java.lang.Object

Reliability, Availability, and Service (RAS) Class

This class provides RAS services such as tracing and error logging. It uses the support provided by TWGLog to write specially formatted messages into log files via the log engine. By default, all RAS logging is disabled. To turn on the RAS logging, RasWatch.exe should be run using the appropriate command line options to enable the desired components. Execute the command RasWatch -? to get a list of the command line options.

If this class is being used in a JVM other than the engine's or the console's JVM, then TWGRas.initialize() must be called before any other methods can be called. Ideally this should be done as soon as possible in the main() method. The initialize() method initializes both TWGRas and TWGLog which causes the communication mechanisms to be set up to pass log messages to the log engine process.

Various types of RAS messages are logged by using the methods of this class. entry() and exit() log messages that can help determine the flow of control into and out of various methods. debug() allows various debug data to be logged inside of methods. dump() allows a byte array to be dumped in hexadecimal. error() logs a message to the RAS log even if logging has not been enabled for the specified component. There are high versions of all the methods except error() that only allow messages to be logged if the "-high" flag has been specified via RasWatch.

By default no messages except error() messages are logged. RasWatch must be run with the appropriate command line switches to enable logging for the desired component. While RasWatch is running, the RAS messages are scrolled in it's window and simultaneously written to the RAS log, TWGRas.log by default. TWGRas.log can be formatted into readable text by using RasDump.exe.

Even though RAS logging is disabled by default, a performance penalty is still incurred even when RasWatch is not running. The decision of whether or not to actually send the message to the log engine is made down in the native code running in TWGLogJNI.dll. Consequently, if a complex dynamic message is being logged, the overhead of constructing the String happens before the log/no log decision is made. In methods where many complex RAS messages are logged, it may be beneficial to set a boolean at the top of the method via the isDebugEnabled() or isTraceEnabled() methods and then surround the calls to the RAS logging methods with if statements. This way, the overhead of String construction can be avoided when logging is disabled. Note: If this is done statically for the class instead of at the top of high volume methods, RAS can not be turned on and off dynamically since the boolean is set once when the class is loaded.


Field Summary
static long AGENT
          Agent
static long AIM
          AIM
static long ALERTS
          Alerts
static long ALL
          All components
static long APP_MGMT
          Application Management
static long ASM
          Service Processor Library
static long CAPMAN
          Capacity Manager
static long CHASSIS
          Chassis
static long CIM
          CIM
static int CMD_WATCH
           
static long CONSOLE
          Console
static long DATABASE
          Database
static long DMI
          DMI
static long ENGINE
          Core Engine
static java.lang.String EVENT_TYPE_RASPARMUPD
           
static long EX0
          Extra bits for OEM components
static long EX1
          Extra bits for OEM components
static long EX2
          Extra bits for OEM components
static long EX3
          Extra bits for OEM components
static long EX4
          Extra bits for OEM components
static long EX5
          Extra bits for OEM components
static long EX6
          Extra bits for OEM components
static long EX7
          Extra bits for OEM components
static long FILE_XFER
          File Transfer
static long FILEFIND
          File Find
static long HW_STATUS
          Hardware Status
static int INIT_AGENT
          Agent
static int INIT_CONSOLE
          Console
static int INIT_ENGINE
          Engine
static int INIT_NONE
          None
static long INSTALL
          Install/Config
static long INTERNET
          Internet
static long INVENTORY
          Inventory
static boolean isTraceAGENT
          Agent
static boolean isTraceAIM
          AIM
static boolean isTraceALERTS
          Alerts
static boolean isTraceANY
          Matches All components
static boolean isTraceAPP_MGMT
          Application Management
static boolean isTraceASM
          Service Processor Library
static boolean isTraceCAPMAN
          Capacity Manager
static boolean isTraceCHASSIS
          Chassis
static boolean isTraceCIM
          CIM
static boolean isTraceCONSOLE
          Console
static boolean isTraceDATABASE
          Database
static boolean isTraceDMI
          DMI
static boolean isTraceENGINE
          Core Engine
static boolean isTraceEX0
          Extra bits for OEM components
static boolean isTraceEX1
          Extra bits for OEM components
static boolean isTraceEX2
          Extra bits for OEM components
static boolean isTraceEX3
          Extra bits for OEM components
static boolean isTraceEX4
          Extra bits for OEM components
static boolean isTraceEX5
          Extra bits for OEM components
static boolean isTraceEX6
          Extra bits for OEM components
static boolean isTraceEX7
          Extra bits for OEM components
static boolean isTraceFILE_XFER
          File Transfer
static boolean isTraceFILEFIND
          File Find
static boolean isTraceHigh
          Trace high flag
static boolean isTraceHW_STATUS
          Hardware Status
static boolean isTraceINSTALL
          Install/Config
static boolean isTraceINTERNET
          Internet
static boolean isTraceINVENTORY
          Inventory
static boolean isTraceLCF
          LCF support
static boolean isTraceLOG
          Log engine and support
static boolean isTraceMONITORS
          Monitors
static boolean isTraceMPA
          Management Processor Assistant
static boolean isTraceNETIPC
          Network IPC (transporter)
static boolean isTraceOBJECT_API
          Object API
static boolean isTracePLATFORM
          Platform
static boolean isTracePOWER_API
          Power API
static boolean isTracePROCESS_MGR
          Process Manager
static boolean isTraceRACK_MANAGER
          Rack Manager
static boolean isTraceRAID
          RAID
static boolean isTraceRDM
          Remote Deployment Manager
static boolean isTraceREMOTE_CTL
          Remote Workstation Control
static boolean isTraceRSESSION
          Remote Session
static boolean isTraceSCHEDULER
          Scheduler
static boolean isTraceSDK
          SDK
static boolean isTraceSERVICE_DESK
          Service Desk
static boolean isTraceSLOT_MANAGER
          Active PCI Manager
static boolean isTraceSLP
          Service Location Protocol
static boolean isTraceSNMP
          SNMP Management
static boolean isTraceSPM
          System Partition Manager
static boolean isTraceSTOR_DEV_MGR
          MDM Device Manager
static boolean isTraceSTOR_PERF_MGR
          MDM Performance Manager
static boolean isTraceSTOR_REPL_MGR
          MDM Replication Manager
static boolean isTraceSTORAGE
          Storage
static boolean isTraceSW_DIST
          Software Distribution
static boolean isTraceSWREJUV
          Software Rejuvenation
static boolean isTraceSYSAVAIL
          System Availability
static boolean isTraceTASK
          Task activation/deactivation
static boolean isTraceTOPOLOGY
          Topology (Network Trace)
static boolean isTraceUMS
          Universal Management Services
static boolean isTraceUNIT_TEST
          Temporary messages for unit test
static boolean isTraceUSER_ADMIN
          User administration
static boolean isTraceUTILITY
          Utility classes
static boolean isTraceVMM
          Virtual Machine Manager
static boolean isTraceWEB_SERVICES
          Web Services
static long LCF
          LCF support
static long LOG
          Log engine and support
static long MONITORS
          Monitors
static long MPA
          Management Processor Assistant
static long NETIPC
          Network IPC (transporter)
static long NONE
          No components
static long OBJECT_API
          Object API
static long PLATFORM
          Platform
static long POWER_API
          Power API
static long PROCESS_MGR
          Process Manager
static long RACK_MANAGER
          Rack Manager
static long RAID
          RAID
static int RAS_ALL
          All types of tracing
static int RAS_MSG_ALL
          All types
static int RAS_MSG_ALLH
          All types with high
static int RAS_MSG_DEBUG
          Debug message
static int RAS_MSG_DEBUGH
          Debug message
static int RAS_MSG_DUMP_DATA
          Dumped data
static int RAS_MSG_DUMP_DATAH
          Dumped data
static int RAS_MSG_DUMP_HEADER
          Message before dumped data
static int RAS_MSG_DUMP_HEADERH
          Message before dumped data
static int RAS_MSG_ENTRY
          Method entry
static int RAS_MSG_ENTRY_EXIT
          Method entry & exit
static int RAS_MSG_ENTRY_EXITH
          Method entry & exit
static int RAS_MSG_ENTRYH
          Method entry
static int RAS_MSG_ERROR
          Error
static int RAS_MSG_ERRORH
          Error
static int RAS_MSG_EXIT
          Method exit
static int RAS_MSG_EXITH
          Method exit
static int RAS_MSG_HIGH
          High use
static int RAS_MSG_NONE
          No types
static int RAS_NONE
          No tracing
static long RDM
          Remote Deployment Manager
static long REMOTE_CTL
          Remote Workstation Control
static long RSESSION
          Remote Session
static long SCHEDULER
          Scheduler
static long SDK
          SDK
static long SERVICE_DESK
          Service Desk
static long SLOT_MANAGER
          Active PCI Manager
static long SLP
          Service Location Protocol
static long SNMP
          SNMP Management
static long SPM
          System Partition Manager
static long STOR_DEV_MGR
          MDM Device Manager
static long STOR_PERF_MGR
          MDM Performance Manager
static long STOR_REPL_MGR
          MDM Replication Manager
static long STORAGE
          Storage
static long SW_DIST
          Software Distribution
static long SWREJUV
          Software Rejuvenation
static long SYSAVAIL
          System Availability
static long TASK
          Task activation/deactivation
static long TOPOLOGY
          Director MPM Provider
static long UMS
          Universal Management Services
static long UNIT_TEST
          Temporary messages for unit test
static long USER_ADMIN
          User administration
static long UTILITY
          Utility classes
static long VMM
          Virtual Machine Manager
static long WEB_SERVICES
          Web Services
 
Method Summary
static void debug(int component, java.lang.String message)
          Deprecated.  
static void debug(int component, java.lang.String message, java.lang.Throwable e)
          Deprecated.  
static void debug(long component, java.lang.String message)
          Log a debug message if RAS has been enabled for the specified component and debug output.
static void debug(long component, java.lang.String message, java.lang.Throwable e)
          Log an exception and it's callback trace if RAS has been enabled for the specified component and debug output.
static void debugH(int component, java.lang.String message)
          Deprecated.  
static void debugH(int component, java.lang.String message, java.lang.Throwable e)
          Deprecated.  
static void debugH(long component, java.lang.String message)
          Log a debug message if RAS has been enabled for the specified component and high use debug output.
static void debugH(long component, java.lang.String message, java.lang.Throwable e)
          Log an exception and it's callback trace if RAS has been enabled for the specified component and high use debug output.
static void disableAll()
          Disable logging of all types.
static void disableComponent(int component)
          Deprecated.  
static void disableComponent(long component)
          Disable tracing of a specific component.
static void disableDebug()
          Disable logging of debug messages.
static void disableDump()
          Disable logging of dump messages.
static void disableHigh()
          Disable logging of high use RAS calls.
static void disableTrace()
          Disable logging of flow tracing (i.e.
static void disableType(int type)
          Disable tracing of a specific type.
static void dump(int component, java.lang.String message, byte[] data, int dataLength)
          Deprecated.  
static void dump(long component, java.lang.String message, byte[] data, int dataLength)
          Dump a byte array if RAS has been enabled for the specified component and dump output.
static void dumpH(int component, java.lang.String message, byte[] data, int dataLength)
          Deprecated.  
static void dumpH(long component, java.lang.String message, byte[] data, int dataLength)
          Dump a byte array if RAS has been enabled for the specified component and high use dump output.
static void enableAll()
          Enable logging of all types excluding high use.
static void enableAllH()
          Enable logging of all types including high use.
static void enableComponent(int component)
          Deprecated.  
static void enableComponent(long component)
          Enable tracing of a specific component.
static void enableDebug()
          Enable logging of debug messages.
static void enableDump()
          Enable logging of dump messages.
static void enableHigh()
          Enable logging of high use flow/debug/dump.
static void enableTrace()
          Enable logging of flow tracing (i.e.
static void enableType(int type)
          Enable tracing of a specific type.
static void entry(int component, java.lang.String message)
          Deprecated.  
static void entry(long component, java.lang.String message)
          Trace method entry if RAS has been enabled for the specified component and flow tracing.
static void entryExit(int component, java.lang.String message)
          Deprecated.  
static void entryExit(long component, java.lang.String message)
          Trace method entry/exit if RAS has been enabled for the specified component and flow tracing.
static void entryExitH(int component, java.lang.String message)
          Deprecated.  
static void entryExitH(long component, java.lang.String message)
          Trace method entry/exit if RAS has been enabled for the specified component and high use flow tracing.
static void entryH(int component, java.lang.String message)
          Deprecated.  
static void entryH(long component, java.lang.String message)
          Trace method entry if RAS has been enabled for the specified component and high use flow tracing.
static void error(int component, java.lang.String message)
          Deprecated.  
static void error(int component, java.lang.String message, java.lang.Throwable e)
          Deprecated.  
static void error(int component, java.lang.Throwable e)
          Deprecated.  
static void error(long component, java.lang.String message)
          Unconditionally log error an error message.
static void error(long component, java.lang.String message, java.lang.Throwable e)
          Unconditionally log an exception and it's callback trace.
static void error(long component, java.lang.Throwable e)
          Unconditionally log an exception and it's callback trace.
static void exit(int component, java.lang.String message)
          Deprecated.  
static void exit(long component, java.lang.String message)
          Trace method exit if RAS has been enabled for the specified component and flow tracing.
static void exitH(int component, java.lang.String message)
          Deprecated.  
static void exitH(long component, java.lang.String message)
          Trace method exit if RAS has been enabled for the specified component and high use flow tracing.
static long getComponents()
          Get the current value of the component mask.
static int getNativeThreadID()
          Invokes a JNI method that returns the native thread ID of the thread.
static java.io.PrintStream getSavedSystemErr()
           
static java.io.PrintStream getSavedSystemOut()
           
static boolean getSysout()
          Get the current value of System.out and System.err print stream enablement.
static int getTypes()
          Get the current value of the type mask.
static void initialize()
          Initialize the RAS function.
static void initialize(int initializer)
          Initialize the RAS function.
static void initialize(java.lang.String logName)
          Initialize the RAS function.
static void initialize(java.lang.String logName, int initializer)
          Initialize the RAS function.
static void initServiceNode()
          Initialize service node interface to dynamically update logging parms (if native log engine is not in use).
static boolean isDebugEnabled(int component)
          Deprecated.  
static boolean isDebugEnabled(long component)
          Determine if RAS has been enabled for the specified component and debug output.
static boolean isDebugEnabledH(int component)
          Deprecated.  
static boolean isDebugEnabledH(long component)
          Determine if RAS has been enabled for the specified component and high use debug output.
static boolean isDumpEnabled(int component)
          Deprecated.  
static boolean isDumpEnabled(long component)
          Determine if RAS has been enabled for the specified component and dump output.
static boolean isDumpEnabledH(int component)
          Deprecated.  
static boolean isDumpEnabledH(long component)
          Determine if RAS has been enabled for the specified component and high use dump output.
static boolean isTraceEnabled(int component)
          Deprecated.  
static boolean isTraceEnabled(long component)
          Determine if RAS has been enabled for the specified component and flow tracing.
static boolean isTraceEnabledH(int component)
          Deprecated.  
static boolean isTraceEnabledH(long component)
          Determine if RAS has been enabled for the specified component and high use flow tracing.
static 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.
static void setSystemOut(boolean enabled)
          Set status of System.out and System.err print streams
static void setTarget(int target)
          Set the RAS logger target
static void terminate()
          Terminate the RAS function.
static java.lang.String toString(boolean b)
          Return string that is equivalent to the specified boolean.
static java.lang.String toString(byte[] data)
          Return string that is equivalent to the specified byte array.
static java.lang.String toString(char c)
          Return string that is equivalent to the specified char.
static java.lang.String toString(char[] data)
          Return string that is equivalent to the specified character array.
static java.lang.String toString(double d)
          Return string that is equivalent to the specified double.
static java.lang.String toString(float f)
          Return string that is equivalent to the specified float.
static java.lang.String toString(int i)
          Return string that is equivalent to the specified int.
static java.lang.String toString(long l)
          Return string that is equivalent to the specified long.
static java.lang.String toString(java.lang.Object obj)
          Return string representation of an object when there is the possibility that the reference could have a null value
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

CONSOLE

public static final long CONSOLE
Console

See Also:
Constant Field Values

DATABASE

public static final long DATABASE
Database

See Also:
Constant Field Values

ENGINE

public static final long ENGINE
Core Engine

See Also:
Constant Field Values

INSTALL

public static final long INSTALL
Install/Config

See Also:
Constant Field Values

INVENTORY

public static final long INVENTORY
Inventory

See Also:
Constant Field Values

PROCESS_MGR

public static final long PROCESS_MGR
Process Manager

See Also:
Constant Field Values

NETIPC

public static final long NETIPC
Network IPC (transporter)

See Also:
Constant Field Values

ALERTS

public static final long ALERTS
Alerts

See Also:
Constant Field Values

FILE_XFER

public static final long FILE_XFER
File Transfer

See Also:
Constant Field Values

MONITORS

public static final long MONITORS
Monitors

See Also:
Constant Field Values

REMOTE_CTL

public static final long REMOTE_CTL
Remote Workstation Control

See Also:
Constant Field Values

SCHEDULER

public static final long SCHEDULER
Scheduler

See Also:
Constant Field Values

SNMP

public static final long SNMP
SNMP Management

See Also:
Constant Field Values

TASK

public static final long TASK
Task activation/deactivation

See Also:
Constant Field Values

APP_MGMT

public static final long APP_MGMT
Application Management

See Also:
Constant Field Values

TOPOLOGY

public static final long TOPOLOGY
Director MPM Provider

See Also:
Constant Field Values

INTERNET

public static final long INTERNET
Internet

See Also:
Constant Field Values

SDK

public static final long SDK
SDK

See Also:
Constant Field Values

SW_DIST

public static final long SW_DIST
Software Distribution

See Also:
Constant Field Values

UTILITY

public static final long UTILITY
Utility classes

See Also:
Constant Field Values

LCF

public static final long LCF
LCF support

See Also:
Constant Field Values

USER_ADMIN

public static final long USER_ADMIN
User administration

See Also:
Constant Field Values

LOG

public static final long LOG
Log engine and support

See Also:
Constant Field Values

UNIT_TEST

public static final long UNIT_TEST
Temporary messages for unit test

See Also:
Constant Field Values

FILEFIND

public static final long FILEFIND
File Find

See Also:
Constant Field Values

AGENT

public static final long AGENT
Agent

See Also:
Constant Field Values

CIM

public static final long CIM
CIM

See Also:
Constant Field Values

DMI

public static final long DMI
DMI

See Also:
Constant Field Values

AIM

public static final long AIM
AIM

See Also:
Constant Field Values

RSESSION

public static final long RSESSION
Remote Session

See Also:
Constant Field Values

SERVICE_DESK

public static final long SERVICE_DESK
Service Desk

See Also:
Constant Field Values

EX0

public static final long EX0
Extra bits for OEM components

See Also:
Constant Field Values

EX1

public static final long EX1
Extra bits for OEM components

See Also:
Constant Field Values

EX2

public static final long EX2
Extra bits for OEM components

See Also:
Constant Field Values

EX3

public static final long EX3
Extra bits for OEM components

See Also:
Constant Field Values

EX4

public static final long EX4
Extra bits for OEM components

See Also:
Constant Field Values

EX5

public static final long EX5
Extra bits for OEM components

See Also:
Constant Field Values

EX6

public static final long EX6
Extra bits for OEM components

See Also:
Constant Field Values

EX7

public static final long EX7
Extra bits for OEM components

See Also:
Constant Field Values

RDM

public static final long RDM
Remote Deployment Manager

See Also:
Constant Field Values

CAPMAN

public static final long CAPMAN
Capacity Manager

See Also:
Constant Field Values

SWREJUV

public static final long SWREJUV
Software Rejuvenation

See Also:
Constant Field Values

SYSAVAIL

public static final long SYSAVAIL
System Availability

See Also:
Constant Field Values

SPM

public static final long SPM
System Partition Manager

See Also:
Constant Field Values

OBJECT_API

public static final long OBJECT_API
Object API

See Also:
Constant Field Values

POWER_API

public static final long POWER_API
Power API

See Also:
Constant Field Values

HW_STATUS

public static final long HW_STATUS
Hardware Status

See Also:
Constant Field Values

PLATFORM

public static final long PLATFORM
Platform

See Also:
Constant Field Values

CHASSIS

public static final long CHASSIS
Chassis

See Also:
Constant Field Values

RACK_MANAGER

public static final long RACK_MANAGER
Rack Manager

See Also:
Constant Field Values

MPA

public static final long MPA
Management Processor Assistant

See Also:
Constant Field Values

SLP

public static final long SLP
Service Location Protocol

See Also:
Constant Field Values

SLOT_MANAGER

public static final long SLOT_MANAGER
Active PCI Manager

See Also:
Constant Field Values

UMS

public static final long UMS
Universal Management Services

See Also:
Constant Field Values

ASM

public static final long ASM
Service Processor Library

See Also:
Constant Field Values

STOR_DEV_MGR

public static final long STOR_DEV_MGR
MDM Device Manager

See Also:
Constant Field Values

STOR_PERF_MGR

public static final long STOR_PERF_MGR
MDM Performance Manager

See Also:
Constant Field Values

STOR_REPL_MGR

public static final long STOR_REPL_MGR
MDM Replication Manager

See Also:
Constant Field Values

RAID

public static final long RAID
RAID

See Also:
Constant Field Values

WEB_SERVICES

public static final long WEB_SERVICES
Web Services

See Also:
Constant Field Values

VMM

public static final long VMM
Virtual Machine Manager

See Also:
Constant Field Values

STORAGE

public static final long STORAGE
Storage

See Also:
Constant Field Values

ALL

public static final long ALL
All components

See Also:
Constant Field Values

NONE

public static final long NONE
No components

See Also:
Constant Field Values

isTraceCONSOLE

public static boolean isTraceCONSOLE
Console


isTraceDATABASE

public static boolean isTraceDATABASE
Database


isTraceENGINE

public static boolean isTraceENGINE
Core Engine


isTraceINSTALL

public static boolean isTraceINSTALL
Install/Config


isTraceINVENTORY

public static boolean isTraceINVENTORY
Inventory


isTracePROCESS_MGR

public static boolean isTracePROCESS_MGR
Process Manager


isTraceNETIPC

public static boolean isTraceNETIPC
Network IPC (transporter)


isTraceALERTS

public static boolean isTraceALERTS
Alerts


isTraceFILE_XFER

public static boolean isTraceFILE_XFER
File Transfer


isTraceMONITORS

public static boolean isTraceMONITORS
Monitors


isTraceREMOTE_CTL

public static boolean isTraceREMOTE_CTL
Remote Workstation Control


isTraceSCHEDULER

public static boolean isTraceSCHEDULER
Scheduler


isTraceSNMP

public static boolean isTraceSNMP
SNMP Management


isTraceTASK

public static boolean isTraceTASK
Task activation/deactivation


isTraceAPP_MGMT

public static boolean isTraceAPP_MGMT
Application Management


isTraceTOPOLOGY

public static boolean isTraceTOPOLOGY
Topology (Network Trace)


isTraceINTERNET

public static boolean isTraceINTERNET
Internet


isTraceSDK

public static boolean isTraceSDK
SDK


isTraceSW_DIST

public static boolean isTraceSW_DIST
Software Distribution


isTraceUTILITY

public static boolean isTraceUTILITY
Utility classes


isTraceLCF

public static boolean isTraceLCF
LCF support


isTraceUSER_ADMIN

public static boolean isTraceUSER_ADMIN
User administration


isTraceLOG

public static boolean isTraceLOG
Log engine and support


isTraceUNIT_TEST

public static boolean isTraceUNIT_TEST
Temporary messages for unit test


isTraceFILEFIND

public static boolean isTraceFILEFIND
File Find


isTraceAGENT

public static boolean isTraceAGENT
Agent


isTraceCIM

public static boolean isTraceCIM
CIM


isTraceDMI

public static boolean isTraceDMI
DMI


isTraceAIM

public static boolean isTraceAIM
AIM


isTraceRSESSION

public static boolean isTraceRSESSION
Remote Session


isTraceSERVICE_DESK

public static boolean isTraceSERVICE_DESK
Service Desk


isTraceEX0

public static boolean isTraceEX0
Extra bits for OEM components


isTraceEX1

public static boolean isTraceEX1
Extra bits for OEM components


isTraceEX2

public static boolean isTraceEX2
Extra bits for OEM components


isTraceEX3

public static boolean isTraceEX3
Extra bits for OEM components


isTraceEX4

public static boolean isTraceEX4
Extra bits for OEM components


isTraceEX5

public static boolean isTraceEX5
Extra bits for OEM components


isTraceEX6

public static boolean isTraceEX6
Extra bits for OEM components


isTraceEX7

public static boolean isTraceEX7
Extra bits for OEM components


isTraceRDM

public static boolean isTraceRDM
Remote Deployment Manager


isTraceCAPMAN

public static boolean isTraceCAPMAN
Capacity Manager


isTraceSWREJUV

public static boolean isTraceSWREJUV
Software Rejuvenation


isTraceSYSAVAIL

public static boolean isTraceSYSAVAIL
System Availability


isTraceSPM

public static boolean isTraceSPM
System Partition Manager


isTraceOBJECT_API

public static boolean isTraceOBJECT_API
Object API


isTracePOWER_API

public static boolean isTracePOWER_API
Power API


isTraceHW_STATUS

public static boolean isTraceHW_STATUS
Hardware Status


isTracePLATFORM

public static boolean isTracePLATFORM
Platform


isTraceCHASSIS

public static boolean isTraceCHASSIS
Chassis


isTraceRACK_MANAGER

public static boolean isTraceRACK_MANAGER
Rack Manager


isTraceMPA

public static boolean isTraceMPA
Management Processor Assistant


isTraceSLP

public static boolean isTraceSLP
Service Location Protocol


isTraceSLOT_MANAGER

public static boolean isTraceSLOT_MANAGER
Active PCI Manager


isTraceUMS

public static boolean isTraceUMS
Universal Management Services


isTraceASM

public static boolean isTraceASM
Service Processor Library


isTraceSTOR_DEV_MGR

public static boolean isTraceSTOR_DEV_MGR
MDM Device Manager


isTraceSTOR_PERF_MGR

public static boolean isTraceSTOR_PERF_MGR
MDM Performance Manager


isTraceSTOR_REPL_MGR

public static boolean isTraceSTOR_REPL_MGR
MDM Replication Manager


isTraceRAID

public static boolean isTraceRAID
RAID


isTraceWEB_SERVICES

public static boolean isTraceWEB_SERVICES
Web Services


isTraceVMM

public static boolean isTraceVMM
Virtual Machine Manager


isTraceSTORAGE

public static boolean isTraceSTORAGE
Storage


isTraceANY

public static boolean isTraceANY
Matches All components


RAS_MSG_ENTRY

public static final int RAS_MSG_ENTRY
Method entry

See Also:
Constant Field Values

RAS_MSG_EXIT

public static final int RAS_MSG_EXIT
Method exit

See Also:
Constant Field Values

RAS_MSG_ENTRY_EXIT

public static final int RAS_MSG_ENTRY_EXIT
Method entry & exit

See Also:
Constant Field Values

RAS_MSG_DEBUG

public static final int RAS_MSG_DEBUG
Debug message

See Also:
Constant Field Values

RAS_MSG_ERROR

public static final int RAS_MSG_ERROR
Error

See Also:
Constant Field Values

RAS_MSG_DUMP_HEADER

public static final int RAS_MSG_DUMP_HEADER
Message before dumped data

See Also:
Constant Field Values

RAS_MSG_DUMP_DATA

public static final int RAS_MSG_DUMP_DATA
Dumped data

See Also:
Constant Field Values

RAS_MSG_ALL

public static final int RAS_MSG_ALL
All types

See Also:
Constant Field Values

RAS_MSG_HIGH

public static final int RAS_MSG_HIGH
High use

See Also:
Constant Field Values

RAS_MSG_ENTRYH

public static final int RAS_MSG_ENTRYH
Method entry

See Also:
Constant Field Values

RAS_MSG_EXITH

public static final int RAS_MSG_EXITH
Method exit

See Also:
Constant Field Values

RAS_MSG_ENTRY_EXITH

public static final int RAS_MSG_ENTRY_EXITH
Method entry & exit

See Also:
Constant Field Values

RAS_MSG_DEBUGH

public static final int RAS_MSG_DEBUGH
Debug message

See Also:
Constant Field Values

RAS_MSG_ERRORH

public static final int RAS_MSG_ERRORH
Error

See Also:
Constant Field Values

RAS_MSG_DUMP_HEADERH

public static final int RAS_MSG_DUMP_HEADERH
Message before dumped data

See Also:
Constant Field Values

RAS_MSG_DUMP_DATAH

public static final int RAS_MSG_DUMP_DATAH
Dumped data

See Also:
Constant Field Values

RAS_MSG_ALLH

public static final int RAS_MSG_ALLH
All types with high

See Also:
Constant Field Values

RAS_MSG_NONE

public static final int RAS_MSG_NONE
No types

See Also:
Constant Field Values

RAS_ALL

public static final int RAS_ALL
All types of tracing

See Also:
Constant Field Values

RAS_NONE

public static final int RAS_NONE
No tracing

See Also:
Constant Field Values

isTraceHigh

public static boolean isTraceHigh
Trace high flag


INIT_NONE

public static final int INIT_NONE
None

See Also:
Constant Field Values

INIT_ENGINE

public static final int INIT_ENGINE
Engine

See Also:
Constant Field Values

INIT_AGENT

public static final int INIT_AGENT
Agent

See Also:
Constant Field Values

INIT_CONSOLE

public static final int INIT_CONSOLE
Console

See Also:
Constant Field Values

EVENT_TYPE_RASPARMUPD

public static final java.lang.String EVENT_TYPE_RASPARMUPD
See Also:
Constant Field Values

CMD_WATCH

public static final int CMD_WATCH
See Also:
Constant Field Values
Method Detail

getNativeThreadID

public static final int getNativeThreadID()
Invokes a JNI method that returns the native thread ID of the thread. On NT this simply returns the results of GetCurrentThreadID().


initialize

public static final void initialize(int initializer)
Initialize the RAS function. This method must be called before any other TWGRas calls are made, and only the first time this method is called has any effect. This method opens the default RAS log called "TWGRas".

Parameters:
initializer - this integer should be set to TWGRas.INIT_ENGINE, TWGRas.INIT_CONSOLE, TWGRas.INIT_NONE depending on if it this initialization is being called by code running in the engine's JVM, the console's JVM or some other JVM. If the INIT_ENGINE is specified, it causes the log engine to be launched (on NT).

initialize

public static final void initialize()
Initialize the RAS function. This method must be called before any other TWGRas calls are made, and only the first time this method is called has any effect. This method opens the default RAS log called "TWGRas", and has the same effect as initialize(TWGRas.INIT_NONE).


initialize

public static final void initialize(java.lang.String logName)
Initialize the RAS function. This method must be called before any other TWGRas calls are made, and only the first time this method is called has any effect. This method causes the RAS data to be output to a specified filename, and has the same effect as initialize(logName, TWGRas.INIT_NONE).

Parameters:
logName - a string containing the name of the log where the RAS data should be written.

initialize

public static final void initialize(java.lang.String logName,
                                    int initializer)
Initialize the RAS function. This method must be called before any other TWGRas calls are made, and only the first time this method is called has any effect. This method causes the RAS data to be output to a specified filename.

Parameters:
logName - a string containing the name of the log where the RAS data should be written.
initializer - this integer should be set to TWGRas.INIT_ENGINE, TWGRas.INIT_AGENT, TWGRas.INIT_CONSOLE, or TWGRas.NONE depending on whether initialization is being called by code running in the engine's JVM, the console's JVM, the agent, or some other JVM. If the INIT_ENGINE is specified, it causes the log engine to be launched (on NT).

terminate

public static final void terminate()
Terminate the RAS function.


isTraceEnabled

public static final boolean isTraceEnabled(int component)
Deprecated.  

Determine if RAS has been enabled for the specified component and flow tracing.

Parameters:
component - component identifier
Returns:
true if tracing is enabled for the specified component and flow tracing

isTraceEnabled

public static final boolean isTraceEnabled(long component)
Determine if RAS has been enabled for the specified component and flow tracing.

Parameters:
component - component identifier
Returns:
true if tracing is enabled for the specified component and flow tracing

isTraceEnabledH

public static final boolean isTraceEnabledH(int component)
Deprecated.  

Determine if RAS has been enabled for the specified component and high use flow tracing.

Parameters:
component - component identifier
Returns:
true if tracing is enabled for the specified component and high use flow tracing

isTraceEnabledH

public static final boolean isTraceEnabledH(long component)
Determine if RAS has been enabled for the specified component and high use flow tracing.

Parameters:
component - component identifier
Returns:
true if tracing is enabled for the specified component and high use flow tracing

isDebugEnabled

public static final boolean isDebugEnabled(int component)
Deprecated.  

Determine if RAS has been enabled for the specified component and debug output.

Parameters:
component - component identifier
Returns:
true if tracing is enabled for the specified component and debug output

isDebugEnabled

public static final boolean isDebugEnabled(long component)
Determine if RAS has been enabled for the specified component and debug output.

Parameters:
component - component identifier
Returns:
true if tracing is enabled for the specified component and debug output

isDebugEnabledH

public static final boolean isDebugEnabledH(int component)
Deprecated.  

Determine if RAS has been enabled for the specified component and high use debug output.

Parameters:
component - component identifier
Returns:
true if tracing is enabled for the specified component and high use debug output

isDebugEnabledH

public static final boolean isDebugEnabledH(long component)
Determine if RAS has been enabled for the specified component and high use debug output.

Parameters:
component - component identifier
Returns:
true if tracing is enabled for the specified component and high use debug output

isDumpEnabled

public static final boolean isDumpEnabled(int component)
Deprecated.  

Determine if RAS has been enabled for the specified component and dump output.

Parameters:
component - component identifier
Returns:
true if tracing is enabled for the specified component and dump output

isDumpEnabled

public static final boolean isDumpEnabled(long component)
Determine if RAS has been enabled for the specified component and dump output.

Parameters:
component - component identifier
Returns:
true if tracing is enabled for the specified component and dump output

isDumpEnabledH

public static final boolean isDumpEnabledH(int component)
Deprecated.  

Determine if RAS has been enabled for the specified component and high use dump output.

Parameters:
component - component identifier
Returns:
true if tracing is enabled for the specified component and high use dump output

isDumpEnabledH

public static final boolean isDumpEnabledH(long component)
Determine if RAS has been enabled for the specified component and high use dump output.

Parameters:
component - component identifier
Returns:
true if tracing is enabled for the specified component and high use dump output

setMaxFileSize

public static final 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.

setTarget

public static final void setTarget(int target)
Set the RAS logger target

Parameters:
target - target value (0=java logger, 1=stdout, 2=native logger, other values are implementation-specific)

entry

public static final void entry(int component,
                               java.lang.String message)
Deprecated.  

Trace method entry if RAS has been enabled for the specified component and flow tracing. This causes a RAS message with the -> indicator.

Parameters:
component - component making the flow trace call
message - message to put in RAS log
See Also:
exit(int, java.lang.String)

entry

public static final void entry(long component,
                               java.lang.String message)
Trace method entry if RAS has been enabled for the specified component and flow tracing. This causes a RAS message with the -> indicator.

Parameters:
component - component making the flow trace call
message - message to put in RAS log
See Also:
exit(int, java.lang.String)

entryH

public static final void entryH(int component,
                                java.lang.String message)
Deprecated.  

Trace method entry if RAS has been enabled for the specified component and high use flow tracing. This causes a RAS message with the -> indicator.

Parameters:
component - component making the flow trace call
message - message to put in RAS log
See Also:
exit(int, java.lang.String)

entryH

public static final void entryH(long component,
                                java.lang.String message)
Trace method entry if RAS has been enabled for the specified component and high use flow tracing. This causes a RAS message with the -> indicator.

Parameters:
component - component making the flow trace call
message - message to put in RAS log
See Also:
exit(int, java.lang.String)

entryExit

public static final void entryExit(int component,
                                   java.lang.String message)
Deprecated.  

Trace method entry/exit if RAS has been enabled for the specified component and flow tracing. This causes a RAS message with the <> indicator.

Parameters:
component - component making the flow trace call
message - message to put in RAS log
See Also:
entry(int, java.lang.String), exit(int, java.lang.String)

entryExit

public static final void entryExit(long component,
                                   java.lang.String message)
Trace method entry/exit if RAS has been enabled for the specified component and flow tracing. This causes a RAS message with the <> indicator.

Parameters:
component - component making the flow trace call
message - message to put in RAS log
See Also:
entry(int, java.lang.String), exit(int, java.lang.String)

entryExitH

public static final void entryExitH(int component,
                                    java.lang.String message)
Deprecated.  

Trace method entry/exit if RAS has been enabled for the specified component and high use flow tracing. This causes a RAS message with the <> indicator.

Parameters:
component - component making the flow trace call
message - message to put in RAS log
See Also:
entry(int, java.lang.String), exit(int, java.lang.String)

entryExitH

public static final void entryExitH(long component,
                                    java.lang.String message)
Trace method entry/exit if RAS has been enabled for the specified component and high use flow tracing. This causes a RAS message with the <> indicator.

Parameters:
component - component making the flow trace call
message - message to put in RAS log
See Also:
entry(int, java.lang.String), exit(int, java.lang.String)

exit

public static final void exit(int component,
                              java.lang.String message)
Deprecated.  

Trace method exit if RAS has been enabled for the specified component and flow tracing. This causes a RAS message with the <- indicator.

Parameters:
component - component making the flow trace call
message - message to put in RAS log
See Also:
entry(int, java.lang.String)

exit

public static final void exit(long component,
                              java.lang.String message)
Trace method exit if RAS has been enabled for the specified component and flow tracing. This causes a RAS message with the <- indicator.

Parameters:
component - component making the flow trace call
message - message to put in RAS log
See Also:
entry(int, java.lang.String)

exitH

public static final void exitH(int component,
                               java.lang.String message)
Deprecated.  

Trace method exit if RAS has been enabled for the specified component and high use flow tracing. This causes a RAS message with the <- indicator.

Parameters:
component - component making the flow trace call
message - message to put in RAS log
See Also:
entry(int, java.lang.String)

exitH

public static final void exitH(long component,
                               java.lang.String message)
Trace method exit if RAS has been enabled for the specified component and high use flow tracing. This causes a RAS message with the <- indicator.

Parameters:
component - component making the flow trace call
message - message to put in RAS log
See Also:
entry(int, java.lang.String)

debug

public static final void debug(int component,
                               java.lang.String message)
Deprecated.  

Log a debug message if RAS has been enabled for the specified component and debug output. This causes a RAS message with the -- indicator.

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

debug

public static final void debug(long component,
                               java.lang.String message)
Log a debug message if RAS has been enabled for the specified component and debug output. This causes a RAS message with the -- indicator.

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

debug

public static final void debug(int component,
                               java.lang.String message,
                               java.lang.Throwable e)
Deprecated.  

Log an exception and it's callback trace if RAS has been enabled for the specified component and debug output. This causes a RAS message with the -- indicator.

Parameters:
component - component making the error call
e - exception to printStackTrace of

debug

public static final void debug(long component,
                               java.lang.String message,
                               java.lang.Throwable e)
Log an exception and it's callback trace if RAS has been enabled for the specified component and debug output. This causes a RAS message with the -- indicator.

Parameters:
component - component making the error call
e - exception to printStackTrace of

debugH

public static final void debugH(int component,
                                java.lang.String message)
Deprecated.  

Log a debug message if RAS has been enabled for the specified component and high use debug output. This causes a RAS message with the -- indicator.

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

debugH

public static final void debugH(long component,
                                java.lang.String message)
Log a debug message if RAS has been enabled for the specified component and high use debug output. This causes a RAS message with the -- indicator.

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

debugH

public static final void debugH(int component,
                                java.lang.String message,
                                java.lang.Throwable e)
Deprecated.  

Log an exception and it's callback trace if RAS has been enabled for the specified component and high use debug output. This causes a RAS message with the -- indicator.

Parameters:
component - component making the error call
e - exception to printStackTrace of

debugH

public static final void debugH(long component,
                                java.lang.String message,
                                java.lang.Throwable e)
Log an exception and it's callback trace if RAS has been enabled for the specified component and high use debug output. This causes a RAS message with the -- indicator.

Parameters:
component - component making the error call
e - exception to printStackTrace of

dump

public static final void dump(int component,
                              java.lang.String message,
                              byte[] data,
                              int dataLength)
Deprecated.  

Dump a byte array if RAS has been enabled for the specified component and dump output. This causes a RAS message with the ## indicator followed by a hexadecimal dump of the byte array.

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

dump

public static final void dump(long component,
                              java.lang.String message,
                              byte[] data,
                              int dataLength)
Dump a byte array if RAS has been enabled for the specified component and dump output. This causes a RAS message with the ## indicator followed by a hexadecimal dump of the byte array.

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

dumpH

public static final void dumpH(int component,
                               java.lang.String message,
                               byte[] data,
                               int dataLength)
Deprecated.  

Dump a byte array if RAS has been enabled for the specified component and high use dump output. This causes a RAS message with the ## indicator followed by a hexadecimal dump of the byte array.

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

dumpH

public static final void dumpH(long component,
                               java.lang.String message,
                               byte[] data,
                               int dataLength)
Dump a byte array if RAS has been enabled for the specified component and high use dump output. This causes a RAS message with the ## indicator followed by a hexadecimal dump of the byte array.

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

error

public static final void error(int component,
                               java.lang.String message)
Deprecated.  

Unconditionally log error an error message. This causes a RAS message with the !! indicator.

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

error

public static final void error(long component,
                               java.lang.String message)
Unconditionally log error an error message. This causes a RAS message with the !! indicator.

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

error

public static final void error(int component,
                               java.lang.String message,
                               java.lang.Throwable e)
Deprecated.  

Unconditionally log an exception and it's callback trace. This causes a RAS message with the !! indicator.

Parameters:
component - component making the error call
e - exception to printStackTrace of

error

public static final void error(long component,
                               java.lang.String message,
                               java.lang.Throwable e)
Unconditionally log an exception and it's callback trace. This causes a RAS message with the !! indicator.

Parameters:
component - component making the error call
e - exception to printStackTrace of

error

public static final void error(int component,
                               java.lang.Throwable e)
Deprecated.  

Unconditionally log an exception and it's callback trace. This causes a RAS message with the !! indicator.

Parameters:
component - component making the error call
e - exception to printStackTrace of

error

public static final void error(long component,
                               java.lang.Throwable e)
Unconditionally log an exception and it's callback trace. This causes a RAS message with the !! indicator.

Parameters:
component - component making the error call
e - exception to printStackTrace of

getSysout

public static final boolean getSysout()
Get the current value of System.out and System.err print stream enablement.

Returns:
status of System.out and System.err enablement

getComponents

public static final long getComponents()
Get the current value of the component mask.

Returns:
the RAS log's current component mask value

enableComponent

public static final void enableComponent(int component)
Deprecated.  

Enable tracing of a specific component.

Parameters:
component - which component(s) to be ORed into the component mask

enableComponent

public static final void enableComponent(long component)
Enable tracing of a specific component.

Parameters:
component - which component(s) to be ORed into the component mask

disableComponent

public static final void disableComponent(int component)
Deprecated.  

Disable tracing of a specific component.

Parameters:
component - which component(s) to be ANDed out of the component mask

disableComponent

public static final void disableComponent(long component)
Disable tracing of a specific component.

Parameters:
component - which component(s) to be ANDed out of the component mask

getTypes

public static final int getTypes()
Get the current value of the type mask.

Returns:
the RAS log's current type mask value

enableTrace

public static final void enableTrace()
Enable logging of flow tracing (i.e. entry/exit).


disableTrace

public static final void disableTrace()
Disable logging of flow tracing (i.e. entry/exit).


enableDebug

public static final void enableDebug()
Enable logging of debug messages.


disableDebug

public static final void disableDebug()
Disable logging of debug messages.


enableDump

public static final void enableDump()
Enable logging of dump messages.


disableDump

public static final void disableDump()
Disable logging of dump messages.


enableHigh

public static final void enableHigh()
Enable logging of high use flow/debug/dump.


disableHigh

public static final void disableHigh()
Disable logging of high use RAS calls.


enableAll

public static final void enableAll()
Enable logging of all types excluding high use.


enableAllH

public static final void enableAllH()
Enable logging of all types including high use.


disableAll

public static final void disableAll()
Disable logging of all types.


enableType

public static final void enableType(int type)
Enable tracing of a specific type.


disableType

public static final void disableType(int type)
Disable tracing of a specific type.


toString

public static final java.lang.String toString(boolean b)
Return string that is equivalent to the specified boolean.

Parameters:
b - the boolean
Returns:
string

toString

public static final java.lang.String toString(byte[] data)
Return string that is equivalent to the specified byte array.

Parameters:
data - the byte array
Returns:
string representing the passed byte[] reference

toString

public static final java.lang.String toString(char c)
Return string that is equivalent to the specified char.

Parameters:
c - the char
Returns:
string

toString

public static final java.lang.String toString(char[] data)
Return string that is equivalent to the specified character array.

Parameters:
data - the character array
Returns:
string

toString

public static final java.lang.String toString(int i)
Return string that is equivalent to the specified int.

Parameters:
i - the int
Returns:
string

toString

public static final java.lang.String toString(long l)
Return string that is equivalent to the specified long.

Parameters:
l - the long
Returns:
string

toString

public static final java.lang.String toString(float f)
Return string that is equivalent to the specified float.

Parameters:
f - the float
Returns:
string

toString

public static final java.lang.String toString(double d)
Return string that is equivalent to the specified double.

Parameters:
d - the double
Returns:
string

toString

public static final java.lang.String toString(java.lang.Object obj)
Return string representation of an object when there is the possibility that the reference could have a null value

Parameters:
obj - potentially null object reference
Returns:
string representing the passed object reference

if obj == null then STR_NULL

if obj != null then object's toString() value


setSystemOut

public static void setSystemOut(boolean enabled)
Set status of System.out and System.err print streams


initServiceNode

public static void initServiceNode()
Initialize service node interface to dynamically update logging parms (if native log engine is not in use). Assumes initialize() has already been called, local IPC is active, and SecMgr service node is active.


getSavedSystemOut

public static java.io.PrintStream getSavedSystemOut()

getSavedSystemErr

public static java.io.PrintStream getSavedSystemErr()