net.sourceforge.esw.service.log
Interface ILog

All Superinterfaces:

IService, ISupportObject, java.io.Serializable

All Known Subinterfaces:

ILogDissemination

All Known Implementing Classes:

ALog, LogProxy, ReferenceLog, SystemOutLog

public interface ILog

extends IService

Describes the methods available for logging events from the enterprise.

There are two ways to log using an this ILog instance. The first is to use the log(INode aNode) method. This requires that the INode instance contains INode instances that have the correct ID and data types. The second way is to use the log(ILogDatum aDatum) method. This is the preferred way to log data. Create a ILogDatum instance using the LogFactory.createLogDatum() method, then pass that ILogDatum instance to this ILog instance.

To create an instance of this ILog, see LogFactory.getLog().

Examples:

    ILog log = LogFactory.getLog();
    ILogDatum datum = LogFactory.createLogDatum(new Date(),             // when
                                                "Machine Named George", // where
                                                5,                      // importance
                                                "A bad thing happened", // simple what
                                                myNode,                 // complex what
                                                "My App");              // who
    log.log( datum );
 

See Also:

net.sourceforge.esw.service.graph.INode, ILog, ILogDatum, LogFactory

Fields inherited from interface net.sourceforge.esw.service.IService

PRIMARY, SECONDARY, TERTIARY, UNAVAILABLE

Method Summary

void	log(ILogDatum aDatum) Logs the specified ILogDatum instance to this ILog instance.
void	log(INode aNode) Logs the specified INode instance to this ILog instance.

Methods inherited from interface net.sourceforge.esw.service.IService

die, getHeartbeatGenerator, getPriority, isSane, isStarted, ping, setPriority, start, stop

Methods inherited from interface net.sourceforge.esw.util.ISupportObject

addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, addVetoableChangeListener, firePropertyChange, firePropertyChange, fireVetoableChange, fireVetoableChange, getID, getProperty, getPropertySize, propertyKeys, removeProperty, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, removeVetoableChangeListener, setID, setProperty

Method Detail

log

public void log(INode aNode)
         throws LoggingException

Logs the specified INode instance to this ILog instance.

Parameters:

aNode - the INode instance containing the data of the event to be logged

Throws:

LoggingException -

log

public void log(ILogDatum aDatum)
         throws LoggingException

Logs the specified ILogDatum instance to this ILog instance.

Parameters:

aDatum - the ILogDatum instance containing the data of the event to be logged