weblogic.security.providers.authentication
Interface DefaultAuthenticatorMBean

All Superinterfaces:

AuthenticationProviderMBean, AuthenticatorMBean, DescriptorBean, ExportMBean, GroupEditorMBean, GroupMemberListerMBean, GroupMembershipHierarchyCacheMBean, GroupReaderMBean, GroupRemoverMBean, GroupUserListerMBean, ImportMBean, ListerMBean, LoginExceptionPropagatorMBean, MemberGroupListerMBean, NameListerMBean, ProviderMBean, SettableBean, StandardInterface, UserAttributeEditorMBean, UserAttributeReaderMBean, UserEditorMBean, UserPasswordEditorMBean, UserReaderMBean, UserRemoverMBean

public interface DefaultAuthenticatorMBean
extends StandardInterface, DescriptorBean, LoginExceptionPropagatorMBean, UserEditorMBean, GroupEditorMBean, GroupMemberListerMBean, MemberGroupListerMBean, GroupUserListerMBean, ImportMBean, ExportMBean, GroupMembershipHierarchyCacheMBean, UserAttributeEditorMBean

The MBean that represents configuration attributes for the WebLogic Authentication provider. The WebLogic Authentication provider has methods to edit, list, and manage users, groups, and group membership. User and group information is stored in an embedded LDAP server.

Deprecation of MBeanHome and Type-Safe Interfaces

This is a type-safe interface for a WebLogic Server MBean, which you can import into your client classes and access through weblogic.management.MBeanHome. As of 9.0, the MBeanHome interface and all type-safe interfaces for WebLogic Server MBeans are deprecated. Instead, client classes that interact with WebLogic Server MBeans should use standard JMX design patterns in which clients use the javax.management.MBeanServerConnection interface to discover MBeans, attributes, and attribute types at runtime.

getProviderClassName

String getProviderClassName()

The name of the Java class used to load the Authentication provider.

Default Value:

"weblogic.security.providers.authentication.DefaultAuthenticationProviderImpl"

getDescription

String getDescription()

A short description of the Authentication provider.

Specified by:

getDescription in interface ProviderMBean

Default Value:

"WebLogic Authentication Provider"

getVersion

String getVersion()

The version number of the Authentication provider.

Specified by:

getVersion in interface ProviderMBean

Default Value:

"1.0"

getMinimumPasswordLength

int getMinimumPasswordLength()

The minimum number of characters required in a password.

Default Value:

8

Minimum Value:

0

setMinimumPasswordLength

void setMinimumPasswordLength(int newValue)
                              throws InvalidAttributeValueException

The minimum number of characters required in a password.

Parameters:

newValue - - new value for attribute MinimumPasswordLength

Throws:

InvalidAttributeValueException

Default Value:

8

Minimum Value:

0

getSupportedImportFormats

String[] getSupportedImportFormats()

The format of the file to import. The list of supported import formats is determined by the Authentication provider from which the users and groups were originally exported.

Specified by:

getSupportedImportFormats in interface ImportMBean

Default Value:

"DefaultAtn"

getSupportedImportConstraints

String[] getSupportedImportConstraints()

The users and groups that you want to be imported into this Authentication provider's database. If no constraints are specified, all are imported.

Specified by:

getSupportedImportConstraints in interface ImportMBean

Default Value:

""

getSupportedExportFormats

String[] getSupportedExportFormats()

The format of the file to export. The list of supported export formats is determined by this Authentication provider.

Specified by:

getSupportedExportFormats in interface ExportMBean

Default Value:

"DefaultAtn"

getSupportedExportConstraints

String[] getSupportedExportConstraints()

The users and groups that you want to be exported from this Authentication provider's database. If none are specified, all are exported. If EnablePasswordDigestInformation is set to true, then 2- way encrypted passwords can be exported via the passwords=cleartext constraint.

Specified by:

getSupportedExportConstraints in interface ExportMBean

Default Value:

"users","groups","passwords"

getGroupMembershipSearching

String getGroupMembershipSearching()

Specifies whether recursive group membership searching is unlimited or limited. Valid values are unlimited and limited.

Default Value:

"unlimited"

Valid Values:

"unlimited","limited"

setGroupMembershipSearching

void setGroupMembershipSearching(String newValue)
                                 throws InvalidAttributeValueException

Specifies whether recursive group membership searching is unlimited or limited. Valid values are unlimited and limited.

Parameters:

newValue - - new value for attribute GroupMembershipSearching

Throws:

