com::cosylab::logging::engine::LogMatcher Class Reference

Inheritance diagram for com::cosylab::logging::engine::LogMatcher:

[legend]

Collaboration diagram for com::cosylab::logging::engine::LogMatcher:

[legend]

List of all members.

Public Member Functions
void	setFilters (FiltersVector filters)
void	setAudience (Audience newAudience)
Audience	getAudience ()
void	setDiscardLevel (LogTypeHelper discardLevel)
FiltersVector	getFilters ()
final boolean	match (ILogEntry log)
LogTypeHelper	getActualDiscardLevel ()
Protected Attributes
volatile LogTypeHelper	actualDiscardLevel = null
Private Attributes
Audience	audience = Audience.AudienceInfo.ENGINEER.getAudience()
FiltersVector	filters = null

---

Detailed Description

Objects from this class checks if a log matches with the constraints.

The purpose of this object is to have a centralized way to check each log against the given set of constraints before deciding it can be injected in the system.

In particular it checks a log against the followings:

• Log (discard) level
• filters
• Audience

Author:

acaproni

---

Member Function Documentation

LogTypeHelper com::cosylab::logging::engine::LogMatcher::getActualDiscardLevel

(

)

[inline]

Return the discard level used to filter out logs.

Returns:

The discard level in use

References actualDiscardLevel.

Referenced by com::cosylab::logging::engine::ACS::LCEngine::getActualDiscardLevel(), and alma::acs::jlog::test::LogDispatcherTest::testDynamicDiscardLevel().

Audience com::cosylab::logging::engine::LogMatcher::getAudience

(

)

[inline]

Returns:

the audience

References audience.

Referenced by com::cosylab::logging::engine::ACS::LCEngine::getAudience(), and alma::acs::jlog::test::EngineAudienceTest::testSetMode().

FiltersVector com::cosylab::logging::engine::LogMatcher::getFilters

(

)

[inline]

Returns:

the filters

References filters.

final boolean com::cosylab::logging::engine::LogMatcher::match

(

ILogEntry

log

)

[inline]

Check if the passed log matches with the constraints.

The log is checked in the following order:

1. the discard level
2. the audience
3. the filters

Parameters:

log

The not null log to check

Returns:

true if the log matches the criteria

References actualDiscardLevel, com::cosylab::logging::engine::FiltersVector::applyFilters(), audience, filters, com::cosylab::logging::engine::log::ILogEntry::getType(), and com::cosylab::logging::engine::audience::Audience::matches().

Referenced by alma::acs::logging::engine::io::IOHelper::injectLog(), and com::cosylab::logging::engine::ACS::ACSLogRetrieval::publishLog().

void com::cosylab::logging::engine::LogMatcher::setAudience

(

Audience

newAudience

)

[inline]

Set the audience

Parameters:

newAudience

The new audience as defined in log_audience IDL module

See also:

LCEngine.setFilters()

References audience.

Referenced by alma::acs::logging::io::IOLogsHelper::LoadLogs::run(), com::cosylab::logging::engine::ACS::LCEngine::setAudience(), alma::acs::jlog::test::EngineAudienceTest::testNoAudienceModeFiltering(), alma::acs::jlog::test::EngineAudienceTest::testOperatorModeFiltering(), and alma::acs::jlog::test::EngineAudienceTest::testSetMode().

void com::cosylab::logging::engine::LogMatcher::setDiscardLevel

(

LogTypeHelper

discardLevel

)

[inline]

Parameters:

discardLevel

the discardLevel to set

Reimplemented in com::cosylab::logging::engine::ACS::ACSLogRetrieval.

References actualDiscardLevel.

Referenced by alma::acs::logging::io::IOLogsHelper::LoadLogs::run().

void com::cosylab::logging::engine::LogMatcher::setFilters

(

FiltersVector

filters

)

[inline]

Set the filters to apply to incoming logs before sending to the listeners

Parameters:

filters

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

Referenced by com::cosylab::logging::engine::ACS::ACSLogRetrieval::ACSLogRetrieval(), com::cosylab::logging::engine::ACS::LCEngine::addFilter(), com::cosylab::logging::engine::ACS::LCEngine::clearFilters(), alma::acs::logging::archive::zoom::FileHelper::loadLogs(), alma::acs::logging::io::IOLogsHelper::LoadLogs::run(), com::cosylab::logging::engine::ACS::LCEngine::setFilters(), and alma::acs::jlog::test::EngineAudienceTest::setUp().

---

Member Data Documentation

volatile LogTypeHelper com::cosylab::logging::engine::LogMatcher::actualDiscardLevel = null [protected]

The discard level

Referenced by com::cosylab::logging::engine::ACS::ACSLogRetrieval::checkMemory(), getActualDiscardLevel(), match(), setDiscardLevel(), and com::cosylab::logging::engine::ACS::ACSLogRetrieval::setDiscardLevel().

Audience com::cosylab::logging::engine::LogMatcher::audience = Audience.AudienceInfo.ENGINEER.getAudience() [private]

The audience.

Only the logs for the defined audience will be forwarded to the listeners.

See also:

LCEngine.setFilters()

Referenced by getAudience(), match(), and setAudience().

FiltersVector com::cosylab::logging::engine::LogMatcher::filters = null [private]

The filters to apply before publishing logs to the listeners. The filters are not applied to XML listeners. These filters are applied after the audience.

Referenced by getFilters(), and match().

---

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

• LogMatcher.java