COM.TIBCO.hawk.ami

Class AmiTrace

java.lang.Object

COM.TIBCO.hawk.utilities.trace.Trace

COM.TIBCO.hawk.ami.AmiTrace

All Implemented Interfaces:

AmiEnabledInterface, AmiTraceInterface

public class AmiTrace
extends COM.TIBCO.hawk.utilities.trace.Trace
implements AmiTraceInterface, AmiEnabledInterface

This AmiTrace class implementation of the AmiTraceInterface allows a Java application to log messages to stderr, stdout or to a file. This AmiTrace class is a sub-class of Trace.

Field Summary

Fields inherited from class COM.TIBCO.hawk.utilities.trace.Trace

ALL, ALWAYS, AMI, DEBUG, DEFAULT_DATE_TIME_FORMAT, DEFAULT_DIRECTORY_NAME, DEFAULT_FILE_NAME, DEFAULT_LEVEL, DEFAULT_MAX_FILE_INDEX, DEFAULT_MAX_FILE_LENGTH, ERROR, INFO, MAX_CODE_STRING_LENGTH, MAX_FILE_INDEX, MAX_LEVEL, MIN_FILE_LENGTH, MIN_LEVEL, TIBCO_DATE_TIME_FORMAT, useStdRollover, WARNING

Fields inherited from interface COM.TIBCO.hawk.ami.AmiTraceInterface

AMI_ALL, AMI_ALWAYS, AMI_AMI, AMI_DEBUG, AMI_ERROR, AMI_INFO, AMI_MIN_LEVEL, AMI_WARNING

Constructor Summary

Constructors

Constructor and Description
AmiTrace() Create an instance of the class AmiTrace with default properties.
AmiTrace(COM.TIBCO.hawk.utilities.command.Command command) Create an instance of the class AmiTrace with properties gotten from the specified Command object.
AmiTrace(COM.TIBCO.hawk.utilities.command.Command command, java.lang.String NTServiceDisplayName) Create an instance of the class AmiTrace with NT service display name and properties gotten from the specified Command object.
AmiTrace(int level, java.lang.String fileName, long fileSize, long maxFile) Create an instance of the class AmiTrace with the given trace properties.
AmiTrace(int level, java.lang.String dirName, java.lang.String fileName, long fileSize, long maxFile) Create an instance of the class AmiTrace with the given trace properties.
AmiTrace(java.lang.String NTServiceDisplayName) Create an instance of the class AmiTrace with NT service display name and default properties.
AmiTrace(COM.TIBCO.hawk.utilities.trace.Trace trace) Create an instance of the class AmiTrace with an existing Trace object.

Method Summary

Modifier and Type	Method and Description
static java.lang.Throwable	getLowestCause(java.lang.Throwable cause)
AmiMethodInterface[]	getMethods() Returns an array of AmiMethodInterfaces for getting and setting AmiTrace properties.
void	log(java.util.ResourceBundle bundle, java.lang.String id, int msg_num, boolean addStackTrace, int code, java.lang.Object[] params, java.lang.Throwable e) Logs the given Throwable's stack trace.
void	log(java.util.ResourceBundle bundle, java.lang.String id, int msg_num, int code, java.lang.Object[] params)
void	logAlways(java.lang.String logMsg) When this method is invoked, the input logMsg should always be logged regardless of the state of the trace properties.
void	logAlways(java.lang.Throwable e) When this method is invoked, the input exception's stack trace should always be logged regardless of the state of the trace properties.
void	logAmi(java.lang.String logMsg) When this method is invoked, the input logMsg should be logged only if the state of the trace properties indicates a need for AMI debugging messages.
void	logAmi(java.lang.Throwable e) When this method is invoked, the input exception's stack trace should be logged only if the state of the trace properties indicates a need for AMI debugging messages.
void	logDebug(java.lang.String logMsg) When this method is invoked, the input logMsg should be logged only if the state of the trace properties indicates a need for debugging messages.
void	logDebug(java.lang.Throwable e) When this method is invoked, the input exception's stack trace should be logged only if the state of the trace properties indicates a need for debugging messages.
void	logError(java.lang.String logMsg) When this method is invoked, the input logMsg should always be logged regardless of the state of the trace properties.
void	logError(java.lang.Throwable e) When this method is invoked, the input exception's stack trace should always be logged regardless of the state of the trace properties.
void	logInfo(java.lang.String logMsg) When this method is invoked, the input logMsg should be logged only if the state of the trace properties indicates a need for information messages.
void	logInfo(java.lang.Throwable e) When this method is invoked, the input exception's stack trace should be logged only if the state of the trace properties indicates a need for information messages.
void	logWarning(java.lang.String logMsg) When this method is invoked, the input logMsg should be logged only if the state of the trace properties indicates a need for warning messages.
void	logWarning(java.lang.Throwable e) When this method is invoked, the input exception's stack trace should be logged only if the state of the trace properties indicates a need for warning messages.
void	setSession(AmiSession ami) This method has a noop implementation.

