com.cosylab.logging.engine.ACS

Class LCEngine

java.lang.Object

com.cosylab.logging.engine.ACS.LCEngine

All Implemented Interfaces:

Filterable

public class LCEngine
extends java.lang.Object
implements Filterable

LCEngine connects to the logging NC and sends messages to the listeners. A LCEngine object can have an audience (as defined in the log_audience IDL module). If an audience is in use, a special set of filters will be applied. It is possible to define custom filters to apply to the incoming logs. In this case, only the logs that pass all the filters are sent to the listeners. The filters do not apply to RAW (i.e. XML) log listeners. The custom filters are applied after the audience filtering. There are three type of listeners supported: - ACSLogConnectionListener: listens events related to the connection with the logging NC and reportMessages - ACSRemoteLogListener: listens for LogEntries - ACSRemoteRawLogListener: listens for XML strings representing logs It there are no ACSRemoteLogLiestenersRegistered then the string received from the NC is not parsed The logs read from the NC are sent to the logRetrieval that, in turn, send them to the registered listeners. Audience and filtering are implemented by ACSLogRetrieval.

See Also:

ACSRemoteLogListener, ACSRemoteRawLogListener, ACSLogConnectionListener

Constructor Summary

Constructors

Constructor and Description
LCEngine() LCEngine constructor
LCEngine(boolean autoReconn) LCEngine constructor.
LCEngine(boolean autoReconn, FiltersVector filters) LCEngine constructor.
LCEngine(boolean autoReconn, FiltersVector filters, TimestampedStringQueueFileHandler cacheFileHandler) LCEngine constructor.
LCEngine(boolean autoReconn, TimestampedStringQueueFileHandler cacheFileHandler) LCEngine constructor.
LCEngine(TimestampedStringQueueFileHandler cacheFileHandler) Build the LCEngine by setting an handler for the files of the cache.

Method Summary

Modifier and Type	Method and Description
void	addFilter(Filter filter) Add a new filters to the vector of filters to apply to the incoming logs before sending to the listeners.
void	addLogConnectionListener(ACSLogConnectionListener listener) Add a connection listener
void	addLogErrorListener(ACSRemoteErrorListener listener) Add an error listener
void	addLogListener(ACSRemoteLogListener listener) Add a log listener
void	addRawLogListener(ACSRemoteRawLogListener listener) Add a RAW log listener
void	clearFilters() Remove all the filters.
void	close(boolean sync) Close the engine and free the resources.
void	connect() LCEngine starts an attempt to connect to the remote system.
void	connect(org.omg.CORBA.ORB theORB, Manager mgr) LCEngine starts an attempt to connect to the remote system.
void	connect(java.lang.String newAccessType) LCEngine starts an attempt to connect to the remote system.
void	disconnect() Disconnect the engine
void	disconnect(boolean sync) LCEngine starts an attempt to disconnect to the remote system.
void	enableAutoReconnection(boolean autoRec) Enable/disable the auto reconnection
void	enableDynamicDiscarding(int threshold, int damping, int interval) Enable or disable the dynamic change of the discard level depending on the amount of available memory.
java.lang.String	getAccessType() Insert the method's description here.
LogTypeHelper	getActualDiscardLevel() Return the discard level in use by the engine.
int	getActualInputRate()
int	getActualOutputRate()
Audience	getAudience()
LogTypeHelper	getDiscardLevel() Return the discard level set by the user.
FiltersVector	getFilters() Return the filters to filter the incoming logs before sending to the listeners
java.lang.String	getFiltersString()
int	getMaxInputRate()
int	getMaxOutputRate()
boolean	isConnected()
boolean	isFiltered() Return true if the engine is applying filters.
void	setAccessType(java.lang.String newAccessType) Insert the method's description here.
void	setAudience(Audience newAudience) Set the audience for the engine.
void	setConnectionParams(org.omg.CORBA.ORB theORB, Manager mgr) Set the connection params fro this
void	setDiscardLevel(LogTypeHelper newDiscardLevel) Set the discard level for filtering.
void	setFilters(FiltersVector newFilters, boolean append) Set the filters to apply before sending the log entries to the listener.
void	setMaxInputRate(int rate) Set the max number of logs per second to accept from the RemoteAccess, typically the logging NC.
void	setMaxOutputRate(int rate) Set the max number of logs to publish to listeners.
void	setPaused(boolean pause) Pause/unpause the publishing of logs to the listener The difference between pause and suspended is that when the engine is suspended all the received logs are discarded.
void	setSupended(boolean suspended) Suspend resume the notification of logs NOTE: When suspended the log discarded are lost forever
int	waitingLogsNumber() Return the number of logs waiting in the cache i.e.

Methods inherited from class java.lang.Object

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

Constructor Detail

LCEngine

public LCEngine()
         throws LogEngineException

LCEngine constructor

Throws:

LogEngineException

See Also:

#LCEngine(boolean, FiltersVector, ILogQueueFileHandler)

LCEngine

