com.highqsoft.fwk.exception

Interface FwkExceptionWriterInterface

All Superinterfaces:

FwkInterface, java.io.Serializable

All Known Implementing Classes:

FwkExceptionWriter, FwkFileWriter, FwkLibraryWriter

public interface FwkExceptionWriterInterface
extends FwkInterface

The FwkExceptionWriterInterface defines the methods that should be implemented from a exception writer. Determine type of event Values are 32 bit values layed out as follows:

3 3 2 2 2 2 2 2 2 2 2 2 1 1 1 1 1 1 1 1 1 1
1 0 9 8 7 6 5 4 3 2 1 0 9 8 7 6 5 4 3 2 1 0 9 8 7 6 5 4 3 2 1 0
+---+-+-+-----------------------+-------------------------------+
|Sev|C|R| Facility | Code |
+---+-+-+-----------------------+-------------------------------+
where

Sev - is the severity code (Typ der Meldung)

00 - Success
01 - Informational
10 - Warning
11 - Error


C - is the Customer code flag

R - is a reserved bit

Facility - is the facility code

Code - is the facility's status code

Since:

$Date: 2017/04/06 13:29:06 $

Version:

$Revision: 1.13 $

Author:

Andreas Hofmann

See Also:

LibraryWriter, FileWriter

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Close the communication to the event logger.
java.lang.Throwable	getException() Returns the exception that is occurred, if the writer isn't alive.
void	init(java.lang.String program, java.lang.String version, java.lang.String[] args) Initialize the communication to the event logger.
boolean	isAlive() Returns whether the writer was successfully initialized.
boolean	isError(int code) Return true if event code signals an error.
boolean	isInformation(int code) Return true if event code signals an informational message.
boolean	isOccurred() Indicates whether an event is occurred.
boolean	isWarning(int code) Return true if event code signals a warning.
void	put(FwkExceptionInterface exception) Put an event to the event logger.
void	put(int code, java.lang.String className, java.lang.String file, java.lang.String revision, java.lang.String lineIdent, java.lang.String parameter) Put an event to the event logger.
void	reset() Reset the the current error messages.

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkInterface

getVersion, release

Method Detail

isAlive

boolean isAlive()

Returns whether the writer was successfully initialized.

Returns:

True if the writer is initialized.

getException

java.lang.Throwable getException()

Returns the exception that is occurred, if the writer isn't alive.

Returns:

The exception thrown by the static initializer.

init

void init(java.lang.String program,
        java.lang.String version,
        java.lang.String[] args)

Initialize the communication to the event logger. Reset the writer inside this routine.

Parameters:

name - Name of program.

version - Version of the program.

args - Main program parameters.

put

void put(int code,
       java.lang.String className,
       java.lang.String file,
       java.lang.String revision,
       java.lang.String lineIdent,
       java.lang.String parameter)

Put an event to the event logger. When more than 10 (MAX_ERROR)identical events occurred the report of the event is suppressed.

The compiler definition NOTRACE suppresses the message AO_EVENT. The message AO_EVENT is used to trace back the calling sequence of the function where the error occurs.

If this function is called an error is occurred and the flag is set.

Parameters:

number - Number of the event to report.

class - Name of the class that has thrown the exception.

file - Name of the sourcefile.

revision - Revision of the sourcefile.

lineIdent - Identification string for the line in the sourcefile.

parameter - Event parameter.

put

void put(FwkExceptionInterface exception)

Put an event to the event logger. When more than 10 (MAX_ERROR)identical events occurred the report of the event is suppressed.

The compiler definition NOTRACE suppresses the message AO_EVENT. The message AO_EVENT is used to trace back the calling sequence of the function where the error occurs.

If this function is called an error is occurred and the flag is set.

Parameters:

exception - The exception that should be written.

close

void close()

Close the communication to the event logger.

isError

boolean isError(int code)

Return true if event code signals an error.

Parameters:

code - The event code

See Also:

ErrorNumber

isWarning

boolean isWarning(int code)

Return true if event code signals a warning.

Parameters:

code - The event code

See Also:

ErrorNumber

isInformation

boolean isInformation(int code)

Return true if event code signals an informational message.

Parameters:

code - The event code

See Also:

ErrorNumber

isOccurred

boolean isOccurred()

Indicates whether an event is occurred.

Returns:

Returns true if an event occurred.

reset

void reset()

Reset the the current error messages.