|
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 |
public interface GenericPluginService
The GenericPluginService
Defines base the interface for all OAM plugins.
Nested Class Summary | |
---|---|
static class |
GenericPluginService.QueryKey Defines the plug-in properties for the OSGI bundle. |
Method Summary | |
---|---|
java.lang.String |
getDescription() Description of the plug-in. |
java.lang.String |
getID() returns the unique ID of the plug-in. |
java.util.logging.Logger |
getLogger() returns the logger configured for the plug-in. |
long |
getMaxWaitIntervel() returns the max wait interval in milliseconds. |
java.util.Map<java.lang.String,MonitoringData> |
getMonitoringData() plug-in can return monitoring data after plug-in execution is complete. |
boolean |
getMonitoringStatus() set the monitoring status for the plug-in. |
PluginConfig |
getPluginConfig() Gets the plugin config. |
java.lang.String |
getPluginName() Name will be an identifier for the plug-in. |
int |
getRevision() Returns back the plug-in revision. |
ExecutionStatus |
initialize(PluginConfig config) The function initializes the Plug-in. |
boolean |
poweronSelfTest() Plug-ins need to override this method to the self test when the plug-ins are loaded. |
void |
setMonitoringStatus(boolean status) get the monitoring status configured for the plugin. |
ExecutionStatus |
shutdown(java.util.Map<java.lang.String,java.io.Serializable> AMEnvironmentContext) Shutdown. |
void |
shutdownPlugin(org.osgi.framework.BundleContext bundleContext) The callback method for custom plugins. |
void |
startPlugin(org.osgi.framework.BundleContext bundleContext) The callback method for custom plugins. |
Method Detail |
---|
ExecutionStatus initialize(PluginConfig config)
AMEnvironmentContext
- the aM environment contextExecutionStatus shutdown(java.util.Map<java.lang.String,java.io.Serializable> AMEnvironmentContext)
AMEnvironmentContext
- the aM environment contextint getRevision()
java.lang.String getPluginName()
java.lang.String getID()
java.lang.String getDescription()
java.util.logging.Logger getLogger()
PluginConfig getPluginConfig()
PluginConfig
object that contains the plug-in configuration data.long getMaxWaitIntervel()
void setMonitoringStatus(boolean status)
status
- the new monitoring statusboolean getMonitoringStatus()
java.util.Map<java.lang.String,MonitoringData> getMonitoringData()
boolean poweronSelfTest()
poweronSelfTest
will be called by the framework after the plug-in is loaded to check if the plug-in has all the dependencies satisfied and ready to service.void startPlugin(org.osgi.framework.BundleContext bundleContext)
bundleContext
-void shutdownPlugin(org.osgi.framework.BundleContext bundleContext)
bundleContext
-
|
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 |