com.digi.config.util
Interface SystemLogCtlr

All Superinterfaces:

Controller, java.io.Serializable

All Known Implementing Classes:

SystemLogCtlrImpl

public interface SystemLogCtlr

extends Controller

Defines the operations and constants associated with the System Log Controller. The system log maintains a collection of log entries on either the client or server system and helps manage their life-cycle.

See Also:

This class provides a variety of helper methods that clients should use to access and log messages the SystemLogCtlr.

Field Summary

static java.lang.String	CONFIG_LOG_FILE_NAME_KEY
static java.lang.String	LOG_DEBUG_MSG_KEY
static java.lang.String	LOG_FILE_NAME_KEY
static java.lang.String	LOG_TO_FILE_KEY

Method Summary

void	add(SystemLogEntry item) Adds a LogEntry to the SystemLog.

Methods inherited from interface com.digi.config.core.Controller

add, addControllerMembershipListener, contains, dump, get, getCount, getCount, getDefaultComparator, getElement, getElements, getElements, getId, getIterator, remove, removeAll, removeControllerMembershipListener, resort, setDefaultComparator

Field Detail

LOG_TO_FILE_KEY

public static final java.lang.String LOG_TO_FILE_KEY

See Also:

Constant Field Values

LOG_FILE_NAME_KEY

public static final java.lang.String LOG_FILE_NAME_KEY

See Also:

Constant Field Values

LOG_DEBUG_MSG_KEY

public static final java.lang.String LOG_DEBUG_MSG_KEY

See Also:

Constant Field Values

CONFIG_LOG_FILE_NAME_KEY

public static final java.lang.String CONFIG_LOG_FILE_NAME_KEY

See Also:

Constant Field Values

Method Detail

add

public void add(SystemLogEntry item)
         throws java.lang.Exception

Adds a LogEntry to the SystemLog. This method will also write an entry to the log file if the logToFile flag is enabled.

Parameters:

item - the SystemLogEntry to add to the SystemLogCtlr

Throws:

java.lang.Exception