Methods inherited from class COM.TIBCO.hawk.utilities.trace.Trace

getDirectoryName, getFileName, getFileSize, getLevel, getLevelHelpString, getLevelLabelString, getLevelString, getMaxFile, getMaxLevel, getNumberOfLevels, getOutputStream, getStackTrace, isLevelOn, log, log, log, log, log, log, main, setDateTimeFormat, setDirectoryName, setFileName, setFileSize, setLevel, setMaxFile, setTraceStandardDefaults, setUserLevel, setUserLevel, useStdRollover

Methods inherited from class java.lang.Object

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

Methods inherited from interface COM.TIBCO.hawk.ami.AmiTraceInterface

getDirectoryName, getFileName, getFileSize, getLevel, getLevelHelpString, getLevelLabelString, getLevelString, getMaxFile, getMaxLevel, getNumberOfLevels, isLevelOn, log, log, log, log, setDirectoryName, setFileName, setFileSize, setLevel, setMaxFile, setUserLevel, setUserLevel

Constructor Detail

AmiTrace

public AmiTrace()

Create an instance of the class AmiTrace with default properties.

Please refer

COM.TIBCO.hawk.utilities.trace.Trace#Trace()

AmiTrace

public AmiTrace(java.lang.String NTServiceDisplayName)

Create an instance of the class AmiTrace with NT service display name and default properties.

Please refer

COM.TIBCO.hawk.utilities.trace.Trace#Trace()

AmiTrace

public AmiTrace(COM.TIBCO.hawk.utilities.command.Command command)
         throws COM.TIBCO.hawk.utilities.exception.HawkException

Create an instance of the class AmiTrace with properties gotten from the specified Command object. Command object should contain TraceCommand object parameter definitions.

Throws:

COM.TIBCO.hawk.utilities.exception.HawkException

Please refer

COM.TIBCO.hawk.utilities.trace.Trace#Trace()

AmiTrace

public AmiTrace(COM.TIBCO.hawk.utilities.command.Command command,
                java.lang.String NTServiceDisplayName)
         throws COM.TIBCO.hawk.utilities.exception.HawkException

Create an instance of the class AmiTrace with NT service display name and properties gotten from the specified Command object. Command object should contain TraceCommand object parameter definitions.

Throws:

COM.TIBCO.hawk.utilities.exception.HawkException

Please refer

COM.TIBCO.hawk.utilities.trace.Trace#Trace()

AmiTrace

public AmiTrace(COM.TIBCO.hawk.utilities.trace.Trace trace)

Create an instance of the class AmiTrace with an existing Trace object.

Parameters:

trace - An existing Trace object.

Please refer

COM.TIBCO.hawk.utilities.trace.Trace#Trace(Trace)

AmiTrace

public AmiTrace(int level,
                java.lang.String dirName,
                java.lang.String fileName,
                long fileSize,
                long maxFile)
         throws COM.TIBCO.hawk.utilities.trace.TraceException

Create an instance of the class AmiTrace with the given trace properties.

Parameters:

level - The current trace level

dirName - The directory path to use for creating log files

fileName - The file name to use for create log file

fileSize - The maximum number of Kbytes before file rollover

maxFile - The maximum number of files to keep

Throws:

COM.TIBCO.hawk.utilities.trace.TraceException - is thrown if any of the input arguments is invalid.

Please refer

COM.TIBCO.hawk.utilities.trace.Trace#Trace(int, String, String, long, long)

AmiTrace

public AmiTrace(int level,
                java.lang.String fileName,
                long fileSize,
                long maxFile)
         throws COM.TIBCO.hawk.utilities.trace.TraceException

Create an instance of the class AmiTrace with the given trace properties.

Parameters:

level - The current trace level

fileName - The file name to use for create log file

fileSize - The maximum number of Kbytes before file rollover

maxFile - The maximum number of files to keep

Throws:

COM.TIBCO.hawk.utilities.trace.TraceException - is thrown if any of the input arguments is invalid.

Please refer

COM.TIBCO.hawk.utilities.trace.Trace#Trace(int, String, long, long)

Method Detail

logAlways

public void logAlways(java.lang.String logMsg)

When this method is invoked, the input logMsg should always be logged regardless of the state of the trace properties.

Specified by:

logAlways in interface AmiTraceInterface

