weblogic.management.security.authentication
Interface AuthenticatorMBean

All Superinterfaces:

AuthenticationProviderMBean, DescriptorBean, ProviderMBean, SettableBean, StandardInterface

All Known Subinterfaces:

ActiveDirectoryAuthenticatorMBean, CustomDBMSAuthenticatorMBean, DBMSAuthenticatorMBean, DefaultAuthenticatorMBean, IPlanetAuthenticatorMBean, LDAPAuthenticatorMBean, LoginExceptionPropagatorMBean, NovellAuthenticatorMBean, OpenLDAPAuthenticatorMBean, OracleInternetDirectoryAuthenticatorMBean, OracleVirtualDirectoryAuthenticatorMBean, ReadOnlySQLAuthenticatorMBean, RealmAdapterAuthenticatorMBean, SAMLAuthenticatorMBean, SQLAuthenticatorMBean, VirtualUserAuthenticatorMBean, WindowsNTAuthenticatorMBean

public interface AuthenticatorMBean
extends AuthenticationProviderMBean

The SSPI MBean that all Authentication providers with login services must extend. This MBean provides a ControlFlag to determine whether the Authentication provider is a REQUIRED, REQUISITE, SUFFICIENT, or OPTIONAL part of the login sequence.

getControlFlag

String getControlFlag()

Returns how the login sequence uses the Authentication provider.

A REQUIRED value specifies this LoginModule must succeed. Even if it fails, authentication proceeds down the list of LoginModules for the configured Authentication providers. This setting is the default.

A REQUISITE value specifies this LoginModule must succeed. If other Authentication providers are configured and this LoginModule succeeds, authentication proceeds down the list of LoginModules. Otherwise, control is return to the application.

A SUFFICIENT value specifies this LoginModule need not succeed. If it does succeed, return control to the application. If it fails and other Authentication providers are configured, authentication proceeds down the LoginModule list.

An OPTIONAL value specifies this LoginModule need not succeed. Whether it succeeds or fails, authentication proceeds down the LoginModule list.

Default Value:

"REQUIRED"

Valid Values:

"REQUIRED", "REQUISITE", "SUFFICIENT", "OPTIONAL"

setControlFlag

void setControlFlag(String flag)
                    throws InvalidAttributeValueException

Sets how the login sequence uses the Authentication provider.

A REQUIRED value specifies this LoginModule must succeed. Even if it fails, authentication proceeds down the list of LoginModules for the configured Authentication providers. This setting is the default.

A REQUISITE value specifies this LoginModule must succeed. If other Authentication providers are configured and this LoginModule succeeds, authentication proceeds down the list of LoginModules. Otherwise, control is return to the application.

A SUFFICIENT value specifies this LoginModule need not succeed. If it does succeed, return control to the application. If it fails and other Authentication providers are configured, authentication proceeds down the LoginModule list.

An OPTIONAL value specifies this LoginModule need not succeed. Whether it succeeds or fails, authentication proceeds down the LoginModule list.

Parameters:

flag - - the new control flag value

Throws:

InvalidAttributeValueException

See Also:

AuthenticatorMBean.getControlFlag()