org.safs.staf.service.logging

Class CustomLogFac

java.lang.Object

org.safs.staf.service.logging.CustomLogFac

public class CustomLogFac
extends java.lang.Object

This class and AbstractSAFSCustomLoggingService provide a sample custom logging service implementation that writes directly to the STAF logs.

See Also:

AbstractSAFSCustomLoggingService, SAFSCustomLoggingService, SAFSCustomLoggingService3

Field Summary

Fields

Modifier and Type	Field and Description
static int	CUSTOM_MESSAGE
static int	DEBUG_MESSAGE
static int	END_COUNTER
static int	END_CYCLE
static int	END_DATATABLE
static int	END_PROCEDURE
static int	END_REQUIREMENT
static int	END_SUITE
static int	END_TESTCASE
static int	FAILED_MESSAGE
static int	FAILED_OK_MESSAGE
static int	GENERIC_MESSAGE
static long	LOGMODE_CONSOLE Bit flag constant for enabling tool's console log.
static long	LOGMODE_DISABLED Disable all logs.
static long	LOGMODE_MAX Enable all logs.
static long	LOGMODE_SAFS_TEXT Bit flag constant for enabling standard SAFS text file log.
static long	LOGMODE_SAFS_XML Bit flag constant for enabling standard SAFS xml file log.
static long	LOGMODE_TOOL Bit flag constant for enabling tool specific log.
static int	PASSED_MESSAGE
static int	RESUME_STATUS_COUNTS
static int	SKIPPED_TEST_MESSAGE
static int	START_COUNTER
static int	START_CYCLE
static int	START_DATATABLE
static int	START_LOGGING
static int	START_PROCEDURE
static int	START_REQUIREMENT
static int	START_SUITE
static int	START_TESTCASE
static int	STATUS_REPORT_END
static int	STATUS_REPORT_GENERAL_FAILURES
static int	STATUS_REPORT_GENERAL_WARNINGS
static int	STATUS_REPORT_IO_FAILURES
static int	STATUS_REPORT_RECORDS
static int	STATUS_REPORT_SKIPPED
static int	STATUS_REPORT_START
static int	STATUS_REPORT_TEST_FAILURES
static int	STATUS_REPORT_TEST_PASSES
static int	STATUS_REPORT_TEST_WARNINGS
static int	STATUS_REPORT_TESTS
static int	STOP_LOGGING
static int	SUSPEND_STATUS_COUNTS
static int	WARNING_MESSAGE
static int	WARNING_OK_MESSAGE

Constructor Summary

Constructors

Constructor and Description
CustomLogFac(java.lang.String name, long mode, java.lang.String linked, HandleInterface h, java.lang.String stafLog) Creates a CustomLogFac.

Method Summary

Modifier and Type	Method and Description
void	close() Closes all logs of this log facility.
java.lang.String	getFacName() Returns the name of this log facility.
boolean	isModeEnabled(long mode) Tests if the specified log mode is enabled.
com.ibm.staf.STAFResult	logMessage(java.lang.String msg, java.lang.String desc, int msgType) Logs a message to all the enabled logs.

Methods inherited from class java.lang.Object

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

Field Detail

START_PROCEDURE

public static final int START_PROCEDURE

See Also:

Constant Field Values

END_PROCEDURE

public static final int END_PROCEDURE

See Also:

Constant Field Values

START_DATATABLE

public static final int START_DATATABLE

See Also:

Constant Field Values

START_TESTCASE

public static final int START_TESTCASE

See Also:

Constant Field Values

START_SUITE

public static final int START_SUITE

See Also:

Constant Field Values

END_SUITE

public static final int END_SUITE

See Also:

Constant Field Values

END_TESTCASE

public static final int END_TESTCASE

See Also:

Constant Field Values

START_CYCLE

public static final int START_CYCLE

See Also:

Constant Field Values

END_CYCLE

public static final int END_CYCLE

See Also:

Constant Field Values

START_COUNTER

public static final int START_COUNTER

See Also:

Constant Field Values

END_COUNTER

public static final int END_COUNTER

See Also:

Constant Field Values

SUSPEND_STATUS_COUNTS

public static final int SUSPEND_STATUS_COUNTS

See Also:

Constant Field Values

RESUME_STATUS_COUNTS

public static final int RESUME_STATUS_COUNTS

See Also:

Constant Field Values

START_LOGGING

public static final int START_LOGGING

See Also:

Constant Field Values

STOP_LOGGING

public static final int STOP_LOGGING

See Also:

Constant Field Values

STATUS_REPORT_START

public static final int STATUS_REPORT_START

See Also:

Constant Field Values

STATUS_REPORT_RECORDS

public static final int STATUS_REPORT_RECORDS

See Also:

Constant Field Values

STATUS_REPORT_SKIPPED

public static final int STATUS_REPORT_SKIPPED

See Also:

Constant Field Values

STATUS_REPORT_TESTS

