fuseguard.components.loggers
Component BaseLogger

loggers.BaseLogger

Method Summary
public any	init([any firewallInstance])
public boolean	escapesMessage()           Returns true if the log messages are escaped
public array	getConfigurables()           Returns configurable settings.
public string	getDescription()           Returns a description of how this logger works
public string	getName()           Returns the name of this logger
public string	getStorageDescription()           Returns a description of where the data is stored, eg datasource name.
public boolean	hasLogReader()           If this logger has an associated log reader, return true
public boolean	isPurgeable()           Tells if the logger is purgeable by calling purgeLogs
public boolean	isVerbose()           Returns true if verbose logging is enabled.
public boolean	isViewable()           If the log is viewable such as a file or DB return true, if not (email, or IM) return false.
public boolean	logOnlyBlocked()           Returns true if only blocked events are logged
public void	logRequest(numeric level, [any filter], [variablename type="inspectRequest"], [string message=""], [string detail=""])
public void	purgeLogs()           Purges or deletes logs older the the specified number of days
public void	setEscapeMessage([boolean escapeMessage])           Turns on or off log message escaping, beware that turning this off may not be a good idea.
public void	setLogOnlyBlocked([boolean logOnlyBlocks="false"])           When true logs only blocked events
public void	setVerbose(boolean verbose)           Tells the logger to be brief if set to false

 

Method Detail

escapesMessage

public boolean escapesMessage()

Returns true if the log messages are escaped

getConfigurables

public array getConfigurables()

Returns configurable settings.

getDescription

public string getDescription()

Returns a description of how this logger works

getName

public string getName()

Returns the name of this logger

getStorageDescription

public string getStorageDescription()

Returns a description of where the data is stored, eg datasource name.

hasLogReader

public boolean hasLogReader()

If this logger has an associated log reader, return true

init

public any init([any firewallInstance])

Parameters:

[any firewallInstance]

isPurgeable

public boolean isPurgeable()

Tells if the logger is purgeable by calling purgeLogs

isVerbose

public boolean isVerbose()

Returns true if verbose logging is enabled.

isViewable

public boolean isViewable()

If the log is viewable such as a file or DB return true, if not (email, or IM) return false.

logOnlyBlocked

public boolean logOnlyBlocked()

Returns true if only blocked events are logged

logRequest

public void logRequest(numeric level, [any filter], [variablename type="inspectRequest"], [string message=""], [string detail=""])

Parameters:

numeric level

[any filter] - a Filter object

[variablename type="inspectRequest"]

[string message=""]

[string detail=""]

purgeLogs

public void purgeLogs()

Purges or deletes logs older the the specified number of days

setEscapeMessage

public void setEscapeMessage([boolean escapeMessage])

Turns on or off log message escaping, beware that turning this off may not be a good idea.

Parameters:

[boolean escapeMessage]

setLogOnlyBlocked

public void setLogOnlyBlocked([boolean logOnlyBlocks="false"])

When true logs only blocked events

Parameters:

[boolean logOnlyBlocks="false"]

setVerbose

public void setVerbose(boolean verbose)

Tells the logger to be brief if set to false

Parameters:

boolean verbose