Oracle Fusion Middleware
Oracle WebLogic Server MBean Javadoc
11g Release 1 (10.3.6)

Part Number E13945-06

weblogic.security.providers.authentication
Interface NovellAuthenticatorMBean

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

public interface NovellAuthenticatorMBean
extends LDAPAuthenticatorMBean

This MBean represents the LDAP schema definitions for the Novell NDS LDAP 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.


Method Summary
 String getGroupFromNameFilter()
          An LDAP search filter for finding a group given the name of the group.
 String getGuidAttribute()
          Specifies the name of the GUID attribute defined in the Novell Directory Services LDAP server.
 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 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 setGroupFromNameFilter(String newValue)
          An LDAP search filter for finding a group given the name of the group.
 void setGuidAttribute(String newValue)
          Specifies the name of the GUID attribute defined in the Novell Directory Services LDAP server.
 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 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.security.providers.authentication.LDAPAuthenticatorMBean
getAllGroupsFilter, getAllUsersFilter, getCredential, getCredentialEncrypted, getDescription, getDynamicGroupNameAttribute, getDynamicGroupObjectClass, getDynamicMemberURLAttribute, getEnableGroupMembershipLookupHierarchyCaching, getGroupBaseDN, getGroupMembershipSearching, getGroupSearchScope, getIgnoreDuplicateMembership, getMaxGroupMembershipSearchLevel, getProviderClassName, getStaticGroupNameAttribute, getStaticMemberDNAttribute, getUserBaseDN, getUserDynamicGroupDNAttribute, getUseRetrievedUserNameAsPrincipal, getUserObjectClass, getUserSearchScope, getVersion, isKeepAliveEnabled, setAllGroupsFilter, setAllUsersFilter, setCredential, setCredentialEncrypted, setDynamicGroupNameAttribute, setDynamicGroupObjectClass, setDynamicMemberURLAttribute, setEnableGroupMembershipLookupHierarchyCaching, setGroupBaseDN, setGroupMembershipSearching, setGroupSearchScope, setIgnoreDuplicateMembership, setKeepAliveEnabled, setMaxGroupMembershipSearchLevel, setStaticGroupNameAttribute, setStaticMemberDNAttribute, setUserBaseDN, 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, getConnectionPoolSize, getConnectionRetryLimit, getConnectTimeout, getHost, getParallelConnectDelay, getPort, getPrincipal, getResultsTimeLimit, isBindAnonymouslyOnReferrals, isCacheEnabled, isFollowReferrals, isSSLEnabled, setBindAnonymouslyOnReferrals, setCacheEnabled, setCacheSize, setCacheTTL, setConnectionPoolSize, 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.utils.NameListerMBean
getCurrentName
 
Methods inherited from interface weblogic.management.utils.ListerMBean
advance, close, haveCurrent
 
Methods inherited from interface weblogic.management.security.authentication.GroupMemberListerMBean
listGroupMembers
 
Methods inherited from interface weblogic.management.security.authentication.GroupReaderMBean
getGroupDescription, groupExists, isMember, listGroups
 
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.MemberGroupListerMBean
listMemberGroups
 
Methods inherited from interface weblogic.management.security.authentication.GroupReaderMBean
getGroupDescription, groupExists, isMember, listGroups
 
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.UserPasswordEditorMBean
changeUserPassword, resetUserPassword
 
Methods inherited from interface weblogic.management.security.authentication.GroupMembershipHierarchyCacheMBean
getGroupHierarchyCacheTTL, getMaxGroupHierarchiesInCache, setGroupHierarchyCacheTTL, setMaxGroupHierarchiesInCache
 

Method Detail

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"

getUserFromNameFilter

String getUserFromNameFilter()

An LDAP search filter for finding a user given the name of the user. If the attribute 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 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))"

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"

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. 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:
getStaticGroupDNsfromMemberDNFilter in interface LDAPAuthenticatorMBean
Default Value:
"(&(uniquemember=%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. 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:
setStaticGroupDNsfromMemberDNFilter in interface LDAPAuthenticatorMBean
Parameters:
newValue - - new value for attribute StaticGroupDNsfromMemberDNFilter
Throws:
InvalidAttributeValueException
Default Value:
"(&(uniquemember=%M)(objectclass=groupofnames))"

getGuidAttribute

String getGuidAttribute()

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

Specified by:
getGuidAttribute in interface LDAPAuthenticatorMBean
Default Value:
"guid"

setGuidAttribute

void setGuidAttribute(String newValue)
                      throws InvalidAttributeValueException

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

Specified by:
setGuidAttribute in interface LDAPAuthenticatorMBean
Parameters:
newValue - - new value for attribute GuidAttribute
Throws:
InvalidAttributeValueException
Default Value:
"guid"

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:
"NovellAuthenticator"

Copyright 1996, 2011, Oracle and/or its affiliates. All rights reserved. Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners.

Oracle Fusion Middleware
Oracle WebLogic Server MBean Javadoc
11g Release 1 (10.3.6)

Part Number E13945-06