InvalidAttributeValueException

Default Value:

"unlimited"

Valid Values:

"unlimited","limited"

getMaxGroupMembershipSearchLevel

Integer getMaxGroupMembershipSearchLevel()

Specifies how many levels of group membership can be searched. This setting is valid only if GroupMembershipSearching is set to limited. Valid values are 0, and positive numbers. For example, 0 indicates only direct group memberships will be found, a positive number indicates the number of levels to go down.

Default Value:

new Integer(0)

setMaxGroupMembershipSearchLevel

void setMaxGroupMembershipSearchLevel(Integer newValue)
                                      throws InvalidAttributeValueException

Specifies how many levels of group membership can be searched. This setting is valid only if GroupMembershipSearching is set to limited. Valid values are 0, and positive numbers. For example, 0 indicates only direct group memberships will be found, a positive number indicates the number of levels to go down.

Parameters:

newValue - - new value for attribute MaxGroupMembershipSearchLevel

Throws:

InvalidAttributeValueException

Default Value:

new Integer(0)

getUseRetrievedUserNameAsPrincipal

Boolean getUseRetrievedUserNameAsPrincipal()

Specifies whether to use the user name retrieved from LDAP as the Principal in the Subject.

Default Value:

new Boolean(false)

setUseRetrievedUserNameAsPrincipal

void setUseRetrievedUserNameAsPrincipal(Boolean newValue)
                                        throws InvalidAttributeValueException

Specifies whether to use the user name retrieved from LDAP as the Principal in the Subject.

Parameters:

newValue - - new value for attribute UseRetrievedUserNameAsPrincipal

Throws:

InvalidAttributeValueException

Default Value:

new Boolean(false)

isPasswordDigestEnabled

boolean isPasswordDigestEnabled()

Enables the storage of password information required to support Web Services Security Password Digest and other digest authentication algorithms. If set to true, the WebLogic Authentication provider stores the user password in a 2-way encrypted form. The original password can then be retrieved and used for digest authentication.

Default Value:

false

setPasswordDigestEnabled

void setPasswordDigestEnabled(boolean newValue)
                              throws InvalidAttributeValueException

Enables the storage of password information required to support Web Services Security Password Digest and other digest authentication algorithms. If set to true, the WebLogic Authentication provider stores the user password in a 2-way encrypted form. The original password can then be retrieved and used for digest authentication.

Parameters:

newValue - - new value for attribute PasswordDigestEnabled

Throws:

InvalidAttributeValueException

Default Value:

false

isKeepAliveEnabled

boolean isKeepAliveEnabled()

Specifies whether to prevent LDAP connections from timing out.

Default Value:

false

setKeepAliveEnabled

void setKeepAliveEnabled(boolean newValue)
                         throws InvalidAttributeValueException

Specifies whether to prevent LDAP connections from timing out.

Parameters:

newValue - - new value for attribute KeepAliveEnabled

Throws:

InvalidAttributeValueException

Default Value:

false

getEnableGroupMembershipLookupHierarchyCaching

Boolean getEnableGroupMembershipLookupHierarchyCaching()

Sets whether to cache group membership hierarchies found during recursive membership lookup. If true, each subtree found will be cached. This overwrites the default value defined in GroupMembershipHierarchyCacheMBean.

Specified by:

getEnableGroupMembershipLookupHierarchyCaching in interface GroupMembershipHierarchyCacheMBean

Default Value:

new Boolean(true)

setEnableGroupMembershipLookupHierarchyCaching

void setEnableGroupMembershipLookupHierarchyCaching(Boolean newValue)
                                                    throws InvalidAttributeValueException

Sets whether to cache group membership hierarchies found during recursive membership lookup. If true, each subtree found will be cached. This overwrites the default value defined in GroupMembershipHierarchyCacheMBean.

Specified by:

setEnableGroupMembershipLookupHierarchyCaching in interface GroupMembershipHierarchyCacheMBean

Parameters:

newValue - - new value for attribute EnableGroupMembershipLookupHierarchyCaching

Throws:

InvalidAttributeValueException

See Also:

GroupMembershipHierarchyCacheMBean.getEnableGroupMembershipLookupHierarchyCaching()

Default Value:

new Boolean(true)

getName

String getName()

Description copied from interface: ProviderMBean

The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.

Specified by:

getName in interface LoginExceptionPropagatorMBean

Specified by:

getName in interface ProviderMBean

Specified by:

getName in interface StandardInterface

Default Value:

"DefaultAuthenticator"