AbstractPluginExecutionStrategy (Oracle Access Manager Extensibility Java API Reference)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Oracle Access Manager Extensibility Java API Reference
11g Release 1 (11.1.1.5)
E22473-01

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

oracle.security.am.plugin
Class AbstractPluginExecutionStrategy

java.lang.Object oracle.security.am.plugin.AbstractAMPlugin oracle.security.am.plugin.AbstractPluginExecutionStrategy

All Implemented Interfaces:: GenericPluginService, PluginExecutionStrategy, org.osgi.framework.BundleActivator

public abstract class AbstractPluginExecutionStrategy

extends AbstractAMPlugin

implements PluginExecutionStrategy

Abstract base class for creating plug-in execution strategy. All plug-in execution strategy classes should extend this class. ModuleAdvice executionStrategy(PluginContext context, String currentPlugin,String currentModulePlugin, List<String>pluginList); Method should be implemented by the extending classes ModuleAdvice should have the proper advice and the next module name set. Plugin execution will continue till ModuleAdvice returns an Advice.STOP advice

Since:: OAM 11.1.1.5.0
Version:: OAM 11.1.1.5.0

Nested Class Summary

Nested classes/interfaces inherited from interface oracle.security.am.plugin.GenericPluginService
`GenericPluginService.QueryKey`

Field Summary
`protected static java.util.logging.Logger`	`LOGGER`

Fields inherited from class oracle.security.am.plugin.AbstractAMPlugin
`config`

Constructor Summary
`AbstractPluginExecutionStrategy()`

Method Summary
`abstract java.lang.String`	`getDescription()` Description of the plug-in.
`abstract java.util.Map<java.lang.String,MonitoringData>`	`getMonitoringData()` plug-in can return monitoring data after plug-in execution is complete.
`abstract boolean`	`getMonitoringStatus()` set the monitoring status for the plug-in.
`abstract java.lang.String`	`getPluginName()` Name will be an identifier for the plug-in.
`abstract int`	`getRevision()` Returns back the plug-in revision.
`abstract ModuleAdvice`	`processExecutionStrategy(PluginContext context, java.lang.String currentPlugin, ExecutionStatus currentPluginStatus, java.util.List<java.lang.String> pluginList)` `processExecutionStrategy` method will be called before execution of the first module and after execution of each modules in the module list.
`abstract void`	`setMonitoringStatus(boolean status)` get the monitoring status configured for the plugin.

Methods inherited from class oracle.security.am.plugin.AbstractAMPlugin
`getID, getLogger, getMaxWaitIntervel, getPluginConfig, initialize, poweronSelfTest, shutdown, shutdownPlugin, start, startPlugin, stop`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Methods inherited from interface oracle.security.am.plugin.GenericPluginService
`getID, getLogger, getMaxWaitIntervel, getPluginConfig, initialize, poweronSelfTest, shutdown, shutdownPlugin, startPlugin`

Field Detail

LOGGER

protected static java.util.logging.Logger LOGGER

Constructor Detail

AbstractPluginExecutionStrategy

public AbstractPluginExecutionStrategy()

Method Detail

processExecutionStrategy

public abstract ModuleAdvice processExecutionStrategy(PluginContext context,
                                                      java.lang.String currentPlugin,
                                                      ExecutionStatus currentPluginStatus,
                                                      java.util.List<java.lang.String> pluginList)

Description copied from interface: PluginExecutionStrategy

processExecutionStrategy method will be called before execution of the first module and after execution of each modules in the module list. Next module will be called based on the module name specified in the ModuleAdvice.

Specified by:: processExecutionStrategy in interface PluginExecutionStrategy

Parameters:: context - context of the plug-in.a PluginContext object that will contain the execution context for plug-ins.; currentPlugin - the current plug-in that is executed. If it is called before the execution. ModuleAdvice should have the proper advice and the next module name set. Plugin execution will continue till ModuleAdvice returns an Advice.STOP advice; currentPluginStatus - is the status of the current plugin execution. a ExecutionStatus object will be provided to the strategy. This will be null when the strategy is called before execution.; pluginList - the plugin list
Returns:: the module advice