alma.acs.logtools.monitor

Class LogDetailsDispatcher

java.lang.Object

alma.acs.logtools.monitor.LogDetailsDispatcher

All Implemented Interfaces:

ACSLogConnectionListener, ACSRemoteErrorListener, ACSRemoteLogListener, ACSRemoteRawLogListener, java.lang.Runnable

public class LogDetailsDispatcher
extends java.lang.Object
implements ACSRemoteErrorListener, ACSRemoteLogListener, ACSRemoteRawLogListener, ACSLogConnectionListener, java.lang.Runnable

LogDetailsDispatcher reads logs from the logging NC and dispatch them to the registered listeners.

There are 2 types of listeners to perform different kind of statistics:

• number listeners: they are informed about the number of logs received for each log type in the NUMBER_LISTENERS_INTERVAL time interval
• log listeners: they are informed for the type each received log // TODO

Since:

ACS 8.1.0

Author:

acaproni

Field Summary

Fields

Modifier and Type	Field and Description
static int	NUMBER_LISTENERS_INTERVAL The interval of time (seconds) to notify listener of numbers

Constructor Summary

Constructors

Constructor and Description
LogDetailsDispatcher() Constructor

Method Summary

Modifier and Type	Method and Description
void	acsLogConnConnecting() Notify that an attempt to connect to ACS NC is in progress
void	acsLogConnDisconnected() Notify that the connection with ACS NC has been disconnected It can happen as a consequence of an error as well as as consequence of a request
void	acsLogConnEstablished() Notify that the connection with ACS NC has been established
void	acsLogConnLost() Notify that the connection with ACS NC has been lost (it means an error or something abnormal).
void	acsLogConnSuspended() Notify that the service is supended (i.e.
void	acsLogsDelay() Notify that for some internal reason the service is not able to follow the flow of the incoming logs and is queueing the messages to be inserted later, when flow will decrease and enough CPU time is availbale This method is not executed each time a log is queued but once when the situation begins.
void	addNumsListener(LogNumbersListener listener) Add a LogNumbersListener listener to be notified about incoming logs statistics
void	close() Close the engine and free the resources
void	errorReceived(java.lang.String xml) The method is executed when an error happened building a log from a string.
void	logEntryReceived(ILogEntry logEntry) The method is executed when a new log arrives from the NC
void	removeNumsListener(LogNumbersListener listener) Remove a LogNumbersListener listener.
void	reportStatus(java.lang.String status) Send a report string with the current status of the connection
void	run() The thread notifying listeners about statistics
void	xmlEntryReceived(java.lang.String xmlLogString) The method is executed when a new XML string arrives from the NC

Methods inherited from class java.lang.Object

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

Field Detail

NUMBER_LISTENERS_INTERVAL

public static final int NUMBER_LISTENERS_INTERVAL

The interval of time (seconds) to notify listener of numbers

See Also:

LogNumbersListener, Constant Field Values

Constructor Detail

LogDetailsDispatcher

public LogDetailsDispatcher()
                     throws LogEngineException

Constructor

Throws:

LogEngineException - In case of error instantiating the engine

Method Detail

errorReceived

public void errorReceived(java.lang.String xml)

Description copied from interface: ACSRemoteErrorListener

The method is executed when an error happened building a log from a string. The parameter is the string that caused the error and it can be - the XML that was not possible to parse - a cache string if the binary format of logs is in use The cache string is a string used in the cache whose format might change with different implementation of of the cache.

Specified by:

errorReceived in interface ACSRemoteErrorListener

Parameters:

xml - That string that caused the error

xmlEntryReceived

public void xmlEntryReceived(java.lang.String xmlLogString)

Description copied from interface: ACSRemoteRawLogListener

The method is executed when a new XML string arrives from the NC

Specified by:

xmlEntryReceived in interface ACSRemoteRawLogListener

Parameters:

xmlLogString - The new XML string just read from the NC

acsLogConnConnecting

public void acsLogConnConnecting()

Description copied from interface: ACSLogConnectionListener

Notify that an attempt to connect to ACS NC is in progress

Specified by:

acsLogConnConnecting in interface ACSLogConnectionListener

acsLogConnDisconnected

public void acsLogConnDisconnected()

Description copied from interface: ACSLogConnectionListener

Notify that the connection with ACS NC has been disconnected It can happen as a consequence of an error as well as as consequence of a request

Specified by:

acsLogConnDisconnected in interface ACSLogConnectionListener

acsLogConnEstablished

public void acsLogConnEstablished()

Description copied from interface: ACSLogConnectionListener

Notify that the connection with ACS NC has been established

Specified by:

acsLogConnEstablished in interface ACSLogConnectionListener

acsLogConnLost

public void acsLogConnLost()

Description copied from interface: ACSLogConnectionListener

Notify that the connection with ACS NC has been lost (it means an error or something abnormal).

Specified by:

acsLogConnLost in interface ACSLogConnectionListener

acsLogConnSuspended

public void acsLogConnSuspended()

Description copied from interface: ACSLogConnectionListener

Notify that the service is supended (i.e. it is connected to the NC and receiving logs but the logs are discarded instead of being sent to the listeners) Note: the suspension of the service is not a malfunctioning but a status requested by the user

Specified by:

acsLogConnSuspended in interface ACSLogConnectionListener

acsLogsDelay

public void acsLogsDelay()

Description copied from interface: ACSLogConnectionListener

Notify that for some internal reason the service is not able to follow the flow of the incoming logs and is queueing the messages to be inserted later, when flow will decrease and enough CPU time is availbale This method is not executed each time a log is queued but once when the situation begins. When the temporary problem has been fixed, the status will revert to connected

Specified by:

acsLogsDelay in interface ACSLogConnectionListener

reportStatus

public void reportStatus(java.lang.String status)

Description copied from interface: ACSLogConnectionListener

Send a report string with the current status of the connection

Specified by:

reportStatus in interface ACSLogConnectionListener

Parameters:

status - The status string

logEntryReceived

public void logEntryReceived(ILogEntry logEntry)

Description copied from interface: ACSRemoteLogListener

The method is executed when a new log arrives from the NC

Specified by:

logEntryReceived in interface ACSRemoteLogListener

Parameters:

logEntry - The new log just read from the NC

addNumsListener

public void addNumsListener(LogNumbersListener listener)

Add a LogNumbersListener listener to be notified about incoming logs statistics

Parameters:

listener - The listener to add

removeNumsListener

public void removeNumsListener(LogNumbersListener listener)

Remove a LogNumbersListener listener.

Parameters:

listener - The listener to remove

run

public void run()

The thread notifying listeners about statistics

Specified by:

run in interface java.lang.Runnable

close

public void close()

Close the engine and free the resources