com.bmc.arsys.plugin.sample

Class FilterAPISample

java.lang.Object

com.bmc.arsys.pluginsvr.plugins.ARPlugin

com.bmc.arsys.pluginsvr.plugins.ARFilterAPIPlugin

com.bmc.arsys.plugin.sample.FilterAPISample

All Implemented Interfaces:

com.bmc.arsys.pluginsvr.plugins.ARFilterAPIPluggable, com.bmc.arsys.pluginsvr.plugins.ARPluggable

public class FilterAPISample
extends com.bmc.arsys.pluginsvr.plugins.ARFilterAPIPlugin

A sample implementation of a filterapi plugin. In this case, this implementation extends ARFilterAPIPlugin. Alternatively, one could just implement the interface ARFilterAPIPluggable. This sample has a dependency on a class FooBar, which is a part of another jar file it depends on. It also illustrates the use of the ARPluginContext to fetch username, or config items for itself.

Constructor Summary

Constructors

Constructor and Description
FilterAPISample()

Method Summary

Methods

Modifier and Type	Method and Description
List<com.bmc.arsys.api.Value>	filterAPICall(com.bmc.arsys.pluginsvr.plugins.ARPluginContext context, List<com.bmc.arsys.api.Value> pInValues)
void	initialize(com.bmc.arsys.pluginsvr.plugins.ARPluginContext context) Implementation of the static init method, to do any static initialization for this class.

Methods inherited from class com.bmc.arsys.pluginsvr.plugins.ARPlugin

onEvent, terminate

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.bmc.arsys.pluginsvr.plugins.ARPluggable

onEvent, terminate

Constructor Detail

FilterAPISample

public FilterAPISample()

Method Detail

initialize

public void initialize(com.bmc.arsys.pluginsvr.plugins.ARPluginContext context)

Implementation of the static init method, to do any static initialization for this class. This method is called once for each class that implements one of the ARPluggable interface on plugin server startup

Specified by:

initialize in interface com.bmc.arsys.pluginsvr.plugins.ARPluggable

Overrides:

initialize in class com.bmc.arsys.pluginsvr.plugins.ARPlugin

Parameters:

context -

filterAPICall

public List<com.bmc.arsys.api.Value> filterAPICall(com.bmc.arsys.pluginsvr.plugins.ARPluginContext context,
                                          List<com.bmc.arsys.api.Value> pInValues)
                                            throws com.bmc.arsys.api.ARException

Specified by:

filterAPICall in interface com.bmc.arsys.pluginsvr.plugins.ARFilterAPIPluggable

Specified by:

filterAPICall in class com.bmc.arsys.pluginsvr.plugins.ARFilterAPIPlugin

Throws:

com.bmc.arsys.api.ARException