Skip navigation links
oracle.security.am.plugin.authn
Class AbstractAuthenticationPlugIn
java.lang.Object
oracle.security.am.plugin.AbstractAMPlugin
oracle.security.am.plugin.authn.AbstractAuthenticationPlugIn
- All Implemented Interfaces:
- AuthnPluginService, GenericPluginService, org.osgi.framework.BundleActivator
-
public abstract class AbstractAuthenticationPlugIn
- extends AbstractAMPlugin
- 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.5.0
- Version:
- OAM 11.1.1.5.0
Field Summary |
protected static java.util.logging.Logger |
LOGGER
|
Methods inherited from class oracle.security.am.plugin.AbstractAMPlugin |
getID, getLogger, getMaxWaitIntervel, getPluginConfig, initialize, poweronSelfTest, shutdown, shutdownPlugin, start, startPlugin, stop |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
LOGGER
protected static java.util.logging.Logger LOGGER
AbstractAuthenticationPlugIn
public AbstractAuthenticationPlugIn()
process
public abstract ExecutionStatus process(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 java.lang.String getDescription()
- Description copied from interface:
GenericPluginService
- 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.
-
- Specified by:
getDescription
in interface GenericPluginService
-
- Returns:
- the description
getMonitoringData
public abstract java.util.Map<java.lang.String,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 java.lang.String getPluginName()
- Description copied from interface:
GenericPluginService
- 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.
-
- Specified by:
getPluginName
in interface GenericPluginService
-
- Returns:
- String name of the plug-in.
getRevision
public abstract int getRevision()
- Description copied from interface:
GenericPluginService
- 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.
-
- Specified by:
getRevision
in interface GenericPluginService
-
- Returns:
- the revision
setMonitoringStatus
public abstract void setMonitoringStatus(boolean status)
- Description copied from interface:
GenericPluginService
- get the monitoring status configured for the plugin.
-
- Specified by:
setMonitoringStatus
in interface GenericPluginService
-
- Parameters:
status
- the new monitoring status
Skip navigation links
Copyright © 2011, Oracle and/or its affiliates. All rights reserved.