Parameters:

logMsg - The message to be logged

logInfo

public void logInfo(java.lang.String logMsg)

When this method is invoked, the input logMsg should be logged only if the state of the trace properties indicates a need for information messages.

Specified by:

logInfo in interface AmiTraceInterface

Parameters:

logMsg - The message to be logged

logWarning

public void logWarning(java.lang.String logMsg)

When this method is invoked, the input logMsg should be logged only if the state of the trace properties indicates a need for warning messages.

Specified by:

logWarning in interface AmiTraceInterface

Parameters:

logMsg - The message to be logged

logError

public void logError(java.lang.String logMsg)

When this method is invoked, the input logMsg should always be logged regardless of the state of the trace properties.

Specified by:

logError in interface AmiTraceInterface

Parameters:

logMsg - The message to be logged

logDebug

public void logDebug(java.lang.String logMsg)

When this method is invoked, the input logMsg should be logged only if the state of the trace properties indicates a need for debugging messages.

Specified by:

logDebug in interface AmiTraceInterface

Parameters:

logMsg - The message to be logged

logAmi

public void logAmi(java.lang.String logMsg)

When this method is invoked, the input logMsg should be logged only if the state of the trace properties indicates a need for AMI debugging messages.

Specified by:

logAmi in interface AmiTraceInterface

Parameters:

logMsg - The message to be logged

logAlways

public void logAlways(java.lang.Throwable e)

When this method is invoked, the input exception's stack trace should always be logged regardless of the state of the trace properties.

Specified by:

logAlways in interface AmiTraceInterface

Parameters:

e - The exception to be logged.

logInfo

public void logInfo(java.lang.Throwable e)

When this method is invoked, the input exception's stack trace should be logged only if the state of the trace properties indicates a need for information messages.

Specified by:

logInfo in interface AmiTraceInterface

Parameters:

e - The exception to be logged.

logWarning

public void logWarning(java.lang.Throwable e)

When this method is invoked, the input exception's stack trace should be logged only if the state of the trace properties indicates a need for warning messages.

Specified by:

logWarning in interface AmiTraceInterface

Parameters:

e - The exception to be logged.

logError

public void logError(java.lang.Throwable e)

When this method is invoked, the input exception's stack trace should always be logged regardless of the state of the trace properties.

Specified by:

logError in interface AmiTraceInterface

Parameters:

e - The exception to be logged.

logDebug

public void logDebug(java.lang.Throwable e)

When this method is invoked, the input exception's stack trace should be logged only if the state of the trace properties indicates a need for debugging messages.

Specified by:

logDebug in interface AmiTraceInterface

Parameters:

e - The exception to be logged.

logAmi

public void logAmi(java.lang.Throwable e)

When this method is invoked, the input exception's stack trace should be logged only if the state of the trace properties indicates a need for AMI debugging messages.

Specified by:

logAmi in interface AmiTraceInterface

Parameters:

e - The exception to be logged.

getMethods

public AmiMethodInterface[] getMethods()
                                throws AmiException

Returns an array of AmiMethodInterfaces for getting and setting AmiTrace properties.

Specified by:

getMethods in interface AmiEnabledInterface

Returns:

AmiMethodInterface[]

This method implements the AmiEnabledInterface such that an array of four AmiMethodInterfaces for getting and setting AmiTrace properties are returned.

The AmiMethodInterfaces returned by this method are:

• getTraceLevel
• setTraceLevel
• getTraceParameters
• setTraceParameters

Throws:

AmiException

setSession

public void setSession(AmiSession ami)
                throws AmiException

This method has a noop implementation.

Specified by:

setSession in interface AmiEnabledInterface

Parameters:

ami - The current AmiSession object.

The AmiTrace does not need the state of the AmiSession, therefore this method is a noop in this implementation.

Throws:

AmiException

log

public void log(java.util.ResourceBundle bundle,
                java.lang.String id,
                int msg_num,
                boolean addStackTrace,
                int code,
                java.lang.Object[] params,
                java.lang.Throwable e)

Logs the given Throwable's stack trace.

Specified by:

log in interface AmiTraceInterface

Parameters:

bundle - the resource bundle

id - the subsystem id or the message id

msg_num - the message code number

code - a trace level code.

params - the parameters to format the message.

e - the Throwable object to log.

addStackTrace - true if stack trace dump is to be logged

log

public void log(java.util.ResourceBundle bundle,
                java.lang.String id,
                int msg_num,
                int code,
                java.lang.Object[] params)

Specified by:

log in interface AmiTraceInterface

getLowestCause

public static java.lang.Throwable getLowestCause(java.lang.Throwable cause)