Skip navigation links
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
Field Summary |
protected static java.util.logging.Logger |
LOGGER
|
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 |
LOGGER
protected static java.util.logging.Logger LOGGER
AbstractPluginExecutionStrategy
public AbstractPluginExecutionStrategy()
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
getDescription
public abstract java.lang.String getDescription()
- Description copied from interface:
GenericPluginService
- Description of the plug-in. This value will be displayed in the UI when the user selects an plug-in to assign to an plugin point.
-
- Specified by:
getDescription
in interface GenericPluginService
-
- Returns:
- the description
getMonitoringData
public abstract java.util.Map<java.lang.String,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 java.lang.String getPluginName()
- Description copied from interface:
GenericPluginService
- Name will be an identifier for the plug-in. User can use the name and version of the plug-in in plug-in UI to identify the plug-in user want to use.
-
- Specified by:
getPluginName
in interface GenericPluginService
-
- Returns:
- String name of the plug-in.
getRevision
public abstract int getRevision()
- Description copied from interface:
GenericPluginService
- Returns back the plug-in revision. Items required for plug-in management. Revision should be an integer value. Plug-in developers can keep track of multiple revisions of the plug-in. The plug-in development framework will take care of maintaining version.
-
- Specified by:
getRevision
in interface GenericPluginService
-
- Returns:
- the revision
setMonitoringStatus
public abstract void setMonitoringStatus(boolean status)
- Description copied from interface:
GenericPluginService
- get the monitoring status configured for the plugin.
-
- Specified by:
setMonitoringStatus
in interface GenericPluginService
-
- Parameters:
status
- the new monitoring status
Skip navigation links
Copyright © 2011, Oracle and/or its affiliates. All rights reserved.