org.eclipse.tptp.trace.arm.internal.logging
Class ARMLogger

java.lang.Object
  org.eclipse.tptp.trace.arm.internal.logging.ARMLogger

public class ARMLogger
extends java.lang.Object

This class is used for logging messages in the ARM agent The methods defined are of the form log ( , ...) The situationType is a Common Base Event situation type. CBE's are created based on the situationType and logged using JSR-047 (java.util.logging API's)

See Also:

documentation @ http://dev.eclipse.org/viewcvs/indextools.cgi/~checkout~/hyades-home/docs/doc.html

Field Summary

static java.lang.String	ABORT_INIT
static java.lang.String	ARM_LOGGER_NAME The name of the ARM Logger (i.e., the name of the Logger as it will appear in the UI).
static java.lang.String	AVAIL Predefined constants for featureDisposition and availabilityDisposition
static java.lang.String	AVAILABLE
static java.lang.String	CLOSED
static java.lang.String	DEBUG
static java.lang.String	EXTENDED_DATA_ELEMENT_NAME_NAMESPACE
static java.lang.String	EXTENDED_DATA_ELEMENT_NAME_THROWN
static java.lang.String	EXTENDED_DATA_ELEMENT_NAME_THROWN_STACK_FRAME
static java.lang.String	FREED
static java.lang.String	FUNC_BLOCK
static java.lang.String	FUNC_PROCESS Predefined constants for AvailableSituation.processingDisposition
static java.lang.String	HEARTBEAT
static java.lang.String	INUSE Predefined constants for ConnectSituation.situationQualifier
static java.lang.String	LOG
static java.lang.String	MET Predefined constants for dependencyDisposition
static java.lang.String	NONSTARTABLE
static java.lang.String	NOT_AVAIL
static java.lang.String	NOT_MET
static java.lang.String	PAUSE_INIT
static java.lang.String	PERFORMANCE Predefined constants for reportCategory
static java.lang.String	REQUEST_COMPLETE
static java.lang.String	REQUEST_INIT Predefined constants for RequestSituation.situationQualifier
static java.lang.String	RESTART_INIT
static java.lang.String	SECURITY
static short	SEV_CRIT
static short	SEV_DEBUG_MAX
static short	SEV_DEBUG_MID
static short	SEV_DEBUG_MIN
static short	SEV_FATAL
static short	SEV_HARMLESS
static short	SEV_INFO
static short	SEV_MINOR
static short	SEV_UNKNOWN CBE severity constants
static short	SEV_WARN
static java.lang.String	START_COMPLETE
static java.lang.String	START_INIT Predefined constants for StartSituation.situationQualifier
static java.lang.String	STARTABLE Predefined constants for AvailableSituation.operationDisposition
static java.lang.String	STATUS
static java.lang.String	STOP_COMPLETE
static java.lang.String	STOP_INIT Predefined constants for StopSituation.situationQualifier
static java.lang.String	SUCCESSFUL
static java.lang.String	TRACE
static java.lang.String	UNSUCCESSFUL Predefined constants for successDisposition

Method Summary

