|
Oracle Fusion Middleware Oracle WebLogic Server MBean Javadoc 11g Release 1 (10.3.3) Part Number E13945-03 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface DefaultAuthenticatorMBean
The MBean that represents configuration attributes for the WebLogic Authentication provider. The WebLogic Authentication provider has methods to edit, list, and manage users, groups, and group membership. User and group information is stored in an embedded LDAP server.
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 |
getDescription()
A short description of the Authentication provider. |
Boolean |
getEnableGroupMembershipLookupHierarchyCaching()
Sets whether to cache group membership hierarchies found during recursive membership lookup. |
String |
getGroupMembershipSearching()
Specifies whether recursive group membership searching is unlimited or limited. |
Integer |
getMaxGroupMembershipSearchLevel()
Specifies how many levels of group membership can be searched. |
int |
getMinimumPasswordLength()
The minimum number of characters required in a password. |
String |
getName()
The name of this configuration. |
String |
getProviderClassName()
The name of the Java class used to load the Authentication provider. |
String[] |
getSupportedExportConstraints()
The users and groups that you want to be exported from this Authentication provider's database. |
String[] |
getSupportedExportFormats()
The format of the file to export. |
String[] |
getSupportedImportConstraints()
The users and groups that you want to be imported into this Authentication provider's database. |
String[] |
getSupportedImportFormats()
The format of the file to import. |
Boolean |
getUseRetrievedUserNameAsPrincipal()
Specifies whether to use the user name retrieved from LDAP as the Principal in the Subject. |
String |
getVersion()
The version number of the Authentication provider. |
boolean |
isKeepAliveEnabled()
Specifies whether to prevent LDAP connections from timing out. |
boolean |
isPasswordDigestEnabled()
Enables the storage of password information required to support Web Services Security Password Digest and other digest authentication algorithms. |
void |
setEnableGroupMembershipLookupHierarchyCaching(Boolean newValue)
Sets whether to cache group membership hierarchies found during recursive membership lookup. |
void |
setGroupMembershipSearching(String newValue)
Specifies whether recursive group membership searching is unlimited or limited. |
void |
setKeepAliveEnabled(boolean newValue)
Specifies whether to prevent LDAP connections from timing out. |
void |
setMaxGroupMembershipSearchLevel(Integer newValue)
Specifies how many levels of group membership can be searched. |
void |
setMinimumPasswordLength(int newValue)
The minimum number of characters required in a password. |
void |
setPasswordDigestEnabled(boolean newValue)
Enables the storage of password information required to support Web Services Security Password Digest and other digest authentication algorithms. |
void |
setUseRetrievedUserNameAsPrincipal(Boolean newValue)
Specifies whether to use the user name retrieved from LDAP as the Principal in the Subject. |
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.security.authentication.UserEditorMBean |
---|
createUser, setUserDescription |
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.UserPasswordEditorMBean |
---|
changeUserPassword, resetUserPassword |
Methods inherited from interface weblogic.management.security.authentication.UserRemoverMBean |
---|
removeUser |
Methods inherited from interface weblogic.management.security.authentication.GroupEditorMBean |
---|
addMemberToGroup, createGroup, removeMemberFromGroup, setGroupDescription |
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.GroupRemoverMBean |
---|
removeGroup |
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.GroupUserListerMBean |
---|
listAllUsersInGroup |
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.ImportMBean |
---|
importData |
Methods inherited from interface weblogic.management.security.ExportMBean |
---|
exportData |
Methods inherited from interface weblogic.management.security.authentication.GroupMembershipHierarchyCacheMBean |
---|
getGroupHierarchyCacheTTL, getMaxGroupHierarchiesInCache, setGroupHierarchyCacheTTL, setMaxGroupHierarchiesInCache |
Methods inherited from interface weblogic.management.security.authentication.UserAttributeEditorMBean |
---|
setUserAttributeValue |
Methods inherited from interface weblogic.management.security.authentication.UserAttributeReaderMBean |
---|
getSupportedUserAttributeNames, getSupportedUserAttributeType, getUserAttributeValue, isUserAttributeNameSupported |
Method Detail |
---|
String getProviderClassName()
The name of the Java class used to load the Authentication provider.
String getDescription()
A short description of the Authentication provider.
getDescription
in interface ProviderMBean
String getVersion()
The version number of the Authentication provider.
getVersion
in interface ProviderMBean
int getMinimumPasswordLength()
The minimum number of characters required in a password.
void setMinimumPasswordLength(int newValue) throws InvalidAttributeValueException
The minimum number of characters required in a password.
newValue
- - new value for attribute MinimumPasswordLength
InvalidAttributeValueException
String[] getSupportedImportFormats()
The format of the file to import. The list of supported import formats is determined by the Authentication provider from which the users and groups were originally exported.
getSupportedImportFormats
in interface ImportMBean
String[] getSupportedImportConstraints()
The users and groups that you want to be imported into this Authentication provider's database. If no constraints are specified, all are imported.
getSupportedImportConstraints
in interface ImportMBean
String[] getSupportedExportFormats()
The format of the file to export. The list of supported export formats is determined by this Authentication provider.
getSupportedExportFormats
in interface ExportMBean
String[] getSupportedExportConstraints()
The users and groups that you want to be exported from this Authentication provider's database. If none are specified, all are exported. If EnablePasswordDigestInformation is set to true, then 2- way encrypted passwords can be exported via the passwords=cleartext constraint.
getSupportedExportConstraints
in interface ExportMBean
String getGroupMembershipSearching()
Specifies whether recursive group membership searching is unlimited or limited. Valid values are unlimited
and limited
.
void setGroupMembershipSearching(String newValue) throws InvalidAttributeValueException
Specifies whether recursive group membership searching is unlimited or limited. Valid values are unlimited
and limited
.
newValue
- - new value for attribute GroupMembershipSearching
InvalidAttributeValueException
Integer getMaxGroupMembershipSearchLevel()
Specifies how many levels of group membership can be searched. This setting is valid only if GroupMembershipSearching is set to limited.
Valid values are 0, and positive numbers. For example, 0 indicates only direct group memberships will be found, a positive number indicates the number of levels to go down.
void setMaxGroupMembershipSearchLevel(Integer newValue) throws InvalidAttributeValueException
Specifies how many levels of group membership can be searched. This setting is valid only if GroupMembershipSearching is set to limited.
Valid values are 0, and positive numbers. For example, 0 indicates only direct group memberships will be found, a positive number indicates the number of levels to go down.
newValue
- - new value for attribute MaxGroupMembershipSearchLevel
InvalidAttributeValueException
Boolean getUseRetrievedUserNameAsPrincipal()
Specifies whether to use the user name retrieved from LDAP as the Principal in the Subject.
void setUseRetrievedUserNameAsPrincipal(Boolean newValue) throws InvalidAttributeValueException
Specifies whether to use the user name retrieved from LDAP as the Principal in the Subject.
newValue
- - new value for attribute UseRetrievedUserNameAsPrincipal
InvalidAttributeValueException
boolean isPasswordDigestEnabled()
Enables the storage of password information required to support Web Services Security Password Digest and other digest authentication algorithms. If set to true
, the WebLogic Authentication provider stores the user password in a 2-way encrypted form. The original password can then be retrieved and used for digest authentication.
void setPasswordDigestEnabled(boolean newValue) throws InvalidAttributeValueException
Enables the storage of password information required to support Web Services Security Password Digest and other digest authentication algorithms. If set to true
, the WebLogic Authentication provider stores the user password in a 2-way encrypted form. The original password can then be retrieved and used for digest authentication.
newValue
- - new value for attribute PasswordDigestEnabled
InvalidAttributeValueException
boolean isKeepAliveEnabled()
Specifies whether to prevent LDAP connections from timing out.
void setKeepAliveEnabled(boolean newValue) throws InvalidAttributeValueException
Specifies whether to prevent LDAP connections from timing out.
newValue
- - new value for attribute KeepAliveEnabled
InvalidAttributeValueException
Boolean getEnableGroupMembershipLookupHierarchyCaching()
Sets whether to cache group membership hierarchies found during recursive membership lookup. If true, each subtree found will be cached. This overwrites the default value defined in GroupMembershipHierarchyCacheMBean.
getEnableGroupMembershipLookupHierarchyCaching
in interface GroupMembershipHierarchyCacheMBean
void setEnableGroupMembershipLookupHierarchyCaching(Boolean newValue) throws InvalidAttributeValueException
Sets whether to cache group membership hierarchies found during recursive membership lookup. If true, each subtree found will be cached. This overwrites the default value defined in GroupMembershipHierarchyCacheMBean.
setEnableGroupMembershipLookupHierarchyCaching
in interface GroupMembershipHierarchyCacheMBean
newValue
- - new value for attribute EnableGroupMembershipLookupHierarchyCaching
InvalidAttributeValueException
GroupMembershipHierarchyCacheMBean.getEnableGroupMembershipLookupHierarchyCaching()
String getName()
ProviderMBean
getName
in interface LoginExceptionPropagatorMBean
getName
in interface ProviderMBean
|
Copyright 1996, 2010, 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.3) Part Number E13945-03 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |