AuthnModuleConfig (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
Interface AuthnModuleConfig

public interface AuthnModuleConfig

AuthnModuleConfig object will hold the configuration details for the plugin. All the prameters configured for the plug-in will be available in the AuthnModuleConfig object. The runtime parameters configured in the step configuration will be part of the AuthnModuleConfig object.

Since:: OAM 11.1.1.5.0
Version:: OAM 11.1.1.5.0

Method Summary
`java.lang.String`	`getAuthnModuleDesc()` Gets the description of the authentication module.
`java.lang.String`	`getAuthnModuleName()` Gets the Module name configured for the authentication module.
`java.util.List<AuthnModuleStepConfig>`	`getAuthnModuleSteps()` Returns the list of Module configuration Steps.
`AuthnModuleStrategyConfig`	`getAuthnModuleStrategy()` Returns a `AuthnModuleStrategyConfig` object.
`java.lang.String`	`getStartingStep()` Returns the starting step for the module execution.
`boolean`	`isComposite()` Whether the module is composite or not.
`void`	`setAuthnModuleDesc(java.lang.String authnModuleDesc)` Sets the description for the authentication module
`void`	`setAuthnModuleName(java.lang.String authnModuleName)` Sets the Module name for the authentication module.
`void`	`setAuthnModuleSteps(java.util.List<AuthnModuleStepConfig> authnModuleSteps)` Sets thelist of Module configuration Steps.
`void`	`setAuthnModuleStrategy(AuthnModuleStrategyConfig authnModuleStrategy)` Sets the `AuthnModuleStrategyConfig` object.
`void`	`setComposite(boolean composite)` Set if the module is composite or not

Method Detail

getAuthnModuleName

java.lang.String getAuthnModuleName()

Gets the Module name configured for the authentication module.

Returns:: the authnModuleName

setAuthnModuleName

void setAuthnModuleName(java.lang.String authnModuleName)

Sets the Module name for the authentication module.

Parameters:: authnModuleName - the authnModuleName to set

getAuthnModuleDesc

java.lang.String getAuthnModuleDesc()

Gets the description of the authentication module.

Returns:: the authnModuleDesc

setAuthnModuleDesc

void setAuthnModuleDesc(java.lang.String authnModuleDesc)

Sets the description for the authentication module

Parameters:: authnModuleDesc - the authnModuleDesc to set

getAuthnModuleSteps

java.util.List<AuthnModuleStepConfig> getAuthnModuleSteps()

Returns the list of Module configuration Steps. Steps will have the step level parameters defined for the authentication module.

Returns:: the authnModuleSteps

setAuthnModuleSteps

void setAuthnModuleSteps(java.util.List<AuthnModuleStepConfig> authnModuleSteps)

Sets thelist of Module configuration Steps. Steps will have the step level parameters defined for the authentication module.

Parameters:: authnModuleSteps - the authnModuleSteps to set

getAuthnModuleStrategy

AuthnModuleStrategyConfig getAuthnModuleStrategy()

Returns a AuthnModuleStrategyConfig object. Strategy configuration defines the parameters required for the strategy to execute.

Returns:: the authnModuleStrategy

setAuthnModuleStrategy

void setAuthnModuleStrategy(AuthnModuleStrategyConfig authnModuleStrategy)

Sets the AuthnModuleStrategyConfig object. Strategy configuration defines the parameters required for the strategy to execute.

Parameters:: authnModuleStrategy - the authnModuleStrategy to set

isComposite

boolean isComposite()

Whether the module is composite or not.

Returns:

setComposite

void setComposite(boolean composite)

Set if the module is composite or not

Parameters:: composite -

getStartingStep

java.lang.String getStartingStep()

Returns the starting step for the module execution.

Returns:: String strategy name.