LDAPAuthenticatorMBean (BEA WebLogic Server 9.0 API Reference)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

BEA Systems, Inc.

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

Type-Safe Access to BEA WebLogic Server 9.0 MBeans (Deprecated)

(Methods marked with @since 9.0.0.0 are not available through the deprecated `MBeanHome` interface.)

weblogic.security.providers.authentication
Interface LDAPAuthenticatorMBean

All Superinterfaces:: AuthenticationProviderMBean, AuthenticatorMBean, weblogic.descriptor.DescriptorBean, GroupMemberListerMBean, GroupMembershipHierarchyCacheMBean, GroupReaderMBean, LDAPServerMBean, ListerMBean, LoginExceptionPropagatorMBean, MemberGroupListerMBean, NameListerMBean, ProviderMBean, weblogic.descriptor.SettableBean, weblogic.management.commo.StandardInterface, UserPasswordEditorMBean, UserReaderMBean

All Known Subinterfaces:: ActiveDirectoryAuthenticatorMBean, IPlanetAuthenticatorMBean, NovellAuthenticatorMBean, OpenLDAPAuthenticatorMBean

public interface LDAPAuthenticatorMBean
extends weblogic.management.commo.StandardInterface, weblogic.descriptor.DescriptorBean, LoginExceptionPropagatorMBean, LDAPServerMBean, UserReaderMBean, GroupReaderMBean, GroupMemberListerMBean, MemberGroupListerMBean, UserPasswordEditorMBean, GroupMembershipHierarchyCacheMBean

This MBean contains attributes for the LDAP servers supported by the LDAP Authentication providers. Subinterfaces of this MBean override default values specific to an LDAP server.Deprecation of MBeanHome and Type-Safe InterfacesThis 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. For more information, see "Developing Manageable Applications with JMX" on http://www.oracle.com/technology/documentation/index.html.