static ARMLogger	getLogger(java.lang.String name)
void	logAvailable(short cbeSev, java.lang.String msgId, java.lang.String message, java.lang.String operationDisposition, java.lang.String availabilityDisposition, java.lang.String processingDisposition)
void	logAvailable(short cbeSev, java.lang.String msgId, java.lang.String message, java.lang.String operationDisposition, java.lang.String availabilityDisposition, java.lang.String processingDisposition, java.lang.Throwable thrown)
void	logConfigure(short cbeSev, java.lang.String msgId, java.lang.String message, java.lang.String successDisposition)
void	logConfigure(short cbeSev, java.lang.String msgId, java.lang.String message, java.lang.String successDisposition, java.lang.Throwable thrown)
void	logConnect(short cbeSev, java.lang.String msgId, java.lang.String message, java.lang.String successDisposition, java.lang.String situationDisposition)
void	logConnect(short cbeSev, java.lang.String msgId, java.lang.String message, java.lang.String successDisposition, java.lang.String situationDisposition, java.lang.Throwable thrown)
void	logCreate(short cbeSev, java.lang.String msgId, java.lang.String message, java.lang.String successDisposition)
void	logCreate(short cbeSev, java.lang.String msgId, java.lang.String message, java.lang.String successDisposition, java.lang.Throwable thrown)
void	logDebug(short sev, java.lang.String message)
void	logDebugMax(java.lang.String message)
void	logDependency(short cbeSev, java.lang.String msgId, java.lang.String message, java.lang.String dependencyDisposition)
void	logDependency(short cbeSev, java.lang.String msgId, java.lang.String message, java.lang.String dependencyDisposition, java.lang.Throwable thrown)
void	logDestroy(short cbeSev, java.lang.String msgId, java.lang.String message, java.lang.String successDisposition)
void	logDestroy(short cbeSev, java.lang.String msgId, java.lang.String message, java.lang.String successDisposition, java.lang.Throwable thrown)
void	logFeature(short cbeSev, java.lang.String msgId, java.lang.String message, java.lang.String featureDisposition)
void	logFeature(short cbeSev, java.lang.String msgId, java.lang.String message, java.lang.String featureDisposition, java.lang.Throwable thrown)
void	logOther(short cbeSev, java.lang.String msgId, java.lang.String message)
void	logOther(short cbeSev, java.lang.String msgId, java.lang.String message, java.lang.Throwable thrown)
void	logReport(short cbeSev, java.lang.String msgId, java.lang.String message, java.lang.String reportCategory)
void	logReport(short cbeSev, java.lang.String msgId, java.lang.String message, java.lang.String reportCategory, java.lang.Throwable thrown)
void	logRequest(short cbeSev, java.lang.String msgId, java.lang.String message, java.lang.String successDisposition, java.lang.String situationQualifier)
void	logRequest(short cbeSev, java.lang.String msgId, java.lang.String message, java.lang.String successDisposition, java.lang.String situationQualifier, java.lang.Throwable thrown)
void	logStart(short cbeSev, java.lang.String msgId, java.lang.String message, java.lang.String successDisposition, java.lang.String situationQualifier)
void	logStart(short cbeSev, java.lang.String msgId, java.lang.String message, java.lang.String successDisposition, java.lang.String situationQualifier, java.lang.Throwable thrown)
void	logStop(short cbeSev, java.lang.String msgId, java.lang.String message, java.lang.String successDisposition, java.lang.String situationQualifier)
void	logStop(short cbeSev, java.lang.String msgId, java.lang.String message, java.lang.String successDisposition, java.lang.String situationQualifier, java.lang.Throwable thrown)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SEV_UNKNOWN

public static final short SEV_UNKNOWN

CBE severity constants

See Also:

Constant Field Values

SEV_DEBUG_MAX

public static final short SEV_DEBUG_MAX

See Also:

Constant Field Values

SEV_DEBUG_MID

public static final short SEV_DEBUG_MID

See Also:

Constant Field Values

SEV_DEBUG_MIN

public static final short SEV_DEBUG_MIN

See Also:

Constant Field Values

SEV_INFO

public static final short SEV_INFO

See Also:

Constant Field Values

SEV_HARMLESS

public static final short SEV_HARMLESS

See Also:

Constant Field Values

SEV_WARN

public static final short SEV_WARN

See Also:

Constant Field Values

SEV_MINOR

public static final short SEV_MINOR

See Also:

Constant Field Values

SEV_CRIT

public static final short SEV_CRIT

See Also:

Constant Field Values

SEV_FATAL

public static final short SEV_FATAL

See Also:

Constant Field Values

UNSUCCESSFUL

public static final java.lang.String UNSUCCESSFUL

Predefined constants for successDisposition

See Also:

Constant Field Values

SUCCESSFUL

public static final java.lang.String SUCCESSFUL

See Also:

Constant Field Values

START_INIT

public static final java.lang.String START_INIT

Predefined constants for StartSituation.situationQualifier

See Also:

Constant Field Values

RESTART_INIT

public static final java.lang.String RESTART_INIT

See Also:

Constant Field Values

START_COMPLETE

