weblogic.security.providers.authentication
Interface OpenLDAPAuthenticatorMBean

All Superinterfaces:

AuthenticationProviderMBean, AuthenticatorMBean, GroupMemberListerMBean, GroupMembershipHierarchyCacheMBean, GroupReaderMBean, LDAPAuthenticatorMBean, LDAPServerMBean, ListerMBean, LoginExceptionPropagatorMBean, MemberGroupListerMBean, NameListerMBean, ProviderMBean, UserPasswordEditorMBean, UserReaderMBean

public interface OpenLDAPAuthenticatorMBean
extends LDAPAuthenticatorMBean

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

getUserNameAttribute

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"

setUserNameAttribute

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"

getUserBaseDN

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"

setUserBaseDN

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"

getUserFromNameFilter

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))"

setUserFromNameFilter

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))"

getGroupBaseDN

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"

setGroupBaseDN

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"

getGroupFromNameFilter

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))"

setGroupFromNameFilter

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))"

getStaticGroupObjectClass

String getStaticGroupObjectClass()

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

Specified by:

getStaticGroupObjectClass in interface LDAPAuthenticatorMBean

Default Value:

"groupofnames"

setStaticGroupObjectClass

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"

getStaticMemberDNAttribute

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"

setStaticMemberDNAttribute

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"

getStaticGroupDNsfromMemberDNFilter

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))"

setStaticGroupDNsfromMemberDNFilter

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))"

getGuidAttribute

String getGuidAttribute()

Specifies the name of the GUID attribute defined in the OpenLDAP Directory Services LDAP server. The default value is entryuuid.

Specified by:

getGuidAttribute in interface LDAPAuthenticatorMBean

Default Value:

"entryuuid"

setGuidAttribute

void setGuidAttribute(String newValue)
                      throws InvalidAttributeValueException

Specifies the name of the GUID attribute defined in the OpenLDAP Directory Services LDAP server. The default value is entryuuid.

Specified by:

setGuidAttribute in interface LDAPAuthenticatorMBean

Parameters:

newValue - - new value for attribute GuidAttribute

Throws:

InvalidAttributeValueException

Default Value:

"entryuuid"

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 LDAPAuthenticatorMBean

Specified by:

getName in interface LoginExceptionPropagatorMBean

Specified by:

getName in interface ProviderMBean

Default Value:

"OpenLDAPAuthenticator"