Method Summary
`String`	`getAllGroupsFilter()` An LDAP search filter for finding all groups beneath the base group distinguished name (DN).
`String`	`getAllUsersFilter()` An LDAP search filter for finding all users beneath the base user distinguished name (DN).
`String`	`getDescription()` A short description of the LDAP Authentication provider.
`String`	`getDynamicGroupNameAttribute()` The attribute of a dynamic LDAP group object that specifies the name of the group.
`String`	`getDynamicGroupObjectClass()` The LDAP object class that stores dynamic groups.
`String`	`getDynamicMemberURLAttribute()` The attribute of the dynamic LDAP group object that specifies the URLs of the members of the dynamic group.
`String`	`getGroupBaseDN()` The base distinguished name (DN) of the tree in the LDAP directory that contains groups.
`String`	`getGroupFromNameFilter()` An LDAP search filter for finding a group given the name of the group.
`String`	`getGroupMembershipSearching()` Specifies whether recursive group membership searching is unlimited or limited.
`String`	`getGroupSearchScope()` Specifies how deep in the LDAP directory tree to search for groups.
`Boolean`	`getIgnoreDuplicateMembership()` Determines whether duplicate members are ignored when adding groups.
`Integer`	`getMaxGroupMembershipSearchLevel()` Specifies how many levels of group membership can be searched.
`String`	`getName()` The name of this configuration.
`String`	`getProviderClassName()` The name of the Java class used to load the LDAP Authentication provider.
`String`	`getStaticGroupDNsfromMemberDNFilter()` An LDAP search filter that, given the distinguished name (DN) of a member of a group, returns the DNs of the static LDAP broups that contain that member.
`String`	`getStaticGroupNameAttribute()` The attribute of a static LDAP group object that specifies the name of the group.
`String`	`getStaticGroupObjectClass()` The name of the LDAP object class that stores static groups.
`String`	`getStaticMemberDNAttribute()` The attribute of a static LDAP group object that specifies the distinguished names (DNs) of the members of the group.
`String`	`getUserBaseDN()` The base distinguished name (DN) of the tree in the LDAP directory that contains users.
`String`	`getUserDynamicGroupDNAttribute()` The attribute of an LDAP user object that specifies the distinguished names (DNs) of dynamic groups to which this user belongs.
`Boolean`	`getUseRetrievedUserNameAsPrincipal()` Specifies whether or not the user name retrieved from LDAP should be used as the Principal in the Subject.
`String`	`getUserFromNameFilter()` An LDAP search filter for finding a user given the name of the user.
`String`	`getUserNameAttribute()` The attribute of an LDAP user object that specifies the name of the user.
`String`	`getUserObjectClass()` The LDAP object class that stores users.
`String`	`getUserSearchScope()` Specifies how deep in the LDAP directory tree to search for Users.
`String`	`getVersion()` The version number of the LDAP Authentication provider.
`void`	`setAllGroupsFilter(String newValue)` An LDAP search filter for finding all groups beneath the base group distinguished name (DN).
`void`	`setAllUsersFilter(String newValue)` An LDAP search filter for finding all users beneath the base user distinguished name (DN).
`void`	`setDynamicGroupNameAttribute(String newValue)` The attribute of a dynamic LDAP group object that specifies the name of the group.
`void`	`setDynamicGroupObjectClass(String newValue)` The LDAP object class that stores dynamic groups.
`void`	`setDynamicMemberURLAttribute(String newValue)` The attribute of the dynamic LDAP group object that specifies the URLs of the members of the dynamic group.
`void`	`setGroupBaseDN(String newValue)` The base distinguished name (DN) of the tree in the LDAP directory that contains groups.
`void`	`setGroupFromNameFilter(String newValue)` An LDAP search filter for finding a group given the name of the group.
`void`	`setGroupMembershipSearching(String newValue)` Specifies whether recursive group membership searching is unlimited or limited.
`void`	`setGroupSearchScope(String newValue)` Specifies how deep in the LDAP directory tree to search for groups.
`void`	`setIgnoreDuplicateMembership(Boolean newValue)` Determines whether duplicate members are ignored when adding groups.
`void`	`setMaxGroupMembershipSearchLevel(Integer newValue)` Specifies how many levels of group membership can be searched.
`void`	`setStaticGroupDNsfromMemberDNFilter(String newValue)` An LDAP search filter that, given the distinguished name (DN) of a member of a group, returns the DNs of the static LDAP broups that contain that member.
`void`	`setStaticGroupNameAttribute(String newValue)` The attribute of a static LDAP group object that specifies the name of the group.
`void`	`setStaticGroupObjectClass(String newValue)` The name of the LDAP object class that stores static groups.
`void`	`setStaticMemberDNAttribute(String newValue)` The attribute of a static LDAP group object that specifies the distinguished names (DNs) of the members of the group.
`void`	`setUserBaseDN(String newValue)` The base distinguished name (DN) of the tree in the LDAP directory that contains users.
`void`	`setUserDynamicGroupDNAttribute(String newValue)` The attribute of an LDAP user object that specifies the distinguished names (DNs) of dynamic groups to which this user belongs.
`void`	`setUseRetrievedUserNameAsPrincipal(Boolean newValue)` Specifies whether or not the user name retrieved from LDAP should be used as the Principal in the Subject.
`void`	`setUserFromNameFilter(String newValue)` An LDAP search filter for finding a user given the name of the user.
`void`	`setUserNameAttribute(String newValue)` The attribute of an LDAP user object that specifies the name of the user.
`void`	`setUserObjectClass(String newValue)` The LDAP object class that stores users.
`void`	`setUserSearchScope(String newValue)` Specifies how deep in the LDAP directory tree to search for Users.

Methods inherited from interface weblogic.management.commo.StandardInterface

setName, wls_getDisplayName, wls_getInterfaceClassName, wls_getObjectName

Methods inherited from interface weblogic.descriptor.DescriptorBean

addBeanUpdateListener, addPropertyChangeListener, createChildCopy, createChildCopyIncludingObsolete, getDescriptor, getParentBean, isEditable, removeBeanUpdateListener, removePropertyChangeListener

Methods inherited from interface weblogic.descriptor.SettableBean

isSet, unSet

Methods inherited from interface weblogic.security.providers.authentication.LoginExceptionPropagatorMBean

getPropagateCauseForLoginException, setPropagateCauseForLoginException

Methods inherited from interface weblogic.management.security.authentication.AuthenticatorMBean

getControlFlag, setControlFlag

Methods inherited from interface weblogic.management.security.ProviderMBean

getRealm

Methods inherited from interface weblogic.management.utils.LDAPServerMBean