public static final int STATUS_REPORT_TESTS

See Also:

Constant Field Values

STATUS_REPORT_TEST_PASSES

public static final int STATUS_REPORT_TEST_PASSES

See Also:

Constant Field Values

STATUS_REPORT_TEST_WARNINGS

public static final int STATUS_REPORT_TEST_WARNINGS

See Also:

Constant Field Values

STATUS_REPORT_TEST_FAILURES

public static final int STATUS_REPORT_TEST_FAILURES

See Also:

Constant Field Values

STATUS_REPORT_GENERAL_WARNINGS

public static final int STATUS_REPORT_GENERAL_WARNINGS

See Also:

Constant Field Values

STATUS_REPORT_GENERAL_FAILURES

public static final int STATUS_REPORT_GENERAL_FAILURES

See Also:

Constant Field Values

STATUS_REPORT_IO_FAILURES

public static final int STATUS_REPORT_IO_FAILURES

See Also:

Constant Field Values

STATUS_REPORT_END

public static final int STATUS_REPORT_END

See Also:

Constant Field Values

START_REQUIREMENT

public static final int START_REQUIREMENT

See Also:

Constant Field Values

END_REQUIREMENT

public static final int END_REQUIREMENT

See Also:

Constant Field Values

SKIPPED_TEST_MESSAGE

public static final int SKIPPED_TEST_MESSAGE

See Also:

Constant Field Values

END_DATATABLE

public static final int END_DATATABLE

See Also:

Constant Field Values

DEBUG_MESSAGE

public static final int DEBUG_MESSAGE

See Also:

Constant Field Values

GENERIC_MESSAGE

public static final int GENERIC_MESSAGE

See Also:

Constant Field Values

FAILED_MESSAGE

public static final int FAILED_MESSAGE

See Also:

Constant Field Values

FAILED_OK_MESSAGE

public static final int FAILED_OK_MESSAGE

See Also:

Constant Field Values

PASSED_MESSAGE

public static final int PASSED_MESSAGE

See Also:

Constant Field Values

WARNING_MESSAGE

public static final int WARNING_MESSAGE

See Also:

Constant Field Values

WARNING_OK_MESSAGE

public static final int WARNING_OK_MESSAGE

See Also:

Constant Field Values

CUSTOM_MESSAGE

public static final int CUSTOM_MESSAGE

See Also:

Constant Field Values

LOGMODE_DISABLED

public static final long LOGMODE_DISABLED

Disable all logs. Not to be used as LogItem type.

See Also:

Constant Field Values

LOGMODE_TOOL

public static final long LOGMODE_TOOL

Bit flag constant for enabling tool specific log. Also identifies a LogItem as a tool-specific log.

See Also:

Constant Field Values

LOGMODE_CONSOLE

public static final long LOGMODE_CONSOLE

Bit flag constant for enabling tool's console log. Also identifies a LogItem as a tool-specific console log.

See Also:

Constant Field Values

LOGMODE_SAFS_TEXT

public static final long LOGMODE_SAFS_TEXT

Bit flag constant for enabling standard SAFS text file log. Also identifies a LogItem as standard SAFS text file log.

See Also:

Constant Field Values

LOGMODE_SAFS_XML

public static final long LOGMODE_SAFS_XML

Bit flag constant for enabling standard SAFS xml file log. Also identifies a LogItem as standard SAFS xml file log.

See Also:

Constant Field Values

LOGMODE_MAX

public static final long LOGMODE_MAX

Enable all logs. Not to be used as LogItem type.

See Also:

Constant Field Values

Constructor Detail

CustomLogFac

public CustomLogFac(java.lang.String name,
                    long mode,
                    java.lang.String linked,
                    HandleInterface h,
                    java.lang.String stafLog)

Creates a CustomLogFac.

Parameters:

name - the name of this custom log facility.

mode - the log mode of this custom log facility.

linked - the name of the log facility linked to this one.

h - the STAF handle for interacting with STAF.

stafLog - the name of the STAF Log service loaded by standard logging service.

Method Detail

getFacName

public java.lang.String getFacName()

Returns the name of this log facility.

Returns:

the name of this log facility.

isModeEnabled

public boolean isModeEnabled(long mode)

Tests if the specified log mode is enabled.

Parameters:

mode - the mode to test. Must be one of the LOGMODE constants.

Returns:

true if mode is enabled; false if not.

logMessage

public com.ibm.staf.STAFResult logMessage(java.lang.String msg,
                                          java.lang.String desc,
                                          int msgType)

Logs a message to all the enabled logs.

Parameters:

msg - the message to log.

desc - additional description to log.

msgType - the int identifier of the type of message being logged.

Returns:

a STAFResult indicating the result of the operation and whether normal logging is to be bypassed. Normal logging will be bypassed if rc of the return value is STAFResult.Ok and the result buffer is "BYPASS".

close

public void close()

Closes all logs of this log facility.