org.apache.jcs.engine.logging.behavior
Interface ICacheEventLogger

All Known Implementing Classes:
CacheEventLoggerDebugLogger

public interface ICacheEventLogger

This defines the behavior for event logging. Auxiliaries will send events to injected event loggers.

In general all ICache interface methods should call the logger if one is configured. This will be done on an ad hoc basis for now. Various auxiliaries may have additional events.


Field Summary
static java.lang.String DISPOSE_EVENT
          ICache dispose
static java.lang.String GET_EVENT
          ICache get
static java.lang.String GETMATCHING_EVENT
          ICache getMatching
static java.lang.String GETMULTIPLE_EVENT
          ICache getMultiple
static java.lang.String REMOVE_EVENT
          ICache remove
static java.lang.String REMOVEALL_EVENT
          ICache removeAll
static java.lang.String UPDATE_EVENT
          ICache update
 
Method Summary
 ICacheEvent createICacheEvent(java.lang.String source, java.lang.String region, java.lang.String eventName, java.lang.String optionalDetails, java.io.Serializable key)
          Creates an event.
 void logApplicationEvent(java.lang.String source, java.lang.String eventName, java.lang.String optionalDetails)
          Logs an event.
 void logError(java.lang.String source, java.lang.String eventName, java.lang.String errorMessage)
          Logs an error.
 void logICacheEvent(ICacheEvent event)
          Logs an event.
 

Field Detail

UPDATE_EVENT

static final java.lang.String UPDATE_EVENT
ICache update

See Also:
Constant Field Values

GET_EVENT

static final java.lang.String GET_EVENT
ICache get

See Also:
Constant Field Values

GETMULTIPLE_EVENT

static final java.lang.String GETMULTIPLE_EVENT
ICache getMultiple

See Also:
Constant Field Values

GETMATCHING_EVENT

static final java.lang.String GETMATCHING_EVENT
ICache getMatching

See Also:
Constant Field Values

REMOVE_EVENT

static final java.lang.String REMOVE_EVENT
ICache remove

See Also:
Constant Field Values

REMOVEALL_EVENT

static final java.lang.String REMOVEALL_EVENT
ICache removeAll

See Also:
Constant Field Values

DISPOSE_EVENT

static final java.lang.String DISPOSE_EVENT
ICache dispose

See Also:
Constant Field Values
Method Detail

createICacheEvent

ICacheEvent createICacheEvent(java.lang.String source,
                              java.lang.String region,
                              java.lang.String eventName,
                              java.lang.String optionalDetails,
                              java.io.Serializable key)
Creates an event.

Parameters:
source - - e.g. RemoteCacheServer
region - - the name of the region
eventName - - e.g. update, get, put, remove
optionalDetails - - any extra message
key - - the cache key
Returns:
ICacheEvent

logICacheEvent

void logICacheEvent(ICacheEvent event)
Logs an event.

Parameters:
event - - the event created in createICacheEvent

logApplicationEvent

void logApplicationEvent(java.lang.String source,
                         java.lang.String eventName,
                         java.lang.String optionalDetails)
Logs an event. These are internal application events that do not correspond to ICache calls.

Parameters:
source - - e.g. RemoteCacheServer
eventName - - e.g. update, get, put, remove
optionalDetails - - any extra message

logError

void logError(java.lang.String source,
              java.lang.String eventName,
              java.lang.String errorMessage)
Logs an error.

Parameters:
source - - e.g. RemoteCacheServer
eventName - - e.g. update, get, put, remove
errorMessage - - any error message


Copyright © 2002-2009 Apache Software Foundation. All Rights Reserved.