getCacheSize, getCacheTTL, getConnectionRetryLimit, getConnectTimeout, getCredential, getCredentialEncrypted, getHost, getParallelConnectDelay, getPort, getPrincipal, getResultsTimeLimit, isBindAnonymouslyOnReferrals, isCacheEnabled, isFollowReferrals, isSSLEnabled, setBindAnonymouslyOnReferrals, setCacheEnabled, setCacheSize, setCacheTTL, setConnectionRetryLimit, setConnectTimeout, setCredential, setCredentialEncrypted, setFollowReferrals, setHost, setParallelConnectDelay, setPort, setPrincipal, setResultsTimeLimit, setSSLEnabled

Methods inherited from interface weblogic.management.security.authentication.UserReaderMBean

getUserDescription, listUsers, userExists

Methods inherited from interface weblogic.management.utils.NameListerMBean

getCurrentName

Methods inherited from interface weblogic.management.utils.ListerMBean

advance, close, haveCurrent

Methods inherited from interface weblogic.management.security.authentication.GroupReaderMBean

getGroupDescription, groupExists, isMember, listGroups

Methods inherited from interface weblogic.management.security.authentication.GroupMemberListerMBean

listGroupMembers

Methods inherited from interface weblogic.management.security.authentication.MemberGroupListerMBean

listMemberGroups

Methods inherited from interface weblogic.management.security.authentication.UserPasswordEditorMBean

changeUserPassword, resetUserPassword

Methods inherited from interface weblogic.management.security.authentication.GroupMembershipHierarchyCacheMBean

getEnableGroupMembershipLookupHierarchyCaching, getGroupHierarchyCacheTTL, getMaxGroupHierarchiesInCache, setEnableGroupMembershipLookupHierarchyCaching, setGroupHierarchyCacheTTL, setMaxGroupHierarchiesInCache

Method Detail

getAllGroupsFilter

public String getAllGroupsFilter()

An LDAP search filter for finding all groups beneath the base group distinguished name (DN). If the attribute is not specified (that is, if the attribute is null or empty), a default search filter is created based on the Group schema.

A dynamic MBean attribute.: false

getAllUsersFilter

public String getAllUsersFilter()

An LDAP search filter for finding all users beneath the base user distinguished name (DN). If the attribute (user object class) is not specified (that is, if the attribute is null or empty), a default search filter is created based on the user schema.

A dynamic MBean attribute.: false

getDescription

public String getDescription()

A short description of the LDAP Authentication provider.

Specified by:: getDescription in interface ProviderMBean

Default value:: "Provider that performs LDAP authentication"
A dynamic MBean attribute.: false
A non-configurable MBean attribute.

getDynamicGroupNameAttribute

public String getDynamicGroupNameAttribute()

The attribute of a dynamic LDAP group object that specifies the name of the group.

A dynamic MBean attribute.: false

getDynamicGroupObjectClass

public String getDynamicGroupObjectClass()

The LDAP object class that stores dynamic groups.

A dynamic MBean attribute.: false

getDynamicMemberURLAttribute

public String getDynamicMemberURLAttribute()

The attribute of the dynamic LDAP group object that specifies the URLs of the members of the dynamic group.

A dynamic MBean attribute.: false

getGroupBaseDN

public String getGroupBaseDN()

The base distinguished name (DN) of the tree in the LDAP directory that contains groups.

Default value:: "ou=groups, o=example.com"
A dynamic MBean attribute.: false

getGroupFromNameFilter

public String getGroupFromNameFilter()

An LDAP search filter for finding a group given the name of the group. If the attribute is not specified (that is, if the attribute is null or empty), a default search filter is created based on the group schema.

Default value:: "(&(cn=%g)(objectclass=groupofuniquenames))"
A dynamic MBean attribute.: false

getGroupMembershipSearching

public String getGroupMembershipSearching()

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

Default value:: "unlimited"
Legal values:: "unlimited","limited"
A dynamic MBean attribute.: false

getGroupSearchScope

public String getGroupSearchScope()

Specifies how deep in the LDAP directory tree to search for groups. Valid values are subtree and onelevel.

Default value:: "subtree"
Legal values:: "subtree","onelevel"
A dynamic MBean attribute.: false

getIgnoreDuplicateMembership

public Boolean getIgnoreDuplicateMembership()

Determines whether duplicate members are ignored when adding groups. The attribute cycles in the Group membership.

Default value:: new Boolean(false)
A dynamic MBean attribute.: false

getMaxGroupMembershipSearchLevel

public 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 integers. For example, 0 indicates only direct group memberships will be found, aa positive number indicates the number of levels to search.

Default value:: new Integer(0)
A dynamic MBean attribute.: false

