org.alfresco.bm.common.util.log

Class MongoLogService

java.lang.Object

org.alfresco.bm.common.util.log.MongoLogService

All Implemented Interfaces:

LifecycleListener, LogService

public class MongoLogService
extends Object
implements LifecycleListener, LogService

Mongo implementation of service providing log message persistence

Since:

2.0

Author:

Derek Hulley

Nested Class Summary

Nested classes/interfaces inherited from interface org.alfresco.bm.common.util.log.LogService

LogService.LogLevel

Field Summary

Fields

Modifier and Type	Field and Description
static String	COLLECTION_LOGS
static String	FIELD_DRIVER_ID
static String	FIELD_ID
static String	FIELD_LEVEL
static String	FIELD_MSG
static String	FIELD_TEST
static String	FIELD_TEST_RUN
static String	FIELD_TIME

Constructor Summary

Constructors

Constructor and Description
MongoLogService(com.mongodb.DB db, int size, int max, int ttl) Construct an instance providing the DB and collection name to use

Method Summary

Modifier and Type	Method and Description
com.mongodb.DBCursor	getLogs(String driverId, String test, String testRun, LogService.LogLevel level, Long minTime, Long maxTime, int skip, int limit) Retrieve log messages in a cursor
void	log(String driverId, String test, String testRun, LogService.LogLevel level, String msg) Log a message
void	start()
void	stop()

Methods inherited from class java.lang.Object

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

Field Detail

COLLECTION_LOGS

public static final String COLLECTION_LOGS

See Also:

Constant Field Values

FIELD_ID

public static final String FIELD_ID

See Also:

Constant Field Values

FIELD_TIME

public static final String FIELD_TIME

See Also:

Constant Field Values

FIELD_DRIVER_ID

public static final String FIELD_DRIVER_ID

See Also:

Constant Field Values

FIELD_TEST

public static final String FIELD_TEST

See Also:

Constant Field Values

FIELD_TEST_RUN

public static final String FIELD_TEST_RUN

See Also:

Constant Field Values

FIELD_LEVEL

public static final String FIELD_LEVEL

See Also:

Constant Field Values

FIELD_MSG

public static final String FIELD_MSG

See Also:

Constant Field Values

Constructor Detail

MongoLogService

public MongoLogService(com.mongodb.DB db,
                       int size,
                       int max,
                       int ttl)

Construct an instance providing the DB and collection name to use

Parameters:

db - the database to use

size - the size (bytes) to cap the log size at or 0 to ignore. This must be zero if the TTL is set.

max - the maximum number of log entries or 0 to ignore. This must be zero if the TTL is set.

ttl - the time to live (seconds) of a log message or 0 to ignore. This must be zero or less if the logs are capped by size or max entries.

Method Detail

start

public void start()

Specified by:

start in interface LifecycleListener

stop

public void stop()

Specified by:

stop in interface LifecycleListener

log

public void log(String driverId,
                String test,
                String testRun,
                LogService.LogLevel level,
                String msg)

Description copied from interface: LogService

Log a message

Specified by:

log in interface LogService

Parameters:

driverId - the driver ID from which the message originated (optional)

test - the name of the test (optional)

testRun - the name of the test run (optional)

level - the severity of the message

msg - the log message

getLogs

public com.mongodb.DBCursor getLogs(String driverId,
                                    String test,
                                    String testRun,
                                    LogService.LogLevel level,
                                    Long minTime,
                                    Long maxTime,
                                    int skip,
                                    int limit)

Description copied from interface: LogService

Retrieve log messages in a cursor

Specified by:

getLogs in interface LogService

Parameters:

driverId - driver ID (optional)

test - the name of the test (optional)

testRun - the name of the test run (optional)

level - minimum severity (optional)

minTime - minimum log message time (inclusive)

maxTime - maximum log message time (exlusive)

skip - number of results to skip

limit - limit the total number of results

Returns:

a results cursor that must be closed