SQLAuthenticatorMBean (BEA WebLogic Server 9.0 API Reference)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

BEA Systems, Inc.

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

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

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

weblogic.security.providers.authentication
Interface SQLAuthenticatorMBean

All Superinterfaces:: AuthenticationProviderMBean, AuthenticatorMBean, DBMSAuthenticatorMBean, weblogic.descriptor.DescriptorBean, GroupEditorMBean, GroupMemberListerMBean, GroupMembershipHierarchyCacheMBean, GroupReaderMBean, GroupRemoverMBean, ListerMBean, MemberGroupListerMBean, NameListerMBean, ProviderMBean, ReadOnlySQLAuthenticatorMBean, weblogic.descriptor.SettableBean, weblogic.management.commo.StandardInterface, UserEditorMBean, UserPasswordEditorMBean, UserReaderMBean, UserRemoverMBean

public interface SQLAuthenticatorMBean
extends weblogic.management.commo.StandardInterface, weblogic.descriptor.DescriptorBean, ReadOnlySQLAuthenticatorMBean, GroupMemberListerMBean, MemberGroupListerMBean, UserPasswordEditorMBean, UserEditorMBean, GroupEditorMBean

This MBean contains configuration information for the SQL Authentication Provider.Deprecation of MBeanHome and Type-Safe InterfacesThis 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
`String`	`getName()` The name of this configuration.
`String`	`getPasswordAlgorithm()` The message digest algorithm used to hash passwords for storage.
`String`	`getPasswordStyle()` Indicates the password style that is used when storing passwords for users that are created and for changing the user's password if Password Style Retained is disabled.
`String`	`getProviderClassName()` The name of the Java class for the SQL Authentication provider.
`String`	`getSQLAddMemberToGroup()` The SQL statement used to add a specific member to a group.
`String`	`getSQLCreateGroup()` The SQL statement requirements depend on the value of Descriptions Supported.
`String`	`getSQLCreateUser()` The SQL statement used to create a new user record The SQL statement requirements depend on the value of Descriptions Supported.
`String`	`getSQLListGroupMembers()` The SQL statement used to list groups that have a group name with a list of wildcarded member names.
`String`	`getSQLRemoveGroup()` The SQL statement used to remove a member from a group.
`String`	`getSQLRemoveGroupMember()` The SQL statement used to remove a member from a group.
`String`	`getSQLRemoveGroupMemberships()` The SQL statement used to delete a group member (either a user or group) from all groups to which it belongs.
`String`	`getSQLRemoveMemberFromGroup()` The SQL statement used to remove a member from a group.
`String`	`getSQLRemoveUser()` The SQL statement used for deleting a user.
`String`	`getSQLSetGroupDescription()` The SQL statement used to specify a description for a group.
`String`	`getSQLSetUserDescription()` The SQL statement used to specify description for a user.
`String`	`getSQLSetUserPassword()` The SQL statement used to set the password for a user.
`boolean`	`isPasswordStyleRetained()` Controls how a password is stored in the database when updating an existing user's password.
`void`	`setPasswordAlgorithm(String newValue)` The message digest algorithm used to hash passwords for storage.
`void`	`setPasswordStyle(String newValue)` Indicates the password style that is used when storing passwords for users that are created and for changing the user's password if Password Style Retained is disabled.
`void`	`setPasswordStyleRetained(boolean newValue)` Controls how a password is stored in the database when updating an existing user's password.
`void`	`setSQLAddMemberToGroup(String newValue)` The SQL statement used to add a specific member to a group.
`void`	`setSQLCreateGroup(String newValue)` The SQL statement requirements depend on the value of Descriptions Supported.
`void`	`setSQLCreateUser(String newValue)` The SQL statement used to create a new user record The SQL statement requirements depend on the value of Descriptions Supported.
`void`	`setSQLListGroupMembers(String newValue)` The SQL statement used to list groups that have a group name with a list of wildcarded member names.
`void`	`setSQLRemoveGroup(String newValue)` The SQL statement used to remove a member from a group.
`void`	`setSQLRemoveGroupMember(String newValue)` The SQL statement used to remove a member from a group.
`void`	`setSQLRemoveGroupMemberships(String newValue)` The SQL statement used to delete a group member (either a user or group) from all groups to which it belongs.
`void`	`setSQLRemoveMemberFromGroup(String newValue)` The SQL statement used to remove a member from a group.
`void`	`setSQLRemoveUser(String newValue)` The SQL statement used for deleting a user.
`void`	`setSQLSetGroupDescription(String newValue)` The SQL statement used to specify a description for a group.
`void`	`setSQLSetUserDescription(String newValue)` The SQL statement used to specify description for a user.
`void`	`setSQLSetUserPassword(String newValue)` The SQL statement used to set the password for a user.

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.ReadOnlySQLAuthenticatorMBean

getDescriptionsSupported, getSQLGetGroupDescription, getSQLGetUserDescription, getSQLGetUsersPassword, getSQLGroupExists, getSQLIsMember, getSQLListGroups, getSQLListMemberGroups, getSQLListUsers, getSQLUserExists, setDescriptionsSupported, setSQLGetGroupDescription, setSQLGetUserDescription, setSQLGetUsersPassword, setSQLGroupExists, setSQLIsMember, setSQLListGroups, setSQLListMemberGroups, setSQLListUsers, setSQLUserExists

Methods inherited from interface weblogic.security.providers.authentication.DBMSAuthenticatorMBean

getDataSourceName, getDescription, getGroupMembershipSearching, getMaxGroupMembershipSearchLevel, getVersion, isPlaintextPasswordsEnabled, setDataSourceName, setGroupMembershipSearching, setMaxGroupMembershipSearchLevel, setPlaintextPasswordsEnabled

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.GroupMembershipHierarchyCacheMBean

getEnableGroupMembershipLookupHierarchyCaching, getGroupHierarchyCacheTTL, getMaxGroupHierarchiesInCache, setEnableGroupMembershipLookupHierarchyCaching, setGroupHierarchyCacheTTL, setMaxGroupHierarchiesInCache

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.UserEditorMBean

createUser, setUserDescription

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.GroupRemoverMBean

removeGroup

Method Detail

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

Default value:: "SQLAuthenticator"
A dynamic MBean attribute.: false

getPasswordAlgorithm

public String getPasswordAlgorithm()

The message digest algorithm used to hash passwords for storage. The name must be recognized by a Java Cryptography Extension (JCE) provider that is available at runtime.

Default value:: "SHA-1"
A dynamic MBean attribute.: true

getPasswordStyle

public String getPasswordStyle()

Indicates the password style that is used when storing passwords for users that are created and for changing the user's password if Password Style Retained is disabled.

Default value:: "SALTEDHASHED"
Legal values:: "PLAINTEXT","HASHED","SALTEDHASHED"
A dynamic MBean attribute.: true

getProviderClassName

public String getProviderClassName()

The name of the Java class for the SQL Authentication provider.

Specified by:: getProviderClassName in interface ReadOnlySQLAuthenticatorMBean

Default value:: "weblogic.security.providers.authentication.DBMSSQLAuthenticationProviderImpl"
A dynamic MBean attribute.: false
A non-configurable MBean attribute.

getSQLAddMemberToGroup

public String getSQLAddMemberToGroup()

The SQL statement used to add a specific member to a group. The SQL statement requires two parameters: the group name and the group member being added.

Default value:: "INSERT INTO GROUPMEMBERS VALUES( ?, ?)"
A dynamic MBean attribute.: true

getSQLCreateGroup

public String getSQLCreateGroup()

The SQL statement requirements depend on the value of Descriptions Supported. There is a minimum of one parameter, the group name. If Descriptions Supported is true, the group's description is required. The default SQL is based on the default setting of Descriptions Supported. The setting of Create Group must be updated manually if the setting of Descriptions Supported changes.

Default value:: "INSERT INTO GROUPS VALUES ( ? , ? )"
A dynamic MBean attribute.: true

getSQLCreateUser

