Skip navigation links

oracle.security.am.plugin
Class AbstractAMPlugin

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

All Implemented Interfaces:

GenericPluginService, org.osgi.framework.BundleActivator

Direct Known Subclasses:

AbstractAuthenticationPlugIn, AbstractPluginExecutionStrategy

public abstract class AbstractAMPlugin

extends java.lang.Object

implements GenericPluginService, org.osgi.framework.BundleActivator

Abstract plugin. Abstract plugin interface to be extended by all Access Management plug-ins.

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 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

LOGGER

protected static final java.util.logging.Logger LOGGER

The LOGGER.

config

protected PluginConfig config

Constructor Detail

AbstractAMPlugin

public AbstractAMPlugin()

Method Detail

getID

public java.lang.String getID()

Description copied from interface: GenericPluginService

returns the unique ID of the plug-in.

Specified by:

getID in interface GenericPluginService

Returns:

the iD

getLogger

public java.util.logging.Logger getLogger()

Description copied from interface: GenericPluginService

returns the logger configured for the plug-in.

Specified by:

getLogger in interface GenericPluginService

Returns:

the logger

getMaxWaitIntervel

public long getMaxWaitIntervel()

Description copied from interface: GenericPluginService

returns the max wait interval in milliseconds. this the max time the Authentication Engine will wiat for the plugin response.

Specified by:

getMaxWaitIntervel in interface GenericPluginService

Returns:

the max wait intervel

getPluginConfig

public PluginConfig getPluginConfig()

Description copied from interface: GenericPluginService

Gets the plugin config.

Specified by:

getPluginConfig in interface GenericPluginService

Returns:

a PluginConfig object that contains the plug-in configuration data.

initialize

public ExecutionStatus initialize(PluginConfig config)

Description copied from interface: GenericPluginService

The function initializes the Plug-in. The function should be called only once during the entire plug-in life-cycle. Assumption: The plug-in will itself pick the configuration. The plug-in and its configuration will first be across the cluster. The SDK will have the API's to read the oam-config.xml. The plug-in writer will use these API's to load the plug-in configuration. Environment information will be passed to the plug-in. i.e. information like ?

Specified by:

initialize in interface GenericPluginService

Returns:

the execution status

shutdown

public ExecutionStatus shutdown(java.util.Map<java.lang.String,java.io.Serializable> AMEnvironmentContext)

Description copied from interface: GenericPluginService

Shutdown.

Specified by:

shutdown in interface GenericPluginService

Parameters:

AMEnvironmentContext - the aM environment context

Returns:

the execution status

start

public final void start(org.osgi.framework.BundleContext context)
                 throws java.lang.Exception

Implements BundleActivator.start(). Registers an instance of a plugin service using the bundle context; attaches properties to the service that can be queried when performing a service look-up.

Specified by:

start in interface org.osgi.framework.BundleActivator

Parameters:

context - the framework context for the bundle.

Throws:

java.lang.Exception

stop

public final void stop(org.osgi.framework.BundleContext context)
                throws java.lang.Exception

Implements BundleActivator.stop(). Does nothing related to framework since the framework will automatically unregister any registered services.

Specified by:

stop in interface org.osgi.framework.BundleActivator

Parameters:

context - the framework context for the bundle.

Throws:

java.lang.Exception

poweronSelfTest

public boolean poweronSelfTest()

Description copied from interface: GenericPluginService

Plug-ins need to override this method to the self test when the plug-ins are loaded. 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.

Specified by:

poweronSelfTest in interface GenericPluginService

Returns:

startPlugin

public void startPlugin(org.osgi.framework.BundleContext bundleContext)

Description copied from interface: GenericPluginService

The callback method for custom plugins. Custom plugins can implement this method for plugin specific initialization. The method is called when plugin is registered to service.

Specified by:

startPlugin in interface GenericPluginService

shutdownPlugin

public void shutdownPlugin(org.osgi.framework.BundleContext bundleContext)

Description copied from interface: GenericPluginService

The callback method for custom plugins. Custom plugins can implement this method for plugin instance specific finalization. The method is called when plugin is unregistered from service.

Specified by:

shutdownPlugin in interface GenericPluginService

Skip navigation links