AbstractAuthenticationPlugIn (Oracle Access Manager Extensibility Java API Reference)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Oracle Access Manager Extensibility Java API Reference
11g Release 1 (11.1.1.5)
E22473-01

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

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

Nested Class Summary

Nested classes/interfaces inherited from interface oracle.security.am.plugin.GenericPluginService
`GenericPluginService.QueryKey`

Field Summary
`protected static java.util.logging.Logger`	`LOGGER`

Fields inherited from class oracle.security.am.plugin.AbstractAMPlugin
`config`

Constructor Summary
`AbstractAuthenticationPlugIn()`

Method Summary
`abstract java.lang.String`	`getDescription()` Description of the plug-in.
`abstract java.util.Map<java.lang.String,MonitoringData>`	`getMonitoringData()` plug-in can return monitoring data after plug-in execution is complete.
`abstract boolean`	`getMonitoringStatus()` set the monitoring status for the plug-in.
`abstract java.lang.String`	`getPluginName()` Name will be an identifier for the plug-in.
`abstract int`	`getRevision()` Returns back the plug-in revision.
`abstract ExecutionStatus`	`process(AuthenticationContext context)` Authentication plug-ins can access all the data available in the `AuthenticationContext` object.
`abstract void`	`setMonitoringStatus(boolean status)` get the monitoring status configured for the plugin.

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`

Methods inherited from interface oracle.security.am.plugin.GenericPluginService
`getID, getLogger, getMaxWaitIntervel, getPluginConfig, initialize, poweronSelfTest, shutdown, shutdownPlugin, startPlugin`

Field Detail

LOGGER

protected static java.util.logging.Logger LOGGER

Constructor Detail

AbstractAuthenticationPlugIn

public AbstractAuthenticationPlugIn()

Method Detail

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