org.lsst.ccs.gconsole.plugins.demo.monitor

Class FilterMonitored

java.lang.Object

org.lsst.ccs.gconsole.base.filter.AbstractChannelsFilter

org.lsst.ccs.gconsole.plugins.demo.monitor.FilterMonitored

All Implemented Interfaces:

AgentChannelsFilter, PersistableAgentChannelsFilter, Persistable, Savable

public class FilterMonitored
extends AbstractChannelsFilter

Demo filter that displays all monitoring channels from all subsystems, using subsystem name as a page name. Monitoring channels are defined as such in the groovy description.

Author:

onoprien

Nested Class Summary

Nested classes/interfaces inherited from interface org.lsst.ccs.gconsole.services.persist.Persistable

Persistable.Descriptor

Field Summary

Fields inherited from class org.lsst.ccs.gconsole.base.filter.AbstractChannelsFilter

ALL, CREATOR_PATH_UNFILTERED, descriptor

Fields inherited from interface org.lsst.ccs.gconsole.base.filter.AgentChannelsFilter

CATEGORY

Constructor Summary

Constructors

Constructor and Description
FilterMonitored()

Method Summary

Modifier and Type	Method and Description
List<String>	getDisplayPaths(String originPath) Returns a list of display channels for the specified original path.
List<String>	getOriginChannels() Returns a list of original channel selectors that might be accepted by this filter.
String	getOriginPath(String displayPath) Returns the original path corresponding to the specified display channel.

Methods inherited from class org.lsst.ccs.gconsole.base.filter.AbstractChannelsFilter

getDescriptor, getUnfiltered

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.base.filter.PersistableAgentChannelsFilter

getName

Methods inherited from interface org.lsst.ccs.gconsole.base.filter.AgentChannelsFilter

getAgents, getDisplayChannels, getDisplayPath, getDisplayPath, getDisplayPath, getDisplayPaths, getFields, getGroups, getOriginPaths, isSelector, matchTemplate

Methods inherited from interface org.lsst.ccs.gconsole.services.persist.Persistable

edit, getCategory, getPath, restore, restore, save

Constructor Detail

FilterMonitored

public FilterMonitored()

Method Detail

getDisplayPaths

public List<String> getDisplayPaths(String originPath)

Description copied from interface: AgentChannelsFilter

Returns a list of display channels for the specified original path. This method is called by clients that do not have access to original AgentChannel instances (like the trending tool).

If the specified original channel is not accepted by this filter, this method should return an empty list. null should never be returned.

The default implementation returns a singleton list that contains a string returned by AgentChannelsFilter.getDisplayPath(String) method.

Parameters:

originPath - Original path.

Returns:

List of display channels.

getOriginPath

public String getOriginPath(String displayPath)

Description copied from interface: AgentChannelsFilter

Returns the original path corresponding to the specified display channel. If multiple original paths are mapped to the specified display path, this method may return one of them, or null.

The default implementation returns the display path provided as an argument.

Parameters:

displayPath - Display channel path.

Returns:

Original path, or null if the specified path does not correspond to any original channel.

getOriginChannels

public List<String> getOriginChannels()

Description copied from interface: AgentChannelsFilter

Returns a list of original channel selectors that might be accepted by this filter.

The list returned by this method may contain channel selectors of several types (note that interpretation of some selectors depends on the list returned by getAgents() method):

• Complete path.
• Path template in the "[agent]/[partial path][/]" format. Templates that omit the agent name are expanded against all agents whose names are in the getAgents() list (or all agents present on the buses if that list is null). Templates that end with "/" match all channels that start with "agent/partial path/".
• Arbitrary regular expression (to be matched against the entire original path).
• Attribute selector strings in the "[agent.name=value&][agent.type=value&][agent.key[=value]&…&agent.key[=value]&][key[=value]&…&key[=value]]" format, where key and value are names and values of agent properties or static channel attributes. If value is omitted, the existence of the attribute is checked.

The default implementation returns null.

Returns:

Original channel paths accepted by this filter, or null if any original path for which AgentChannelsFilter.getDisplayPaths(org.lsst.ccs.gconsole.services.aggregator.AgentChannel) returns a non-empty list is accepted.