public static final java.lang.String START_COMPLETE

See Also:

Constant Field Values

STOP_INIT

public static final java.lang.String STOP_INIT

Predefined constants for StopSituation.situationQualifier

See Also:

Constant Field Values

ABORT_INIT

public static final java.lang.String ABORT_INIT

See Also:

Constant Field Values

PAUSE_INIT

public static final java.lang.String PAUSE_INIT

See Also:

Constant Field Values

STOP_COMPLETE

public static final java.lang.String STOP_COMPLETE

See Also:

Constant Field Values

INUSE

public static final java.lang.String INUSE

Predefined constants for ConnectSituation.situationQualifier

See Also:

Constant Field Values

FREED

public static final java.lang.String FREED

See Also:

Constant Field Values

CLOSED

public static final java.lang.String CLOSED

See Also:

Constant Field Values

AVAILABLE

public static final java.lang.String AVAILABLE

See Also:

Constant Field Values

REQUEST_INIT

public static final java.lang.String REQUEST_INIT

Predefined constants for RequestSituation.situationQualifier

See Also:

Constant Field Values

REQUEST_COMPLETE

public static final java.lang.String REQUEST_COMPLETE

See Also:

Constant Field Values

AVAIL

public static final java.lang.String AVAIL

Predefined constants for featureDisposition and availabilityDisposition

See Also:

Constant Field Values

NOT_AVAIL

public static final java.lang.String NOT_AVAIL

See Also:

Constant Field Values

MET

public static final java.lang.String MET

Predefined constants for dependencyDisposition

See Also:

Constant Field Values

NOT_MET

public static final java.lang.String NOT_MET

See Also:

Constant Field Values

PERFORMANCE

public static final java.lang.String PERFORMANCE

Predefined constants for reportCategory

See Also:

Constant Field Values

SECURITY

public static final java.lang.String SECURITY

See Also:

Constant Field Values

HEARTBEAT

public static final java.lang.String HEARTBEAT

See Also:

Constant Field Values

STATUS

public static final java.lang.String STATUS

See Also:

Constant Field Values

TRACE

public static final java.lang.String TRACE

See Also:

Constant Field Values

DEBUG

public static final java.lang.String DEBUG

See Also:

Constant Field Values

LOG

public static final java.lang.String LOG

See Also:

Constant Field Values

STARTABLE

public static final java.lang.String STARTABLE

Predefined constants for AvailableSituation.operationDisposition

See Also:

Constant Field Values

NONSTARTABLE

public static final java.lang.String NONSTARTABLE

See Also:

Constant Field Values

FUNC_PROCESS

public static final java.lang.String FUNC_PROCESS

Predefined constants for AvailableSituation.processingDisposition

See Also:

Constant Field Values

FUNC_BLOCK

public static final java.lang.String FUNC_BLOCK

See Also:

Constant Field Values

EXTENDED_DATA_ELEMENT_NAME_NAMESPACE

public static final java.lang.String EXTENDED_DATA_ELEMENT_NAME_NAMESPACE

See Also:

Constant Field Values

EXTENDED_DATA_ELEMENT_NAME_THROWN

public static final java.lang.String EXTENDED_DATA_ELEMENT_NAME_THROWN

EXTENDED_DATA_ELEMENT_NAME_THROWN_STACK_FRAME

public static final java.lang.String EXTENDED_DATA_ELEMENT_NAME_THROWN_STACK_FRAME

See Also:

Constant Field Values

ARM_LOGGER_NAME

public static final java.lang.String ARM_LOGGER_NAME

The name of the ARM Logger (i.e., the name of the Logger as it will appear in the UI).

See Also:

Constant Field Values

Method Detail

logDebug

public void logDebug(short sev,
                     java.lang.String message)

logDebugMax

public void logDebugMax(java.lang.String message)

logStart

public void logStart(short cbeSev,
                     java.lang.String msgId,
                     java.lang.String message,
                     java.lang.String successDisposition,
                     java.lang.String situationQualifier)

Parameters:

cbeSev - the CBE message severity (use one of the constants defined in this class)