public LCEngine(boolean autoReconn)
         throws LogEngineException

LCEngine constructor.

Parameters:

autoReconn - If true the engine automatically reconnects

Throws:

LogEngineException

See Also:

#LCEngine(boolean, FiltersVector, ILogQueueFileHandler)

LCEngine

public LCEngine(boolean autoReconn,
                FiltersVector filters)
         throws LogEngineException

LCEngine constructor.

This constructor allows to define a set of filters to apply to incoming logs: only the logs passing the filters are sent to the listeners.

Parameters:

autoReconn - If true the engine automatically reconnects

filters - The filters to apply to the incoming logs. filters can be null or empty.

Throws:

LogEngineException

See Also:

#LCEngine(boolean, FiltersVector, ILogQueueFileHandler)

LCEngine

public LCEngine(TimestampedStringQueueFileHandler cacheFileHandler)
         throws LogEngineException

Build the LCEngine by setting an handler for the files of the cache.

Parameters:

cacheFileHandler - The handler of the files of the cache

Throws:

LogEngineException

See Also:

ILogQueueFileHandler, #LCEngine(boolean, FiltersVector, ILogQueueFileHandler)

LCEngine

public LCEngine(boolean autoReconn,
                TimestampedStringQueueFileHandler cacheFileHandler)
         throws LogEngineException

LCEngine constructor.

Parameters:

autoReconn - If true the engine automatically reconnects

cacheFileHandler - The handler of the files of the cache

Throws:

LogEngineException

See Also:

ILogQueueFileHandler, #LCEngine(boolean, FiltersVector, ILogQueueFileHandler)

LCEngine

public LCEngine(boolean autoReconn,
                FiltersVector filters,
                TimestampedStringQueueFileHandler cacheFileHandler)
         throws LogEngineException

LCEngine constructor.

This constructor allows to define a set of filters to apply to incoming logs: only the logs passing the filters are sent to the listeners.

Parameters:

autoReconn - If true the engine automatically reconnects

filters - The filters to apply to the incoming logs. filters can also be either null or empty.

cacheFileHandler - The handler of the files of the cache or null if do not want to register for notification

Throws:

LogEngineException

See Also:

ILogQueueFileHandler

Method Detail

connect

public void connect()

LCEngine starts an attempt to connect to the remote system. Connection is handled in a separate Thread

See Also:

LCEngine.AccessSetter

connect

public void connect(java.lang.String newAccessType)

LCEngine starts an attempt to connect to the remote system. Connection is handled in a separate Thread

Parameters:

accessTyp - The access type

See Also:

LCEngine.AccessSetter

connect

public void connect(org.omg.CORBA.ORB theORB,
                    Manager mgr)

LCEngine starts an attempt to connect to the remote system. Connection is handled in a separate Thread

Parameters:

theORB - The ORB (can be null)

mgr - The reference to the manager (can be null)

See Also:

LCEngine.AccessSetter

close

public void close(boolean sync)

Close the engine and free the resources.

Parameters:

sync - If true the closing is made in a synchronized way.

disconnect

public void disconnect()

Disconnect the engine

disconnect

public void disconnect(boolean sync)

LCEngine starts an attempt to disconnect to the remote system.

Parameters:

sync - If true the closing is made in a synchronized way.

See Also:

LCEngine.AccessSetter

getAccessType

public java.lang.String getAccessType()

Insert the method's description here. Creation date: (2/18/2002 9:58:30 AM)

Returns:

java.lang.String

setAccessType

public void setAccessType(java.lang.String newAccessType)

Insert the method's description here. Creation date: (2/18/2002 9:58:30 AM)

Parameters:

newAccessType - java.lang.String

setConnectionParams

public void setConnectionParams(org.omg.CORBA.ORB theORB,
                                Manager mgr)

Set the connection params fro this

Parameters:

theORB - The ORB. It can't be null if the manager is not null

mgr - The reference to the Manager

isConnected

public boolean isConnected()

Returns:

ture if the engine is connected to the notification channel

setSupended

public void setSupended(boolean suspended)

Suspend resume the notification of logs NOTE: When suspended the log discarded are lost forever

Parameters:

suspended - If true suspend the notification of the logs

enableAutoReconnection

public void enableAutoReconnection(boolean autoRec)

Enable/disable the auto reconnection

Parameters:

autoRec - If true the engine tries to reconnect automatically

setPaused

public void setPaused(boolean pause)

Pause/unpause the publishing of logs to the listener The difference between pause and suspended is that when the engine is suspended all the received logs are discarded. When it is paused, the received logs are cached and published when the engine will be unpaused.

Parameters:

pause -

addLogListener

public void addLogListener(ACSRemoteLogListener listener)

Add a log listener

Parameters:

listener - The listener to add

See Also:

ACSRemoteLogListener

addRawLogListener

public void addRawLogListener(ACSRemoteRawLogListener listener)

Add a RAW log listener

Parameters:

listener - The listener to add

See Also:

