com.ibm.rules.res.xu.plugin

Class Plugin

java.lang.Object

com.ibm.rules.res.xu.plugin.internal.PluginBase

com.ibm.rules.res.xu.plugin.Plugin

All Implemented Interfaces:

ilog.rules.res.xu.plugin.internal.IlrPlugin

Direct Known Subclasses:

AuthorizationPlugin, EventPlugin

public class Plugin
extends com.ibm.rules.res.xu.plugin.internal.PluginBase

Plugin is an implementation plug-in that you can extend to create custom plug-ins.

Since:

8.0.1

Constructor Summary

Constructors

Constructor and Description
Plugin()

Method Summary

Methods

Modifier and Type	Method and Description
IlrRulesetUsageInformationMonitor	getRulesetUsageInformationMonitor() Retrieves information on how the ruleset is used .
void	notifyRulesetArchiveChanged(IlrPath path) Notifies the XU resource adapter that a ruleset archive has changed.
void	release() Called by the XU when the plug-in is released and will not be used any more.
void	start(java.util.Map<java.lang.String,java.lang.String> props) Called when the plug-in is started by the XU.

Methods inherited from class com.ibm.rules.res.xu.plugin.internal.PluginBase

destroy, executeRuleset, executeRuleset, getInteractionExtension, getWorkManager, getXUConfig, getXUInfo, getXUInfo, isLoggable, log, setConnectionFactory, setLogHandler, setProperties, setResourceAdapter, setRulesetUsageInformationMonitor, setXUConfig, start, subscribe, unsubscribe

Methods inherited from class java.lang.Object

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

Constructor Detail

Plugin

public Plugin()

Method Detail

start

public void start(java.util.Map<java.lang.String,java.lang.String> props)
           throws PluginException

Called when the plug-in is started by the XU. You can set the properties of the plug-in directly in the plugins XU configuration property.

Overrides:

start in class com.ibm.rules.res.xu.plugin.internal.PluginBase

Throws:

PluginException

Parameters:

props - The properties associated with this plug-in

notifyRulesetArchiveChanged

public final void notifyRulesetArchiveChanged(IlrPath path)

Notifies the XU resource adapter that a ruleset archive has changed.

Overrides:

notifyRulesetArchiveChanged in class com.ibm.rules.res.xu.plugin.internal.PluginBase

Parameters:

path - The canonical path of the ruleset.

getRulesetUsageInformationMonitor

public final IlrRulesetUsageInformationMonitor getRulesetUsageInformationMonitor()

Retrieves information on how the ruleset is used .

This method must not be called before the start(java.util.Map<java.lang.String, java.lang.String>) method.

The null value is returned if the ruleset-usage information feature of the XU has not been enabled. See the documentation of the rulesetUsageMonitorEnabled XU configuration property.

Overrides:

getRulesetUsageInformationMonitor in class com.ibm.rules.res.xu.plugin.internal.PluginBase

Throws:

java.lang.IllegalStateException - thrown if the method is called before the plug-in is started or after it is released.

Returns:

Information on ruleset usage .

release

public void release()

Called by the XU when the plug-in is released and will not be used any more.

This method is not called when the application server is stopped, even normally. It is called when the set of plugins is changed.

Overrides:

release in class com.ibm.rules.res.xu.plugin.internal.PluginBase