msgId - the message identifier from the resource bundle

message - the message to be logged

successDispostion - one of ARMLogger.SUCCESSFUL, or ARMLogger.UNSUCCESSFUL

situationQualifier - one of ARMLogger.START_INIT, ARMLogger.RESTART_INIT, ARMLogger.START_COMPLETE

logStart

public void logStart(short cbeSev,
                     java.lang.String msgId,
                     java.lang.String message,
                     java.lang.String successDisposition,
                     java.lang.String situationQualifier,
                     java.lang.Throwable thrown)

Parameters:

cbeSev - the CBE message severity (use one of the constants defined in this class)

msgId - the message identifier from the resource bundle

message - the message to be logged

successDispostion - one of ARMLogger.SUCCESSFUL, or ARMLogger.UNSUCCESSFUL

situationQualifier - one of ARMLogger.START_INIT, ARMLogger.RESTART_INIT, ARMLogger.START_COMPLETE

thrown - stack trace when logging from within a try-catch block

logStop

public void logStop(short cbeSev,
                    java.lang.String msgId,
                    java.lang.String message,
                    java.lang.String successDisposition,
                    java.lang.String situationQualifier)

Parameters:

cbeSev - the CBE message severity (use one of the constants defined in this class)

msgId - the message identifier from the resource bundle

message - the message to be logged

successDispostion - one of ARMLogger.SUCCESSFUL, or ARMLogger.UNSUCCESSFUL

situationQualifier - one of ARMLogger.STOP_INIT, ARMLogger.ABORT_INIT, ARMLogger.PAUSE_INIT, ARMLogger.STOP_COMPLETED

logStop

public void logStop(short cbeSev,
                    java.lang.String msgId,
                    java.lang.String message,
                    java.lang.String successDisposition,
                    java.lang.String situationQualifier,
                    java.lang.Throwable thrown)

Parameters:

cbeSev - the CBE message severity (use one of the constants defined in this class)

msgId - the message identifier from the resource bundle

message - the message to be logged

successDispostion - one of ARMLogger.SUCCESSFUL, or ARMLogger.UNSUCCESSFUL

situationQualifier - one of ARMLogger.STOP_INIT, ARMLogger.ABORT_INIT, ARMLogger.PAUSE_INIT, ARMLogger.STOP_COMPLETED

thrown - stack trace when logging from within a try-catch block

logConnect

public void logConnect(short cbeSev,
                       java.lang.String msgId,
                       java.lang.String message,
                       java.lang.String successDisposition,
                       java.lang.String situationDisposition)

Parameters:

cbeSev - the CBE message severity (use one of the constants defined in this class)

msgId - the message identifier from the resource bundle

message - the message to be logged

successDispostion - one of ARMLogger.SUCCESSFUL, or ARMLogger.UNSUCCESSFUL

situationDisposition - one of ARMLogger .INUSE, .FREED, .CLOSED, .AVAILABLE

logConnect

public void logConnect(short cbeSev,
                       java.lang.String msgId,
                       java.lang.String message,
                       java.lang.String successDisposition,
                       java.lang.String situationDisposition,
                       java.lang.Throwable thrown)

Parameters:

cbeSev - the CBE message severity (use one of the constants defined in this class)

msgId - the message identifier from the resource bundle

message - the message to be logged

successDispostion - one of ARMLogger.SUCCESSFUL, or ARMLogger.UNSUCCESSFUL

situationDisposition - one of ARMLogger .INUSE, .FREED, .CLOSED, .AVAILABLE

thrown - stack trace when logging from within a try-catch block

logConfigure

public void logConfigure(short cbeSev,
                         java.lang.String msgId,
                         java.lang.String message,
                         java.lang.String successDisposition)

Parameters:

cbeSev - the CBE message severity (use one of the constants defined in this class)

msgId - the message identifier from the resource bundle

message - the message to be logged

successDispostion - one of ARMLogger.SUCCESSFUL, or ARMLogger.UNSUCCESSFUL

logConfigure

public void logConfigure(short cbeSev,
                         java.lang.String msgId,
                         java.lang.String message,
                         java.lang.String successDisposition,
                         java.lang.Throwable thrown)

