Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
Oracle Fusion Middleware
Oracle WebLogic Server 10.3.1 MBean API Reference
11g Release 1 (10.3.1)

Part Number E13945-01
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

weblogic.security.providers.authentication
Interface IPlanetAuthenticatorMBean

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

This MBean represents LDAP schema definitions for the iPlanet 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 getDynamicGroupNameAttribute()
          The attribute of the 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 getGroupFromNameFilter()
          An LDAP search filter for finding a group given the name of the group.
 String getName()
          The name of this configuration.
 String getStaticMemberDNAttribute()
          The attribute of an LDAP static group object that specifies the distinguished names (DNs) of the members of the group.
 void setDynamicGroupNameAttribute(String newValue)
          The attribute of the 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 setGroupFromNameFilter(String newValue)
          An LDAP search filter for finding a group given the name of the group.
 void setStaticMemberDNAttribute(String newValue)
          The attribute of an LDAP static group object that specifies the distinguished names (DNs) of the members of the group.
 
Methods inherited from interface weblogic.security.providers.authentication.LDAPAuthenticatorMBean
getAllGroupsFilter, getAllUsersFilter, getCredential, getCredentialEncrypted, getDescription, getGroupBaseDN, getGroupMembershipSearching, getGroupSearchScope, getIgnoreDuplicateMembership, getMaxGroupMembershipSearchLevel, getProviderClassName, getStaticGroupDNsfromMemberDNFilter, getStaticGroupNameAttribute, getStaticGroupObjectClass, getUserBaseDN, getUserDynamicGroupDNAttribute, getUseRetrievedUserNameAsPrincipal, getUserFromNameFilter, getUserNameAttribute, getUserObjectClass, getUserSearchScope, getVersion, isKeepAliveEnabled, setAllGroupsFilter, setAllUsersFilter, setCredential, setCredentialEncrypted, setGroupBaseDN, setGroupMembershipSearching, setGroupSearchScope, setIgnoreDuplicateMembership, setKeepAliveEnabled, setMaxGroupMembershipSearchLevel, setStaticGroupDNsfromMemberDNFilter, setStaticGroupNameAttribute, setStaticGroupObjectClass, setUserBaseDN, setUserDynamicGroupDNAttribute, setUseRetrievedUserNameAsPrincipal, setUserFromNameFilter, setUserNameAttribute, 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, 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.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
getEnableGroupMembershipLookupHierarchyCaching, getGroupHierarchyCacheTTL, getMaxGroupHierarchiesInCache, setEnableGroupMembershipLookupHierarchyCaching, setGroupHierarchyCacheTTL, setMaxGroupHierarchiesInCache
 

Method Detail

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=groupofUniqueNames))(&(cn=%g)(objectclass=groupOfURLs)))"

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=groupofUniqueNames))(&(cn=%g)(objectclass=groupOfURLs)))"

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

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

getDynamicGroupObjectClass

String getDynamicGroupObjectClass()

The LDAP object class that stores dynamic groups.

Specified by:
getDynamicGroupObjectClass in interface LDAPAuthenticatorMBean
Default Value:
"groupofURLs"

setDynamicGroupObjectClass

void setDynamicGroupObjectClass(String newValue)
                                throws InvalidAttributeValueException

The LDAP object class that stores dynamic groups.

Specified by:
setDynamicGroupObjectClass in interface LDAPAuthenticatorMBean
Parameters:
newValue - - new value for attribute DynamicGroupObjectClass
Throws:
InvalidAttributeValueException
Default Value:
"groupofURLs"

getDynamicGroupNameAttribute

String getDynamicGroupNameAttribute()

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

Specified by:
getDynamicGroupNameAttribute in interface LDAPAuthenticatorMBean
Default Value:
"cn"

setDynamicGroupNameAttribute

void setDynamicGroupNameAttribute(String newValue)
                                  throws InvalidAttributeValueException

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

Specified by:
setDynamicGroupNameAttribute in interface LDAPAuthenticatorMBean
Parameters:
newValue - - new value for attribute DynamicGroupNameAttribute
Throws:
InvalidAttributeValueException
Default Value:
"cn"

getDynamicMemberURLAttribute

String getDynamicMemberURLAttribute()

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

Specified by:
getDynamicMemberURLAttribute in interface LDAPAuthenticatorMBean
Default Value:
"memberURL"

setDynamicMemberURLAttribute

void setDynamicMemberURLAttribute(String newValue)
                                  throws InvalidAttributeValueException

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

Specified by:
setDynamicMemberURLAttribute in interface LDAPAuthenticatorMBean
Parameters:
newValue - - new value for attribute DynamicMemberURLAttribute
Throws:
InvalidAttributeValueException
Default Value:
"memberURL"

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:
"IPlanetAuthenticator"
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
Documentation is available at
http://download.oracle.com/docs/cd/E12839_01/web.1111/wls.htm
Copyright 1996, 2009, 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 10.3.1 MBean API Reference
11g Release 1 (10.3.1)

Part Number E13945-01
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD