Package oracle.security.am.plugin

Class OAMAbstractAMPlugin

java.lang.Object
oracle.security.am.plugin.OAMAbstractAMPlugin
All Implemented Interfaces:
GenericPluginService
Direct Known Subclasses:
AbstractAMPlugin, AbstractPluginExecutionStrategy
public abstract class OAMAbstractAMPlugin extends Object implements GenericPluginService
Abstract plugin. Abstract plugin interface to be extended by all Access Management plug-ins.
Since:
OAM11gR1

  • Constructor Details

    • OAMAbstractAMPlugin

      public OAMAbstractAMPlugin()

  • Method Details

    • getID

      public 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 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 final 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<wbr>(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 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 ?
      Specified by:
      initialize in interface GenericPluginService
      Returns:
      the execution status

    • shutdown

      public ExecutionStatus shutdown<wbr>(Map<String,<wbr>Serializable> AMEnvironmentContext)
      Description copied from interface: GenericPluginService
      Shutdown.
      Specified by:
      shutdown in interface GenericPluginService
      Parameters:
      AMEnvironmentContext - the aM environment context
      Returns:
      the execution status

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