Package oracle.security.am.plugin

Interface GenericPluginService

All Known Subinterfaces:
AuthnPluginService, PluginExecutionStrategy
All Known Implementing Classes:
AbstractAMPlugin, AbstractAuthenticationPlugIn, AbstractPluginExecutionStrategy, OAMAbstractAMPlugin, OAMAbstractAuthenticationPlugIn
public interface GenericPluginService
The GenericPluginService class.
Since:
OAM 11.1.1.2.0

  • Method Details

    • initialize

      ExecutionStatus initialize<wbr>(PluginConfig config)
      The function initializes the Plug-in. The function should be called only once during the entire plug-in lifecycle. 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 plugin 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<wbr>(Map<String,<wbr>Serializable> AMEnvironmentContext)
      Shutdown.
      Parameters:
      AMEnvironmentContext - the aM environment context
      Returns:
      the execution status

    • getID

      String getID()
      returns the unique ID of the plug-in.
      Returns:
      the iD

    • getLogger

      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

    • getMonitoringStatus

      boolean getMonitoringStatus()
      set the monitoring status for the plug-in.
      Returns:
      the monitoring status

    • getMonitoringData

      Map<String,<wbr>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: