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

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

weblogic.security.providers.authentication
Interface ActiveDirectoryAuthenticatorMBean

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 ActiveDirectoryAuthenticatorMBean

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

The MBean that represents LDAP schema definitions for the Active Directory LDAP Authentication provider.

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. For more information, see "Developing Manageable Applications with JMX" on http://www.oracle.com/technology/documentation/index.html.

Method Summary

Boolean	getEnableSIDtoGroupLookupCaching() Boolean value that indicates whether SID to group name lookup results are cached or not.
String	getGroupBaseDN() The attribute of an LDAP user object that specifies the Distinguished Names (DNs) of dynamic groups to which the user belongs.
String	getGroupFromNameFilter() LDAP search filter for finding a group given the name of the group.
Integer	getMaxSIDToGroupLookupsInCache() The maximum size of the LRU cache for holding SID to group lookups if caching of SID to group name mappings is enabled and if the tokenGroups group membership lookup is enabled.
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 groups that contain that member.
String	getStaticGroupObjectClass() The name of the LDAP object class that stores static groups.
String	getStaticMemberDNAttribute() The attribute of the 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 that user.
String	getUserNameAttribute() The attribute of an LDAP user object that specifies the name of the user.
String	getUserObjectClass() The name of the LDAP object class that stores users.
Boolean	getUseTokenGroupsForGroupMembershipLookup() Boolean value that indicates whether to use TokenGroups attribute lookup algorithm instead of the standard recursive group membership lookup algorithm.
void	setEnableSIDtoGroupLookupCaching(Boolean newValue) Boolean value that indicates whether SID to group name lookup results are cached or not.
void	setGroupBaseDN(String newValue) The attribute of an LDAP user object that specifies the Distinguished Names (DNs) of dynamic groups to which the user belongs.
void	setGroupFromNameFilter(String newValue) LDAP search filter for finding a group given the name of the group.
void	setMaxSIDToGroupLookupsInCache(Integer newValue) The maximum size of the LRU cache for holding SID to group lookups if caching of SID to group name mappings is enabled and if the tokenGroups group membership lookup is enabled.
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 groups 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 the 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 that user.
void	setUserNameAttribute(String newValue) The attribute of an LDAP user object that specifies the name of the user.
void	setUserObjectClass(String newValue) The name of the LDAP object class that stores users.
void	setUseTokenGroupsForGroupMembershipLookup(Boolean newValue) Boolean value that indicates whether to use TokenGroups attribute lookup algorithm instead of the standard recursive group membership lookup algorithm.

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, getCredential, getCredentialEncrypted, getDescription, getDynamicGroupNameAttribute, getDynamicGroupObjectClass, getDynamicMemberURLAttribute, getGroupMembershipSearching, getGroupSearchScope, getIgnoreDuplicateMembership, getMaxGroupMembershipSearchLevel, getProviderClassName, getStaticGroupNameAttribute, getUserDynamicGroupDNAttribute, getUseRetrievedUserNameAsPrincipal, getUserSearchScope, getVersion, isKeepAliveEnabled, setAllGroupsFilter, setAllUsersFilter, setCredential, setCredentialEncrypted, setDynamicGroupNameAttribute, setDynamicGroupObjectClass, setDynamicMemberURLAttribute, setGroupMembershipSearching, setGroupSearchScope, setIgnoreDuplicateMembership, setKeepAliveEnabled, setMaxGroupMembershipSearchLevel, setStaticGroupNameAttribute, setUserDynamicGroupDNAttribute, setUseRetrievedUserNameAsPrincipal, 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, getHost, getParallelConnectDelay, getPort, getPrincipal, getResultsTimeLimit, isBindAnonymouslyOnReferrals, isCacheEnabled, isFollowReferrals, isSSLEnabled, setBindAnonymouslyOnReferrals, setCacheEnabled, setCacheSize, setCacheTTL, setConnectionRetryLimit, setConnectTimeout, 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

getEnableSIDtoGroupLookupCaching

public Boolean getEnableSIDtoGroupLookupCaching()

Boolean value that indicates whether SID to group name lookup results are cached or not. This is only used if the token group membership lookup algorithm is enabled.

getGroupBaseDN

public String getGroupBaseDN()

The attribute of an LDAP user object that specifies the Distinguished Names (DNs) of dynamic groups to which the user belongs.

Specified by:

getGroupBaseDN in interface LDAPAuthenticatorMBean

getGroupFromNameFilter

