com.digi.config.util
Class SystemLogCtlrImpl

java.lang.Object
  com.digi.config.core.ControlledItemImpl
      com.digi.config.core.ControllerImpl
          com.digi.config.util.SystemLogCtlrImpl

All Implemented Interfaces:

java.lang.Comparable, ControlledItem, Controller, java.io.Serializable, SystemLogCtlr

public class SystemLogCtlrImpl

extends ControllerImpl

implements SystemLogCtlr

Defines the operations and constants associated with the System Log. The system log maintains a collection of log entries on either the client or server system and helps manage their life-cycle. The controller also serves as a factory for new system log entries. Defines a Log facility that can be used in both the config client and server to record error or user messages. Users can register interest in the log activity.

See Also:

SystemLog, Serialized Form

Field Summary

Fields inherited from class com.digi.config.core.ControllerImpl

isActive, itemCollection, itemMap, membershipListener, persistanceFileName

Fields inherited from class com.digi.config.core.ControlledItemImpl

Fields inherited from interface com.digi.config.util.SystemLogCtlr

CONFIG_LOG_FILE_NAME_KEY, LOG_DEBUG_MSG_KEY, LOG_FILE_NAME_KEY, LOG_TO_FILE_KEY

Fields inherited from interface com.digi.config.core.ControlledItem

ALTERNATE_SORT_VALUE_KEY, BASE_SORT_VALUE_KEY

Constructor Summary

(package private)

SystemLogCtlrImpl(java.lang.String resourceKey) Create the System Log Note: This constructor is package protected because it should be constructed by and access through the SystemLog class.

Method Summary

void	add(SystemLogEntry item) Adds a LogEntry to the SystemLog.
boolean	isDebugLoggingEnabled() Returns a flag indicating if debug messages are currently being logged

Methods inherited from class com.digi.config.core.ControllerImpl

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

Methods inherited from class com.digi.config.core.ControlledItemImpl

compareTo, equals, getAlternateSortValue, getBaseSortValue, getOwningCtlrId, hashCode, isActive, nullSafeCompare, setAlternateSortValue, setBaseSortValue, setOwningCtlrId, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

Constructor Detail

SystemLogCtlrImpl

SystemLogCtlrImpl(java.lang.String resourceKey)

Create the System Log Note: This constructor is package protected because it should be constructed by and access through the SystemLog class. The SystemLog class assures a singleton instance of the controller.

See Also:

SystemLog

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.

Specified by:

add in interface SystemLogCtlr

Parameters:

item - the SystemLogEntry to add to the SystemLogCtlr

Throws:

java.lang.Exception

isDebugLoggingEnabled

public boolean isDebugLoggingEnabled()

Returns a flag indicating if debug messages are currently being logged