Parameters:

cbeSev - the CBE message severity (use one of the constants defined in this class)

msgId - the message identifier from the resource bundle

message - the message to be logged

successDispostion - one of ARMLogger.SUCCESSFUL, or ARMLogger.UNSUCCESSFUL

thrown - stack trace when logging from within a try-catch block

logRequest

public void logRequest(short cbeSev,
                       java.lang.String msgId,
                       java.lang.String message,
                       java.lang.String successDisposition,
                       java.lang.String situationQualifier)

Parameters:

cbeSev - the CBE message severity (use one of the constants defined in this class)

msgId - the message identifier from the resource bundle

message - the message to be logged

successDispostion - one of ARMLogger.SUCCESSFUL, or ARMLogger.UNSUCCESSFUL

situationQualifier - one of ARMLogger .REQUEST_INIT, .REQUEST_COMPLETE

logRequest

public void logRequest(short cbeSev,
                       java.lang.String msgId,
                       java.lang.String message,
                       java.lang.String successDisposition,
                       java.lang.String situationQualifier,
                       java.lang.Throwable thrown)

Parameters:

cbeSev - the CBE message severity (use one of the constants defined in this class)

msgId - the message identifier from the resource bundle

message - the message to be logged

successDispostion - one of ARMLogger.SUCCESSFUL, or ARMLogger.UNSUCCESSFUL

situationQualifier - one of ARMLogger .REQUEST_INIT, .REQUEST_COMPLETE

thrown - stack trace when logging from within a try-catch block

logFeature

public void logFeature(short cbeSev,
                       java.lang.String msgId,
                       java.lang.String message,
                       java.lang.String featureDisposition)

Parameters:

cbeSev - the CBE message severity (use one of the constants defined in this class)

msgId - the message identifier from the resource bundle

message - the message to be logged

featureDisposition - one of ARMLogger .AVAIL, .NOT_AVAIL

logFeature

public void logFeature(short cbeSev,
                       java.lang.String msgId,
                       java.lang.String message,
                       java.lang.String featureDisposition,
                       java.lang.Throwable thrown)

Parameters:

cbeSev - the CBE message severity (use one of the constants defined in this class)

msgId - the message identifier from the resource bundle

message - the message to be logged

featureDisposition - one of ARMLogger .AVAIL, .NOT_AVAIL

thrown - stack trace when logging from within a try-catch block

logDependency

public void logDependency(short cbeSev,
                          java.lang.String msgId,
                          java.lang.String message,
                          java.lang.String dependencyDisposition)

Parameters:

cbeSev - the CBE message severity (use one of the constants defined in this class)

msgId - the message identifier from the resource bundle

message - the message to be logged

dependencyDisposition - one of ARMLogger .MET, .NOT_MET

logDependency

public void logDependency(short cbeSev,
                          java.lang.String msgId,
                          java.lang.String message,
                          java.lang.String dependencyDisposition,
                          java.lang.Throwable thrown)

Parameters:

cbeSev - the CBE message severity (use one of the constants defined in this class)

msgId - the message identifier from the resource bundle

message - the message to be logged

dependencyDisposition - one of ARMLogger .MET, .NOT_MET

thrown - stack trace when logging from within a try-catch block

logCreate

public void logCreate(short cbeSev,
                      java.lang.String msgId,
                      java.lang.String message,
                      java.lang.String successDisposition)

Parameters:

cbeSev - the CBE message severity (use one of the constants defined in this class)

msgId - the message identifier from the resource bundle

message - the message to be logged

successDispostion - one of ARMLogger.SUCCESSFUL, or ARMLogger.UNSUCCESSFUL

logCreate

public void logCreate(short cbeSev,
                      java.lang.String msgId,
                      java.lang.String message,
                      java.lang.String successDisposition,
                      java.lang.Throwable thrown)

Parameters:

cbeSev - the CBE message severity (use one of the constants defined in this class)

msgId - the message identifier from the resource bundle

message - the message to be logged

successDispostion - one of ARMLogger.SUCCESSFUL, or ARMLogger.UNSUCCESSFUL

