alma::acs::logging::AcsLoggingHandler Class Reference

Inheritance diagram for alma::acs::logging::AcsLoggingHandler:

[legend]

Collaboration diagram for alma::acs::logging::AcsLoggingHandler:

[legend]

List of all members.

Public Member Functions
	AcsLoggingHandler (DispatchingLogQueue logQueue, LogConfig logConfig, String loggerName)
void	configureLogging (LogConfig logConfig)
void	publish (LogRecord logRecord)
void	flush ()
void	close ()
Static Protected Member Functions
static void	debug ()
Private Attributes
DispatchingLogQueue	logQueue
LogConfig	logConfig
String	loggerName
AcsLogLevelDefinition	immediateDispatchLevel
boolean	isClosed
Static Private Attributes
static boolean	DEBUG = Boolean.getBoolean("alma.acs.logging.verbose")

---

Detailed Description

The logging handler used by ACS for remote logging. All log records are immediately fed to a alma.acs.logging.DispatchingLogQueue.

---

Constructor & Destructor Documentation

alma::acs::logging::AcsLoggingHandler::AcsLoggingHandler	(	DispatchingLogQueue	logQueue,
		LogConfig	logConfig,
		String	loggerName
	)			[inline]

References alma::acs::logging::config::LogConfig::addSubscriber(), and configureLogging().

---

Member Function Documentation

void alma::acs::logging::AcsLoggingHandler::close

(

)

[inline]

Required method. Not sure if it's useful for us.

See also:

java.util.logging.Handler::close() Cleans handler up before exiting.

References isClosed, logConfig, and alma::acs::logging::config::LogConfig::removeSubscriber().

Referenced by alma::acs::logging::ClientLogManager::disableRemoteLogging().

void alma::acs::logging::AcsLoggingHandler::configureLogging

(

LogConfig

logConfig

)

[inline]

Called whenever the logging configuration is updated, for example when the CDB is read.

See also:

alma.acs.logging.config.LogConfigSubscriber::configureLogging(alma.acs.logging.config.LogConfig)

Implements alma::acs::logging::config::LogConfigSubscriber.

References alma::acs::logging::config::LogConfig::getImmediateDispatchLevel(), alma::acs::logging::config::LogConfig::getNamedLoggerConfig(), immediateDispatchLevel, loggerName, and publish().

Referenced by AcsLoggingHandler().

static void alma::acs::logging::AcsLoggingHandler::debug

(

)

[inline, static, protected]

Used in the test. Sets debug to true.

References DEBUG.

void alma::acs::logging::AcsLoggingHandler::flush

(

)

[inline]

Forwards the flush request to the underlying queue.

See also:

java.util.logging.Handler::flush()

References alma::acs::logging::DispatchingLogQueue::flush(), and logQueue.

void alma::acs::logging::AcsLoggingHandler::publish

(

LogRecord

logRecord

)

[inline]

See also:

java.util.logging.Handler::publish(java.util.logging.LogRecord) Writes a single log into an array of strings.

Parameters:

logRecord

References DEBUG, alma::acs::logging::DispatchingLogQueue::flush(), immediateDispatchLevel, isClosed, alma::acs::logging::DispatchingLogQueue::log(), and logQueue.

Referenced by configureLogging(), and alma::acs::logging::AcsLoggingHandlerTest::testOffLevel().

---

Member Data Documentation

boolean alma::acs::logging::AcsLoggingHandler::DEBUG = Boolean.getBoolean("alma.acs.logging.verbose") [static, private]

Variable to enable messages. TODO: check if this flag should be integrated with LogConfig classes

Referenced by debug(), and publish().

AcsLogLevelDefinition alma::acs::logging::AcsLoggingHandler::immediateDispatchLevel [private]

Referenced by configureLogging(), and publish().

boolean alma::acs::logging::AcsLoggingHandler::isClosed [private]

Referenced by close(), and publish().

LogConfig alma::acs::logging::AcsLoggingHandler::logConfig [private]

Referenced by close().

String alma::acs::logging::AcsLoggingHandler::loggerName [private]

Referenced by configureLogging().

DispatchingLogQueue alma::acs::logging::AcsLoggingHandler::logQueue [private]

The queue that this handler puts all log records in.

Referenced by flush(), and publish().

---

The documentation for this class was generated from the following file:

• AcsLoggingHandler.java