getName

public 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 weblogic.management.commo.StandardInterface

Default value:: "LDAPAuthenticator"
A dynamic MBean attribute.: false

getProviderClassName

public String getProviderClassName()

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

Specified by:: getProviderClassName in interface ProviderMBean

Default value:: "weblogic.security.providers.authentication.LDAPAuthenticationProviderImpl"
A dynamic MBean attribute.: false
A non-configurable MBean attribute.
Excluded: Should not appear in public javadocs
Internal: Should not appear in public javadocs

getStaticGroupDNsfromMemberDNFilter

public String getStaticGroupDNsfromMemberDNFilter()

An LDAP search filter that, given the distinguished name (DN) of a member of a group, returns the DNs of the static LDAP broups that contain that member. If the attribute is not specified (that is, if the attribute is null or empty), a default search filter is created based on the group schema.

Default value:: "(&(uniquemember=%M)(objectclass=groupofuniquenames))"
A dynamic MBean attribute.: false

getStaticGroupNameAttribute

public String getStaticGroupNameAttribute()

The attribute of a static LDAP group object that specifies the name of the group.

Default value:: "cn"
A dynamic MBean attribute.: false

getStaticGroupObjectClass

public String getStaticGroupObjectClass()

The name of the LDAP object class that stores static groups.

Default value:: "groupofuniquenames"
A dynamic MBean attribute.: false

getStaticMemberDNAttribute

public String getStaticMemberDNAttribute()

The attribute of a static LDAP group object that specifies the distinguished names (DNs) of the members of the group.

Default value:: "uniquemember"
A dynamic MBean attribute.: false

getUserBaseDN

public String getUserBaseDN()

The base distinguished name (DN) of the tree in the LDAP directory that contains users.

Default value:: "ou=people, o=example.com"
A dynamic MBean attribute.: false

getUserDynamicGroupDNAttribute

public String getUserDynamicGroupDNAttribute()

The attribute of an LDAP user object that specifies the distinguished names (DNs) of dynamic groups to which this user belongs. If such an attribute does not exist, WebLogic Server determines if a user is a member of a group by evaluating the URLs on the dynamic group. If a group contains other groups, WebLogic Server evaluates the URLs on any of the descendents (indicates parent relationship) of the group.

A dynamic MBean attribute.: false

getUseRetrievedUserNameAsPrincipal

public Boolean getUseRetrievedUserNameAsPrincipal()

Specifies whether or not the user name retrieved from LDAP should be used as the Principal in the Subject.

Default value:: new Boolean(false)
A dynamic MBean attribute.: false

getUserFromNameFilter

public String getUserFromNameFilter()

An LDAP search filter for finding a user given the name of the user. If the attribute (user name attribute and user object class) is not specified (that is, if the attribute is null or empty), a default search filter is created based on the user schema.

Default value:: "(&(uid=%u)(objectclass=person))"
A dynamic MBean attribute.: false

getUserNameAttribute

public String getUserNameAttribute()

The attribute of an LDAP user object that specifies the name of the user.

Default value:: "uid"
A dynamic MBean attribute.: false

getUserObjectClass

public String getUserObjectClass()

The LDAP object class that stores users.

Default value:: "person"
A dynamic MBean attribute.: false

getUserSearchScope

public String getUserSearchScope()

Specifies how deep in the LDAP directory tree to search for Users. Valid values are subtree and onelevel.

Default value:: "subtree"
Legal values:: "subtree","onelevel"
A dynamic MBean attribute.: false

getVersion

public String getVersion()

The version number of the LDAP Authentication provider.

Specified by:: getVersion in interface ProviderMBean

Default value:: "1.0"
A dynamic MBean attribute.: false
A non-configurable MBean attribute.

setAllGroupsFilter

public void setAllGroupsFilter(String newValue)
                        throws InvalidAttributeValueException

Parameters:: newValue - - new value for attribute AllGroupsFilter
Throws:: InvalidAttributeValueException
A dynamic MBean attribute.: false

setAllUsersFilter

public void setAllUsersFilter(String newValue)
                       throws InvalidAttributeValueException

Parameters:: newValue - - new value for attribute AllUsersFilter
Throws:: InvalidAttributeValueException
A dynamic MBean attribute.: false

setDynamicGroupNameAttribute

public void setDynamicGroupNameAttribute(String newValue)
                                  throws InvalidAttributeValueException