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 OpenLDAPAuthenticatorMBean

All Superinterfaces:

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

public interface OpenLDAPAuthenticatorMBean

extends weblogic.management.commo.StandardInterface, weblogic.descriptor.DescriptorBean, LDAPAuthenticatorMBean

This MBean specifies the LDAP schema definitions for the Open LDAP Authentication provider.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.

Copyright © 2005 BEA Systems, Inc. All Rights Reserved.

Method Summary

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	getName() The name of this configuration.
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	getStaticGroupObjectClass() The name of the LDAP object class that stores static groups.
String	getStaticMemberDNAttribute() The attribute of an LDAP static 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	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.
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	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	setStaticGroupObjectClass(String newValue) The name of the LDAP object class that stores static groups.
void	setStaticMemberDNAttribute(String newValue) The attribute of an LDAP static 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	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.

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.LDAPAuthenticatorMBean

getAllGroupsFilter, getAllUsersFilter, getDescription, getDynamicGroupNameAttribute, getDynamicGroupObjectClass, getDynamicMemberURLAttribute, getGroupMembershipSearching, getGroupSearchScope, getIgnoreDuplicateMembership, getMaxGroupMembershipSearchLevel, getProviderClassName, getStaticGroupNameAttribute, getUserDynamicGroupDNAttribute, getUseRetrievedUserNameAsPrincipal, getUserObjectClass, getUserSearchScope, getVersion, setAllGroupsFilter, setAllUsersFilter, setDynamicGroupNameAttribute, setDynamicGroupObjectClass, setDynamicMemberURLAttribute, setGroupMembershipSearching, setGroupSearchScope, setIgnoreDuplicateMembership, setMaxGroupMembershipSearchLevel, setStaticGroupNameAttribute, setUserDynamicGroupDNAttribute, setUseRetrievedUserNameAsPrincipal, setUserObjectClass, setUserSearchScope

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

getGroupBaseDN

public String getGroupBaseDN()

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

Specified by:

getGroupBaseDN in interface LDAPAuthenticatorMBean

Default value:

"ou=groups, dc=example, dc=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.

Specified by:

getGroupFromNameFilter in interface LDAPAuthenticatorMBean

Default value:

"(&(cn=%g)(objectclass=groupofnames))"

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:

"OpenLDAPAuthenticator"

A dynamic MBean attribute.

false

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.

Specified by:

getStaticGroupDNsfromMemberDNFilter in interface LDAPAuthenticatorMBean

Default value:

"(&(member=%M)(objectclass=groupofnames))"

A dynamic MBean attribute.

false

getStaticGroupObjectClass

public String getStaticGroupObjectClass()

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

Specified by:

getStaticGroupObjectClass in interface LDAPAuthenticatorMBean

Default value:

"groupofnames"

A dynamic MBean attribute.

false

getStaticMemberDNAttribute

public String getStaticMemberDNAttribute()

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

Specified by:

getStaticMemberDNAttribute in interface LDAPAuthenticatorMBean

Default value:

"member"

A dynamic MBean attribute.

false

getUserBaseDN

public String getUserBaseDN()

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

Specified by:

getUserBaseDN in interface LDAPAuthenticatorMBean

Default value:

"ou=people, dc=example, dc=com"

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.

Specified by:

getUserFromNameFilter in interface LDAPAuthenticatorMBean

Default value:

"(&(cn=%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.

Specified by:

getUserNameAttribute in interface LDAPAuthenticatorMBean

Default value:

"cn"

A dynamic MBean attribute.

false

setGroupBaseDN

public void setGroupBaseDN(String newValue)
                    throws InvalidAttributeValueException

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

Specified by:

setGroupBaseDN in interface LDAPAuthenticatorMBean

Parameters:

newValue - - new value for attribute GroupBaseDN

Throws:

InvalidAttributeValueException

Default value:

"ou=groups, dc=example, dc=com"

A dynamic MBean attribute.

false

setGroupFromNameFilter

public void setGroupFromNameFilter(String newValue)
                            throws InvalidAttributeValueException

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.

Specified by:

setGroupFromNameFilter in interface LDAPAuthenticatorMBean

Parameters:

newValue - - new value for attribute GroupFromNameFilter

Throws:

InvalidAttributeValueException

Default value:

"(&(cn=%g)(objectclass=groupofnames))"

A dynamic MBean attribute.

false

setStaticGroupDNsfromMemberDNFilter

public void setStaticGroupDNsfromMemberDNFilter(String newValue)
                                         throws InvalidAttributeValueException

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.

Specified by:

setStaticGroupDNsfromMemberDNFilter in interface LDAPAuthenticatorMBean

Parameters:

newValue - - new value for attribute StaticGroupDNsfromMemberDNFilter

Throws:

InvalidAttributeValueException

Default value:

"(&(member=%M)(objectclass=groupofnames))"

A dynamic MBean attribute.

false

setStaticGroupObjectClass

public void setStaticGroupObjectClass(String newValue)
                               throws InvalidAttributeValueException

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

Specified by:

setStaticGroupObjectClass in interface LDAPAuthenticatorMBean

Parameters:

newValue - - new value for attribute StaticGroupObjectClass

Throws:

InvalidAttributeValueException

Default value:

"groupofnames"

A dynamic MBean attribute.

false

setStaticMemberDNAttribute

public void setStaticMemberDNAttribute(String newValue)
                                throws InvalidAttributeValueException

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

Specified by:

setStaticMemberDNAttribute in interface LDAPAuthenticatorMBean

Parameters:

newValue - - new value for attribute StaticMemberDNAttribute

Throws:

InvalidAttributeValueException

Default value:

"member"

A dynamic MBean attribute.

false

setUserBaseDN

public void setUserBaseDN(String newValue)
                   throws InvalidAttributeValueException

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

Specified by:

setUserBaseDN in interface LDAPAuthenticatorMBean

Parameters:

newValue - - new value for attribute UserBaseDN

Throws:

InvalidAttributeValueException

Default value:

"ou=people, dc=example, dc=com"

A dynamic MBean attribute.

false

setUserFromNameFilter

public void setUserFromNameFilter(String newValue)
                           throws InvalidAttributeValueException

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.

Specified by:

setUserFromNameFilter in interface LDAPAuthenticatorMBean

Parameters:

newValue - - new value for attribute UserFromNameFilter

Throws:

InvalidAttributeValueException

Default value:

"(&(cn=%u)(objectclass=person))"

A dynamic MBean attribute.

false

setUserNameAttribute

public void setUserNameAttribute(String newValue)
                          throws InvalidAttributeValueException

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

Specified by:

setUserNameAttribute in interface LDAPAuthenticatorMBean

Parameters:

newValue - - new value for attribute UserNameAttribute

Throws:

InvalidAttributeValueException

Default value:

"cn"

A dynamic MBean attribute.

false