Package oracle.security.am.plugin.authn

Class OAMAbstractAuthenticationPlugIn

java.lang.Object
oracle.security.am.plugin.OAMAbstractAMPlugin
oracle.security.am.plugin.authn.OAMAbstractAuthenticationPlugIn
All Implemented Interfaces:
AuthnPluginService, GenericPluginService
Direct Known Subclasses:
AbstractAuthenticationPlugIn
public abstract class OAMAbstractAuthenticationPlugIn extends OAMAbstractAMPlugin implements AuthnPluginService
Plug-in Interface that will be exposed to the plug-in developers. All the plug-in implementations should extend AbstractPlugInService class. Plug-ins that needs to handle the resource cleanup should override shutdown(Map < String, Object > OAMEnvironmentContext) An instance of java.util.Logger will be available to plug-ins.
Since:
OAM 11.1.1.2.0

  • Constructor Details

    • OAMAbstractAuthenticationPlugIn

      public OAMAbstractAuthenticationPlugIn()

  • Method Details

    • process

      public abstract ExecutionStatus process<wbr>(AuthenticationContext context) throws AuthenticationException
      Description copied from interface: AuthnPluginService
      Authentication plug-ins can access all the data available in the AuthenticationContext object. plug-in can set response that will be added to SESSION,request and redirect contexts. PluginAttributeContextType.SESSION all the attributes that need to be set in the session should be added with this context. PluginAttributeContextType.REQUEST all the attributes that need to be set in the request context should be added with this context. PluginAttributeContextType.REQUEST all the attributes that need to be set as a re-direct URL should be added with this context.
      Specified by:
      process in interface AuthnPluginService
      Parameters:
      context - an AuthenticationContext object.
      Returns:
      the execution status
      Throws:
      AuthenticationException - the authentication exception

    • getDescription

      public abstract String getDescription()
      Specified by:
      getDescription in interface GenericPluginService
      Returns:
      the description

    • getMonitoringData

      public abstract Map<String,<wbr>MonitoringData> getMonitoringData()
      Description copied from interface: GenericPluginService
      plug-in can return monitoring data after plug-in execution is complete. Server will log this data.
      Specified by:
      getMonitoringData in interface GenericPluginService
      Returns:
      the monitoring data

    • getMonitoringStatus

      public abstract boolean getMonitoringStatus()
      Description copied from interface: GenericPluginService
      set the monitoring status for the plug-in.
      Specified by:
      getMonitoringStatus in interface GenericPluginService
      Returns:
      the monitoring status

    • getPluginName

      public abstract String getPluginName()
      Specified by:
      getPluginName in interface GenericPluginService
      Returns:
      String name of the plug-in.

    • getRevision

      public abstract int getRevision()
      Specified by:
      getRevision in interface GenericPluginService
      Returns:
      the revision

    • setMonitoringStatus

      public abstract void setMonitoringStatus<wbr>(boolean status)
      Specified by:
      setMonitoringStatus in interface GenericPluginService
      Parameters:
      status - the new monitoring status