Skip navigation links

oracle.security.am.plugin
Interface GenericPluginService

All Known Subinterfaces:

AuthnPluginService, PluginExecutionStrategy

All Known Implementing Classes:

AbstractAMPlugin, AbstractAuthenticationPlugIn, AbstractPluginExecutionStrategy

public interface GenericPluginService

The GenericPluginService Defines base the interface for all OAM plugins.

Since:

OAM 11.1.1.5.0

Version:

OAM 11.1.1.5.0

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

initialize

ExecutionStatus initialize(PluginConfig config)

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 ?

Parameters:

AMEnvironmentContext - the aM environment context

Returns:

the execution status

shutdown

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

Shutdown.

Parameters:

AMEnvironmentContext - the aM environment context

Returns:

the execution status

getRevision

int getRevision()

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.

Returns:

the revision

getPluginName

java.lang.String getPluginName()

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.

Returns:

String name of the plug-in.

getID

java.lang.String getID()

returns the unique ID of the plug-in.

Returns:

the iD

getDescription

java.lang.String getDescription()

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.

Returns:

the description

getLogger

java.util.logging.Logger getLogger()

returns the logger configured for the plug-in.

Returns:

the logger

getPluginConfig

PluginConfig getPluginConfig()

Gets the plugin config.

Returns:

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

getMaxWaitIntervel

long getMaxWaitIntervel()

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

Returns:

the max wait intervel

setMonitoringStatus

void setMonitoringStatus(boolean status)

get the monitoring status configured for the plugin.

Parameters:

status - the new monitoring status

getMonitoringStatus

boolean getMonitoringStatus()

set the monitoring status for the plug-in.

Returns:

the monitoring status

getMonitoringData

java.util.Map<java.lang.String,MonitoringData> getMonitoringData()

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

Returns:

the monitoring data

poweronSelfTest

boolean poweronSelfTest()

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.

Returns:

startPlugin

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

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.

Parameters:

bundleContext -

shutdownPlugin

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

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.

Parameters:

bundleContext -

Skip navigation links