ACSRemoteRawLogListener

addLogErrorListener

public void addLogErrorListener(ACSRemoteErrorListener listener)

Add an error listener

Parameters:

listener - The error listener to add

See Also:

ACSRemoteErrorListener

addLogConnectionListener

public void addLogConnectionListener(ACSLogConnectionListener listener)

Add a connection listener

Parameters:

listener - The listener to add

See Also:

ACSLogConnectionListener

setFilters

public void setFilters(FiltersVector newFilters,
                       boolean append)

Set the filters to apply before sending the log entries to the listener. By setting a null or empty filters disable the filtering.

Specified by:

setFilters in interface Filterable

Parameters:

newFilters - The new filters to apply If null or empty the filtering is disabled

append - If true the new filters are added to the existing filters (if any).

setDiscardLevel

public void setDiscardLevel(LogTypeHelper newDiscardLevel)

Set the discard level for filtering.

Note: if the dynamic change of the discard level depending on the memory usage has been activated, then the discard level effectively used by the engine might be greater then newDiscardlevel.

Parameters:

newDiscardlevel - The discard level Not applied if null.

See Also:

ACSLogRetrieval}

setAudience

public void setAudience(Audience newAudience)

Set the audience for the engine. If an audience is defined, a special set of filters is applied.

Parameters:

newAudience - The not nullaudience

addFilter

public void addFilter(Filter filter)

Add a new filters to the vector of filters to apply to the incoming logs before sending to the listeners.

The filter is applied as active.

Parameters:

filter - The not null filter to add

clearFilters

public void clearFilters()

Remove all the filters. After calling this method, all the received logs are forwarded to the listeners.

getFilters

public FiltersVector getFilters()

Return the filters to filter the incoming logs before sending to the listeners

Specified by:

getFilters in interface Filterable

Returns:

The filters (can be null)

getActualDiscardLevel

public LogTypeHelper getActualDiscardLevel()

Return the discard level in use by the engine.

Note: the actual discard level may or may not be the same discard level set by the user. They differ if the user enabled the dynamic change of the discard level depending on the available memory .

Returns:

The actual discard level (can be null)

See Also:

ACSLogRetrieval.getDiscardlevel()}, {@link LogMatcher.getActualDiscardLevel()}, getDiscardLevel()

getDiscardLevel

public LogTypeHelper getDiscardLevel()

Return the discard level set by the user.

Note: the discard level in use can be different if the dynamic change of the discard level depending on the available memory in the engine has been activated.

Returns:

The discard level (can be null)

See Also:

ACSLogRetrieval.getDiscardlevel()}, {@link LogMatcher.getActualDiscardLevel()}, getActualDiscardLevel()

getAudience

public Audience getAudience()

Returns:

The discard level (can be null)

isFiltered

public boolean isFiltered()

Return true if the engine is applying filters. If a filter is in place but not enabled then it is ignored.

Returns:

true if there are filters active in the engine

See Also:

FiltersVector.hasActiveFilters()

getFiltersString

public java.lang.String getFiltersString()

Returns:

A description of the active filters

See Also:

FiltersVector.getFilterString()

setMaxInputRate

public void setMaxInputRate(int rate)

Set the max number of logs per second to accept from the RemoteAccess, typically the logging NC.

All the logs arriving after the max number has been reached will be discarded, regardless of their level.

See ACSLogRetrieval for further details.

Parameters:

rate - The max number of logs per second to accept

getMaxInputRate

public int getMaxInputRate()

Returns:

The actual max input rate See ACSLogRetrieval for further details.

getActualInputRate

public int getActualInputRate()

Returns:

The actual input rate See ACSLogRetrieval for further details.

setMaxOutputRate

public void setMaxOutputRate(int rate)

Set the max number of logs to publish to listeners.

When this number has been reached, no more logs are sent to the listeners.

See ACSLogRetrieval for further details.

Parameters:

rate - The max number of logs per second to accept

getMaxOutputRate

public int getMaxOutputRate()

Returns:

The actual max input rate See ACSLogRetrieval for further details.

getActualOutputRate

public int getActualOutputRate()

Returns:

The actual input rate See ACSLogRetrieval for further details.

waitingLogsNumber

public int waitingLogsNumber()

Return the number of logs waiting in the cache i.e. the logs received from the RemoteAcess and not yet sent to the listeners.

Returns:

the number of logs waiting in the cache

enableDynamicDiscarding

public void enableDynamicDiscarding(int threshold,
                                    int damping,
                                    int interval)

Enable or disable the dynamic change of the discard level depending on the amount of available memory.

Parameters:

threashold - The discard level is increased when the available memory for the application is less then the threshold (in bytes). Integer.MAX_VALUE disables this feature.

damping - The damping factor is used to avoid oscillations The discard level is decreased when the free memory is is greater then the threshold plus the dumping.

interval - The time (in seconds) between two adjustments of the dynamic discard level. interval defaults to 10.

See Also:

ACSLogRetrieval}