net.sourceforge.esw.service.log
Class ALog

java.lang.Object
  |
  +--net.sourceforge.esw.util.SupportObject
        |
        +--net.sourceforge.esw.service.AService
              |
              +--net.sourceforge.esw.service.ADefaultService
                    |
                    +--net.sourceforge.esw.service.log.ALog

All Implemented Interfaces:

ILog, IService, ISupportObject, java.io.Serializable

Direct Known Subclasses:

LogDissemination, MailLog, SystemOutLog, TransducerLog

public abstract class ALog

extends ADefaultService

implements ILog

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:

, ILog, ILogDatum, LogFactory, Serialized Form

Fields inherited from class net.sourceforge.esw.service.ADefaultService

classServer, joinManager, proxy, serviceID

Fields inherited from class net.sourceforge.esw.service.AService

bStarted, heartbeatGenerator, priority

Fields inherited from class net.sourceforge.esw.util.SupportObject

id, properties, propertyChildren, propertyListeners, vetoableChildren, vetoableListeners

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

PRIMARY, SECONDARY, TERTIARY, UNAVAILABLE

Constructor Summary

ALog()
Creates a new ALog.

ALog(java.lang.Object aID)
Creates a new ALog.

Method Summary

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

Methods inherited from class net.sourceforge.esw.service.ADefaultService

die, persist, register, register, register, register, register, restore

Methods inherited from class net.sourceforge.esw.service.AService

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

Methods inherited from class net.sourceforge.esw.util.SupportObject

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

Constructor Detail

ALog

public ALog()

Creates a new ALog.

ALog

public ALog(java.lang.Object aID)

Creates a new ALog.

Method Detail

log

public void log(ILogDatum aDatum)
         throws LoggingException

Logs the specified ILogDatum instance to this ILog instance.

This reference implmentation calls log( LogUtil.convertDatumToNode( aDatum ) ), deligating the implementation of this method to the other log method.

Specified by:

log in interface ILog

Parameters:

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

See Also:

log( INode )

log

public abstract void log(INode aNode)
                  throws LoggingException

Logs the specified INode instance to this ILog instance.

Specified by:

log in interface ILog

Parameters:

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