|
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 |
java.lang.Object
oracle.security.am.plugin.AbstractAMPlugin
public abstract class AbstractAMPlugin
Abstract plugin. Abstract plugin interface to be extended by all Access Management plug-ins.
Nested Class Summary |
---|
Nested classes/interfaces inherited from interface oracle.security.am.plugin.GenericPluginService |
---|
GenericPluginService.QueryKey |
Field Summary | |
---|---|
protected PluginConfig |
config |
protected static java.util.logging.Logger |
LOGGER The LOGGER. |
Constructor Summary | |
---|---|
AbstractAMPlugin() |
Method Summary | |
---|---|
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. |
PluginConfig |
getPluginConfig() Gets the plugin config. |
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. |
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 |
start(org.osgi.framework.BundleContext context) Implements BundleActivator.start(). |
void |
startPlugin(org.osgi.framework.BundleContext bundleContext) The callback method for custom plugins. |
void |
stop(org.osgi.framework.BundleContext context) Implements BundleActivator.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 |
---|
getDescription, getMonitoringData, getMonitoringStatus, getPluginName, getRevision, setMonitoringStatus |
Field Detail |
---|
protected static final java.util.logging.Logger LOGGER
protected PluginConfig config
Constructor Detail |
---|
public AbstractAMPlugin()
Method Detail |
---|
public java.lang.String getID()
GenericPluginService
getID
in interface GenericPluginService
public java.util.logging.Logger getLogger()
GenericPluginService
getLogger
in interface GenericPluginService
public long getMaxWaitIntervel()
GenericPluginService
getMaxWaitIntervel
in interface GenericPluginService
public PluginConfig getPluginConfig()
GenericPluginService
getPluginConfig
in interface GenericPluginService
PluginConfig
object that contains the plug-in configuration data.public ExecutionStatus initialize(PluginConfig config)
GenericPluginService
initialize
in interface GenericPluginService
public ExecutionStatus shutdown(java.util.Map<java.lang.String,java.io.Serializable> AMEnvironmentContext)
GenericPluginService
shutdown
in interface GenericPluginService
AMEnvironmentContext
- the aM environment contextpublic final void start(org.osgi.framework.BundleContext context) throws java.lang.Exception
start
in interface org.osgi.framework.BundleActivator
context
- the framework context for the bundle.java.lang.Exception
public final void stop(org.osgi.framework.BundleContext context) throws java.lang.Exception
stop
in interface org.osgi.framework.BundleActivator
context
- the framework context for the bundle.java.lang.Exception
public boolean poweronSelfTest()
GenericPluginService
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.poweronSelfTest
in interface GenericPluginService
public void startPlugin(org.osgi.framework.BundleContext bundleContext)
GenericPluginService
startPlugin
in interface GenericPluginService
public void shutdownPlugin(org.osgi.framework.BundleContext bundleContext)
GenericPluginService
shutdownPlugin
in interface GenericPluginService
|
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 |