com.bmc.arsys.pluginsvr.plugins
Interface ARPluggable

All Known Subinterfaces:

ARDBCPluggable, AREAPluggable, ARFilterAPIPluggable

All Known Implementing Classes:

ARDBCPlugin, AREAPlugin, ARFilterAPIPlugin, ARPlugin

public interface ARPluggable

Parent interface for all types of AR plugins. Methods that need to be implemented include general purpose methods like handling events from server (or even plugin server in the future), initialization and termination. All plugins can implement a public void static init(ARPluginContext context) method to do all intialization for this class. This will be invoked once for each class that implements one of the ARPluggable interfaces on plugin server startup. This same thing can be accomplished using a static block of code in the class. The only advantage in implementing this method is that it gets access to the ARPluginContext object that can be used for the following purposes. 1. Logging any initialization messages 2. Fetching configuration file entries for this plugin from pluginsvr_config.xml file. 3. Get AR System configuration entries from the ar.cfg file. For all instance initialization, the public initialize(ARPluginContext context) should be used. The initialize method is invoked once for each thread instance in plugin server.

Method Summary

void	initialize(ARPluginContext context) An initialization routine called once at startup load time for each plugin that is loaded.
void	onEvent(ARPluginContext context, int pEventID) Methods to handle events from the AR Server.
void	terminate(ARPluginContext context) A clean up method called on a plugin unload or plugin server termination for the plugin to cleanup after itself.

Method Detail

onEvent

void onEvent(ARPluginContext context,
             int pEventID)
             throws com.bmc.arsys.api.ARException

Methods to handle events from the AR Server. Events could include change in configuration file etc. Called every time any such event occurs.

Parameters:

context - Current context for this plugin call, like username etc.

pEventID - the ID for the event that occured

Throws:

com.bmc.arsys.api.ARException

initialize

void initialize(ARPluginContext context)
                throws com.bmc.arsys.api.ARException

An initialization routine called once at startup load time for each plugin that is loaded. The plugin can do all its initialization and setup in this method.

Parameters:

context - Current context for this plugin call, like username etc.

Throws:

com.bmc.arsys.api.ARException

terminate

void terminate(ARPluginContext context)
               throws com.bmc.arsys.api.ARException

A clean up method called on a plugin unload or plugin server termination for the plugin to cleanup after itself.

Parameters:

context - Current context for this plugin call, like username etc.

Throws:

com.bmc.arsys.api.ARException