public String getSQLCreateUser()

The SQL statement used to create a new user record The SQL statement requirements depend on the value of Descriptions Supported. There are a minimum of two parameters: a username and its associated password. If Descriptions Supported is true, the user's description is required. The default SQL is based on the default setting of Descriptions Supported. The setting of Create User must be updated manually if the setting of Descriptions Supported changes.

Default value:: "INSERT INTO USERS VALUES ( ? , ? , ? )"
A dynamic MBean attribute.: true

getSQLListGroupMembers

public String getSQLListGroupMembers()

The SQL statement used to list groups that have a group name with a list of wildcarded member names. The SQL statement requires two parameters: the group name and the wildcarded member name.

Default value:: "SELECT G_MEMBER FROM GROUPMEMBERS WHERE G_NAME = ? AND G_MEMBER LIKE ?"
A dynamic MBean attribute.: true

getSQLRemoveGroup

public String getSQLRemoveGroup()

The SQL statement used to remove a member from a group. The SQL statement requires a single parameter: the group name being removed.

Default value:: "DELETE FROM GROUPS WHERE G_NAME = ?"
A dynamic MBean attribute.: true

getSQLRemoveGroupMember

public String getSQLRemoveGroupMember()

The SQL statement used to remove a member from a group. The SQL statement requires a single parameter: the username or group name being removed.

Default value:: "DELETE FROM GROUPMEMBERS WHERE G_NAME = ?"
A dynamic MBean attribute.: true

getSQLRemoveGroupMemberships

public String getSQLRemoveGroupMemberships()

The SQL statement used to delete a group member (either a user or group) from all groups to which it belongs. The SQL statement requires 2 parameters.Both parameters refer to the specific username or group name being removed.

Default value:: "DELETE FROM GROUPMEMBERS WHERE G_MEMBER = ? OR G_NAME = ?"
A dynamic MBean attribute.: true

getSQLRemoveMemberFromGroup

public String getSQLRemoveMemberFromGroup()

The SQL statement used to remove a member from a group. The SQL statement requires two parameters: the group name and the group member being deleted from the group.

Default value:: "DELETE FROM GROUPMEMBERS WHERE G_NAME = ? AND G_MEMBER = ?"
A dynamic MBean attribute.: true

getSQLRemoveUser

public String getSQLRemoveUser()

The SQL statement used for deleting a user. The SQL statement requires a single parameter, the username.

Default value:: "DELETE FROM USERS WHERE U_NAME = ?"
A dynamic MBean attribute.: true

getSQLSetGroupDescription

public String getSQLSetGroupDescription()

The SQL statement used to specify a description for a group. Only valid if Descriptions Supported attribute is enabled. The SQL statement requires two parameters: the group description and the group name.

Default value:: "UPDATE GROUPS SET G_DESCRIPTION = ? WHERE G_NAME = ?"
A dynamic MBean attribute.: true

getSQLSetUserDescription

public String getSQLSetUserDescription()

The SQL statement used to specify description for a user. Only valid if Descriptions Supported is true. The SQL statement requires two parameters: the username description and the username.

Default value:: "UPDATE USERS SET U_DESCRIPTION = ? WHERE U_NAME = ?"
A dynamic MBean attribute.: true

getSQLSetUserPassword

public String getSQLSetUserPassword()

The SQL statement used to set the password for a user. The SQL statement requires two parameters: the password for the user and the username.

Default value:: "UPDATE USERS SET U_PASSWORD = ? WHERE U_NAME = ?"
A dynamic MBean attribute.: true

isPasswordStyleRetained

public boolean isPasswordStyleRetained()

Controls how a password is stored in the database when updating an existing user's password. True indicates the password style and algorithm that were in used for the original password in the database should be used for the new password. This setting is the default.False indicates the settings for Password Algorithm and Password Style will be used for the new password.

Default value:: (new java.lang.Boolean(true)).booleanValue()
A dynamic MBean attribute.: true

setPasswordAlgorithm

public void setPasswordAlgorithm(String newValue)
                          throws InvalidAttributeValueException