thrown - stack trace when logging from within a try-catch block

logDestroy

public void logDestroy(short cbeSev,
                       java.lang.String msgId,
                       java.lang.String message,
                       java.lang.String successDisposition)

Parameters:

cbeSev - the CBE message severity (use one of the constants defined in this class)

msgId - the message identifier from the resource bundle

message - the message to be logged

successDispostion - one of ARMLogger.SUCCESSFUL, or ARMLogger.UNSUCCESSFUL

logDestroy

public void logDestroy(short cbeSev,
                       java.lang.String msgId,
                       java.lang.String message,
                       java.lang.String successDisposition,
                       java.lang.Throwable thrown)

Parameters:

cbeSev - the CBE message severity (use one of the constants defined in this class)

msgId - the message identifier from the resource bundle

message - the message to be logged

successDispostion - one of ARMLogger.SUCCESSFUL, or ARMLogger.UNSUCCESSFUL

thrown - stack trace when logging from within a try-catch block

logReport

public void logReport(short cbeSev,
                      java.lang.String msgId,
                      java.lang.String message,
                      java.lang.String reportCategory)

Parameters:

cbeSev - the CBE message severity (use one of the constants defined in this class)

msgId - the message identifier from the resource bundle

message - the message to be logged

reportCategory - one of ARMLogger .PERFORMANCE,.SECURITY,.HEARTBEAT,.STATUS,.TRACE,.DEBUG,.LOG

logReport

public void logReport(short cbeSev,
                      java.lang.String msgId,
                      java.lang.String message,
                      java.lang.String reportCategory,
                      java.lang.Throwable thrown)

Parameters:

cbeSev - the CBE message severity (use one of the constants defined in this class)

msgId - the message identifier from the resource bundle

message - the message to be logged

reportCategory - one of ARMLogger .PERFORMANCE,.SECURITY,.HEARTBEAT,.STATUS,.TRACE,.DEBUG,.LOG

thrown - stack trace when logging from within a try-catch block

logAvailable

public void logAvailable(short cbeSev,
                         java.lang.String msgId,
                         java.lang.String message,
                         java.lang.String operationDisposition,
                         java.lang.String availabilityDisposition,
                         java.lang.String processingDisposition)

Parameters:

cbeSev - the CBE message severity (use one of the constants defined in this class)

msgId - the message identifier from the resource bundle

message - the message to be logged

operationDisposition - one of ARMLogger .STARTABLE, .NONSTARTABLE

availabilityDisposition - one of ARMLogger .AVAIL, .NOT_AVAIL

processingDisposition - one of ARMLogger .FUNC_PROCESS, .FUNC_BLOCK

logAvailable

public void logAvailable(short cbeSev,
                         java.lang.String msgId,
                         java.lang.String message,
                         java.lang.String operationDisposition,
                         java.lang.String availabilityDisposition,
                         java.lang.String processingDisposition,
                         java.lang.Throwable thrown)

Parameters:

cbeSev - the CBE message severity (use one of the constants defined in this class)

msgId - the message identifier from the resource bundle

message - the message to be logged

operationDisposition - one of ARMLogger .STARTABLE, .NONSTARTABLE

availabilityDisposition - one of ARMLogger .AVAIL, .NOT_AVAIL

processingDisposition - one of ARMLogger .FUNC_PROCESS, .FUNC_BLOCK

thrown - stack trace when logging from within a try-catch block

logOther

public void logOther(short cbeSev,
                     java.lang.String msgId,
                     java.lang.String message)

Parameters:

cbeSev - the CBE message severity (use one of the constants defined in this class)

msgId - the message identifier from the resource bundle

message - the message to be logged

logOther

public void logOther(short cbeSev,
                     java.lang.String msgId,
                     java.lang.String message,
                     java.lang.Throwable thrown)

Parameters:

cbeSev - the CBE message severity (use one of the constants defined in this class)

msgId - the message identifier from the resource bundle

message - the message to be logged

thrown - stack trace when logging from within a try-catch block

getLogger

public static ARMLogger getLogger(java.lang.String name)