Package org.codice.ddf.platform.logging

Class LoggingService

java.lang.Object

org.codice.ddf.platform.logging.LoggingService

All Implemented Interfaces:

LoggingServiceMBean, org.ops4j.pax.logging.spi.PaxAppender

public class LoggingService
extends Object
implements org.ops4j.pax.logging.spi.PaxAppender, LoggingServiceMBean

A custom PaxAppender which receives PaxLoggingEvents and is the Jolokia endpoint for the Logging UI in the Admin Console.

Constructor Summary

Constructors

Constructor	Description
LoggingService(MBeanServer mBeanServer)	Constructor

Method Summary

Modifier and Type	Method	Description
void	destroy()
void	doAppend(org.ops4j.pax.logging.spi.PaxLoggingEvent paxLoggingEvent)	Called each time a PaxLoggingEvent is created in the system
int	getMaxLogEvents()
void	init()
List<LogEvent>	retrieveLogEvents()	Retrieves all of the stored LogEvents
void	setMaxLogEvents(int newMaxLogEvents)	Sets the maximum number of LogEvents to store

Methods inherited from class java.lang.Object

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

Constructor Details

LoggingService

public LoggingService(MBeanServer mBeanServer)

Constructor

Parameters:

mBeanServer - object used to register this object as an MBean

Method Details

init

public void init()
          throws MBeanRegistrationException,
MalformedObjectNameException,
InstanceAlreadyExistsException,
InstanceNotFoundException,
NotCompliantMBeanException

Throws:

MBeanRegistrationException

MalformedObjectNameException

InstanceAlreadyExistsException

InstanceNotFoundException

NotCompliantMBeanException

destroy

public void destroy()

doAppend

public void doAppend(org.ops4j.pax.logging.spi.PaxLoggingEvent paxLoggingEvent)

Called each time a PaxLoggingEvent is created in the system

Specified by:

doAppend in interface org.ops4j.pax.logging.spi.PaxAppender

retrieveLogEvents

public List<LogEvent> retrieveLogEvents()

Description copied from interface: LoggingServiceMBean

Retrieves all of the stored LogEvents

Specified by:

retrieveLogEvents in interface LoggingServiceMBean

Returns:

non-null list of LogEvents in ascending order

setMaxLogEvents

public void setMaxLogEvents(int newMaxLogEvents)

Sets the maximum number of LogEvents to store

Parameters:

newMaxLogEvents - This number cannot be less than 0 or greater than MAX_LOG_EVENTS_LIMIT. In the event that this parameter is less than 0 or greater than MAX_LOG_EVENTS_LIMIT, the maximum log events stored will set set to MAX_LOG_EVENTS_LIMIT.

getMaxLogEvents

public int getMaxLogEvents()