org.lsst.ccs.bus.utils

Class LogBusHandler

java.lang.Object

java.util.logging.Handler

org.lsst.ccs.bus.utils.LogBusHandler

All Implemented Interfaces:

Closeable, AutoCloseable

public class LogBusHandler
extends Handler
implements Closeable

A java util log Handler that forwards messages to the Log bus. As it may be used in the context of "multi-logging" of the org.lsst.ccs.utilities.logging package it checks for duplicate messages.
Should be a singleton with delegation to a unique static instance (but how to pass the communication layer?) If we share two subsystems on the same JVM the Singleton will not work so it is utmost importance to get the subsystemName directly and create two instances!!!

Author:

bamade

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	closed
protected ExecutorService	executor
protected MessagingFactory	fac
protected static IsLoggableDelegate	isLoggableDelegate
protected boolean	logBusInitialized
protected boolean	panicState
protected String	subSystemName

Constructor Summary

Constructors

Constructor and Description
LogBusHandler()
LogBusHandler(String subsystemName, MessagingFactory fac)

Method Summary

Modifier and Type	Method and Description
void	close()
void	flush()
String	getSubSystemName()
boolean	inPanicState()
boolean	isLoggable(LogRecord record)
void	publish(LogRecord record) should send a LogRecord over the Log Bus.
void	setLevel(Level level)
void	setMessagingFactory(MessagingFactory fact)
void	setPanicState(boolean panicState)

Methods inherited from class java.util.logging.Handler

getEncoding, getErrorManager, getFilter, getFormatter, getLevel, reportError, setEncoding, setErrorManager, setFilter, setFormatter

Methods inherited from class java.lang.Object

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

Field Detail

isLoggableDelegate

protected static IsLoggableDelegate isLoggableDelegate

fac

protected MessagingFactory fac

panicState

protected boolean panicState

closed

protected boolean closed

subSystemName

protected String subSystemName

executor

protected ExecutorService executor

logBusInitialized

protected volatile boolean logBusInitialized

Constructor Detail

LogBusHandler

public LogBusHandler(String subsystemName,
                     MessagingFactory fac)

LogBusHandler

public LogBusHandler()

Method Detail

setMessagingFactory

public void setMessagingFactory(MessagingFactory fact)

inPanicState

public boolean inPanicState()

setPanicState

public void setPanicState(boolean panicState)

getSubSystemName

public String getSubSystemName()

publish

public void publish(LogRecord record)

should send a LogRecord over the Log Bus. To avoid panic state this method is synchronized and marks a panic as "true" if a log message cannot be sent over the Log bus. It's up to the subsystem to restore a correct Panic mode.

Specified by:

publish in class Handler

Parameters:

record -

flush

public void flush()

Specified by:

flush in class Handler

close

public void close()
           throws SecurityException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in class Handler

Throws:

SecurityException

isLoggable

public boolean isLoggable(LogRecord record)

Overrides:

isLoggable in class Handler

setLevel

public void setLevel(Level level)

Overrides:

setLevel in class Handler