Public Member Functions | Static Protected Member Functions

alma.acs.logging.AcsLoggingHandler Class Reference

Inheritance diagram for alma.acs.logging.AcsLoggingHandler:
alma.acs.logging.config.LogConfigSubscriber

List of all members.

Public Member Functions

 AcsLoggingHandler (DispatchingLogQueue logQueue, LogConfig logConfig, String loggerName, LogThrottle logThrottle)
void configureLogging (LogConfig logConfig)
void publish (LogRecord logRecord)
void flush ()
void close ()

Static Protected Member Functions

static void debug ()

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,
LogThrottle  logThrottle 
)
Parameters:
logQueue 
logConfig 
loggerName 
logThrottle may be null (then no throttling will happen)

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


Member Function Documentation

void alma.acs.logging.AcsLoggingHandler.close (  ) 

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

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

References alma.acs.logging.config.LogConfig.removeSubscriber().

static void alma.acs.logging.AcsLoggingHandler.debug (  )  [static, protected]

Used in the test. Sets debug to true.

void alma.acs.logging.AcsLoggingHandler.flush (  ) 

Forwards the flush request to the underlying queue.

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

References alma.acs.logging.DispatchingLogQueue.flush().

void alma.acs.logging.AcsLoggingHandler.publish ( LogRecord  logRecord  ) 
See also:
java.util.logging.Handler.publish(java.util.logging.LogRecord) Writes a single log into an array of strings.
Parameters:
logRecord 

References alma.acs.logging.LogThrottle.checkPublishLogRecordRemote(), alma.acs.logging.DispatchingLogQueue.flush(), and alma.acs.logging.DispatchingLogQueue.log().

Referenced by alma.acs.logging.AcsLoggingHandler.configureLogging().


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Enumerations Properties