com.metamatrix.platform.security.audit.destination
Interface AuditDestination

All Known Implementing Classes:

AbstractAuditDestination, ConsoleAuditDestination, DatabaseAuditDestination, SingleFileAuditDestination

public interface AuditDestination

A log destination can be used to print messages - typical examples are a file, System.out, a database, a GUI console, etc.

Field Summary

static java.lang.String

PROPERTY_PREFIX The name of the System property that contains the name of the AuditMessageFormat class that is used to format messages sent to the file destination.

Method Summary

java.lang.String	getDescription() Get a short description of this logging destination.
java.util.List	getPropertyNames() Get names of all properties used for this destination.
void	initialize(java.util.Properties props) Initialize this destination with the specified properties.
void	record(AuditMessage message) Print the message to the log destination.
void	shutdown() Shutdown the log destination and clean up resources.

Field Detail

PROPERTY_PREFIX

static final java.lang.String PROPERTY_PREFIX

The name of the System property that contains the name of the AuditMessageFormat class that is used to format messages sent to the file destination. This is an optional property; if not specified and the file destination is used, then the DelimitedAuditMessageFormat is used.

See Also:

Constant Field Values

Method Detail

getDescription

java.lang.String getDescription()

Get a short description of this logging destination. This is used for simple reporting.

Returns:

Short description

initialize

void initialize(java.util.Properties props)
                throws AuditDestinationInitFailedException

Initialize this destination with the specified properties.

Parameters:

props - the properties that this destination should use to initialize itself.

Throws:

AuditDestinationInitFailedException - if there was an error during initialization.

getPropertyNames

java.util.List getPropertyNames()

Get names of all properties used for this destination.

record

void record(AuditMessage message)

Print the message to the log destination.

Parameters:

message - The message to print

shutdown

void shutdown()

Shutdown the log destination and clean up resources.