org.lsst.ccs.gconsole.plugins.tracer.filters

Class StandardMessageFilter

java.lang.Object

org.lsst.ccs.gconsole.plugins.tracer.filters.AbstractMessageFilter

org.lsst.ccs.gconsole.plugins.tracer.filters.StandardMessageFilter

All Implemented Interfaces:

MessageFilter, MessageFilterFactory

Direct Known Subclasses:

StandardMessageFilter.All, StandardMessageFilter.Default

@ConsoleLookup(name="Standard Configurable Filter",
               path="BuiltIn/Standard Configurable",
               description="Generic filter that can be configured to accept messages based on bus type, message type, log level, etc. The filter applies default formatting.<p>In order to be accepted, a message should satisfy all criteria described below.<p><b>Optional parameters:</b><dl><dt>name</dt><dd>Filter name.</dd><dt>subsystems</dt><dd>Comma-separated list of subsystems accepted by this filter.</dd><dt>properties</dt><dd>Comma-separated list of properties the subsystem must have to be accepted.</dd><dt>commandMessages</dt><dd>If true, messages received on the command bus are accepted.</dd><dt>statusMessages</dt><dd>If true, messages received on the status bus are accepted.</dd><dt>logMessages</dt><dd>If true, messages received on the log bus are accepted.</dd><dt>heartBeat</dt><dd>If true, heartbeat status messages are accepted.</dd><dt>jvmInfo</dt><dd>If true, JVM information status messages are accepted.</dd><dt>stateChange</dt><dd>If true, subsystem state change status messages are accepted.</dd><dt>alert</dt><dd>If true, alert status messages are accepted.</dd><dt>data</dt><dd>If true, status messages with trending data are accepted.</dd><dt>service</dt><dd>If true, service status messages are accepted.</dd><dt>others</dt><dd>If true, all other status messages are accepted.</dd><dt>logLevel</dt><dd>Log messages below the specified level are rejected.</dd></dl>")
public class StandardMessageFilter
extends AbstractMessageFilter

Standard configurable filter.

Author:

onoprien

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StandardMessageFilter.All
static class	StandardMessageFilter.Default

Field Summary

Fields

Modifier and Type	Field and Description
static Color	COLOR_ERROR
static Color	COLOR_FINE
static Color	COLOR_GOOD
static Color	COLOR_WARNING

Constructor Summary

Constructors

Constructor and Description
StandardMessageFilter(String name, String subsystems, String subsystemProperties, boolean commandMessages, boolean statusMessages, boolean logMessages, boolean heartBeat, boolean jvmInfo, boolean stateChange, boolean alert, boolean trending, boolean service, boolean others, String logLevel)

Method Summary

Modifier and Type	Method and Description
String	getDescription() Returns the description of the filters created by this factory.
String	getPath() Returns the path of the filters created by this factory.
static int	logLevelIntValue(String level)
FilteredMessage	test(FilteredMessage filteredMessage) Applies this filter to the given message.

Methods inherited from class org.lsst.ccs.gconsole.plugins.tracer.filters.AbstractMessageFilter

getParameters, setParameters

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.lsst.ccs.gconsole.plugins.tracer.MessageFilter

get

Methods inherited from interface org.lsst.ccs.gconsole.plugins.tracer.MessageFilterFactory

getName

Field Detail

COLOR_ERROR

public static final Color COLOR_ERROR

COLOR_WARNING

public static final Color COLOR_WARNING

COLOR_GOOD

public static final Color COLOR_GOOD

COLOR_FINE

public static final Color COLOR_FINE

Constructor Detail

StandardMessageFilter

public StandardMessageFilter(String name,
                             String subsystems,
                             String subsystemProperties,
                             boolean commandMessages,
                             boolean statusMessages,
                             boolean logMessages,
                             boolean heartBeat,
                             boolean jvmInfo,
                             boolean stateChange,
                             boolean alert,
                             boolean trending,
                             boolean service,
                             boolean others,
                             String logLevel)

Method Detail

getPath

public String getPath()

Description copied from interface: MessageFilterFactory

Returns the path of the filters created by this factory.

Returns:

Path.

getDescription

public String getDescription()

Description copied from interface: MessageFilterFactory

Returns the description of the filters created by this factory.

Returns:

Filter description.

test

public FilteredMessage test(FilteredMessage filteredMessage)

Description copied from interface: MessageFilter

Applies this filter to the given message.

Parameters:

filteredMessage - The message to be filtered.

Returns:

The (possibly modified) message if it passes the filter; null otherwise.

logLevelIntValue

public static int logLevelIntValue(String level)