Package oracle.security.am.plugin

Class AbstractPluginExecutionStrategy

java.lang.Object

oracle.security.am.plugin.OAMAbstractAMPlugin

oracle.security.am.plugin.AbstractPluginExecutionStrategy

All Implemented Interfaces:

GenericPluginService, PluginExecutionStrategy

public abstract class AbstractPluginExecutionStrategy
extends OAMAbstractAMPlugin
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.2.0

Nested Class Summary

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

GenericPluginService.QueryKey

Constructor Summary

Constructors

Constructor	Description
AbstractPluginExecutionStrategy()

Method Summary

Modifier and Type	Method	Description
abstract String	getDescription()
abstract Map<String,<wbr>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 String	getPluginName()
abstract int	getRevision()
String	getStartingStep<wbr>(AuthenticationContext authnContext)
abstract ModuleAdvice	processExecutionStrategy<wbr>(PluginContext context, String currentPlugin, ExecutionStatus currentPluginStatus, List<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<wbr>(boolean status)

Methods inherited from class oracle.security.am.plugin.OAMAbstractAMPlugin

getID, getLogger, getMaxWaitIntervel, getPluginConfig, initialize, poweronSelfTest, shutdown

Methods inherited from class java.lang.Object

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

Methods inherited from interface oracle.security.am.plugin.GenericPluginService

getID, getLogger, getMaxWaitIntervel, getPluginConfig, initialize, poweronSelfTest, shutdown

Constructor Details

AbstractPluginExecutionStrategy

public AbstractPluginExecutionStrategy()

Method Details

processExecutionStrategy

public abstract ModuleAdvice processExecutionStrategy<wbr>(PluginContext context,
 String currentPlugin,
 ExecutionStatus currentPluginStatus,
 List<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

getDescription

public abstract String getDescription()

Specified by:

getDescription in interface GenericPluginService

Returns:

the description

getMonitoringData

public abstract Map<String,<wbr>MonitoringData> getMonitoringData()

Description copied from interface: GenericPluginService

plug-in can return monitoring data after plug-in execution is complete. Server will log this data.

Specified by:

getMonitoringData in interface GenericPluginService

Returns:

the monitoring data

getMonitoringStatus

public abstract boolean getMonitoringStatus()

Description copied from interface: GenericPluginService

set the monitoring status for the plug-in.

Specified by:

getMonitoringStatus in interface GenericPluginService

Returns:

the monitoring status

getPluginName

public abstract String getPluginName()

Specified by:

getPluginName in interface GenericPluginService

Returns:

String name of the plug-in.

getRevision

public abstract int getRevision()

Specified by:

getRevision in interface GenericPluginService

Returns:

the revision

setMonitoringStatus

public abstract void setMonitoringStatus<wbr>(boolean status)

Specified by:

setMonitoringStatus in interface GenericPluginService

Parameters:

status - the new monitoring status

getStartingStep

public String getStartingStep<wbr>(AuthenticationContext authnContext)