public String getGroupFromNameFilter()

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

getMaxSIDToGroupLookupsInCache

public Integer getMaxSIDToGroupLookupsInCache()

The maximum size of the LRU cache for holding SID to group lookups if caching of SID to group name mappings is enabled and if the tokenGroups group membership lookup is enabled. The default is 500.

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

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 groups that contain that member.

Specified by:

getStaticGroupDNsfromMemberDNFilter in interface LDAPAuthenticatorMBean

getStaticGroupObjectClass

public String getStaticGroupObjectClass()

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

Specified by:

getStaticGroupObjectClass in interface LDAPAuthenticatorMBean

getStaticMemberDNAttribute

public String getStaticMemberDNAttribute()

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

Specified by:

getStaticMemberDNAttribute in interface LDAPAuthenticatorMBean

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

getUserFromNameFilter

public String getUserFromNameFilter()

An LDAP search filter for finding a user, given the name of that user. If a filter is not specified, a default search filter is created based on the user schema.

Specified by:

getUserFromNameFilter in interface LDAPAuthenticatorMBean

getUserNameAttribute

public String getUserNameAttribute()

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

Specified by:

getUserNameAttribute in interface LDAPAuthenticatorMBean

getUserObjectClass

public String getUserObjectClass()

The name of the LDAP object class that stores users.

Specified by:

getUserObjectClass in interface LDAPAuthenticatorMBean

getUseTokenGroupsForGroupMembershipLookup

public Boolean getUseTokenGroupsForGroupMembershipLookup()

Boolean value that indicates whether to use TokenGroups attribute lookup algorithm instead of the standard recursive group membership lookup algorithm.

setEnableSIDtoGroupLookupCaching

public void setEnableSIDtoGroupLookupCaching(Boolean newValue)
                                      throws InvalidAttributeValueException

Boolean value that indicates whether SID to group name lookup results are cached or not. This is only used if the token group membership lookup algorithm is enabled.

Parameters:

newValue - - new value for attribute EnableSIDtoGroupLookupCaching

Throws:

InvalidAttributeValueException

setGroupBaseDN

public void setGroupBaseDN(String newValue)
                    throws InvalidAttributeValueException

The attribute of an LDAP user object that specifies the Distinguished Names (DNs) of dynamic groups to which the user belongs.

Specified by:

setGroupBaseDN in interface LDAPAuthenticatorMBean

Parameters:

newValue - - new value for attribute GroupBaseDN

Throws:

InvalidAttributeValueException

setGroupFromNameFilter

public void setGroupFromNameFilter(String newValue)
                            throws InvalidAttributeValueException

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

setMaxSIDToGroupLookupsInCache

public void setMaxSIDToGroupLookupsInCache(Integer newValue)
                                    throws InvalidAttributeValueException

The maximum size of the LRU cache for holding SID to group lookups if caching of SID to group name mappings is enabled and if the tokenGroups group membership lookup is enabled. The default is 500.

Parameters:

newValue - - new value for attribute MaxSIDToGroupLookupsInCache

Throws:

InvalidAttributeValueException

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 groups that contain that member.

Specified by:

setStaticGroupDNsfromMemberDNFilter in interface LDAPAuthenticatorMBean

Parameters:

newValue - - new value for attribute StaticGroupDNsfromMemberDNFilter

Throws:

InvalidAttributeValueException

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

setStaticMemberDNAttribute

public void setStaticMemberDNAttribute(String newValue)
                                throws InvalidAttributeValueException

The attribute of the 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

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

setUserFromNameFilter

public void setUserFromNameFilter(String newValue)
                           throws InvalidAttributeValueException

An LDAP search filter for finding a user, given the name of that user. If a filter is not specified, 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

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

setUserObjectClass

public void setUserObjectClass(String newValue)
                        throws InvalidAttributeValueException

The name of the LDAP object class that stores users.

Specified by:

setUserObjectClass in interface LDAPAuthenticatorMBean

Parameters:

newValue - - new value for attribute UserObjectClass

Throws:

InvalidAttributeValueException

setUseTokenGroupsForGroupMembershipLookup

public void setUseTokenGroupsForGroupMembershipLookup(Boolean newValue)
                                               throws InvalidAttributeValueException

Boolean value that indicates whether to use TokenGroups attribute lookup algorithm instead of the standard recursive group membership lookup algorithm.

Parameters:

newValue - - new value for attribute UseTokenGroupsForGroupMembershipLookup

Throws:

InvalidAttributeValueException