weblogic.security.providers.authentication
Interface SQLAuthenticatorMBean

All Superinterfaces:

AuthenticationProviderMBean, AuthenticatorMBean, DBMSAuthenticatorMBean, GroupEditorMBean, GroupMemberListerMBean, GroupMembershipHierarchyCacheMBean, GroupReaderMBean, GroupRemoverMBean, ListerMBean, MemberGroupListerMBean, NameListerMBean, ProviderMBean, ReadOnlySQLAuthenticatorMBean, UserEditorMBean, UserPasswordEditorMBean, UserReaderMBean, UserRemoverMBean

public interface SQLAuthenticatorMBean
extends ReadOnlySQLAuthenticatorMBean, GroupMemberListerMBean, MemberGroupListerMBean, UserPasswordEditorMBean, UserEditorMBean, GroupEditorMBean

This MBean contains configuration information for the SQL 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.

getProviderClassName

String getProviderClassName()

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

Specified by:

getProviderClassName in interface DBMSAuthenticatorMBean

Specified by:

getProviderClassName in interface ReadOnlySQLAuthenticatorMBean

Default Value:

"weblogic.security.providers.authentication.DBMSSQLAuthenticationProviderImpl"

getPasswordAlgorithm

String getPasswordAlgorithm()

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

The Java Cryptography Architecture (JCA) defines the standard algorithm specifications, described at http://java.sun.com/javase/6/docs/technotes/guides/security/StandardNames.html#algspec.

Changes take effect after you redeploy the module or restart the server.

Default Value:

"SHA-1"

setPasswordAlgorithm

void setPasswordAlgorithm(String newValue)
                          throws InvalidAttributeValueException

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

The Java Cryptography Architecture (JCA) defines the standard algorithm specifications, described at http://java.sun.com/javase/6/docs/technotes/guides/security/StandardNames.html#algspec.

Parameters:

newValue - - new value for attribute PasswordAlgorithm

Throws:

InvalidAttributeValueException

Changes take effect after you redeploy the module or restart the server.

Default Value:

"SHA-1"

getPasswordStyle

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.

Changes take effect after you redeploy the module or restart the server.

Default Value:

"SALTEDHASHED"

Valid Values:

"PLAINTEXT","HASHED","SALTEDHASHED"

setPasswordStyle

void setPasswordStyle(String newValue)
                      throws InvalidAttributeValueException

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.

Parameters:

newValue - - new value for attribute PasswordStyle

Throws:

InvalidAttributeValueException

Changes take effect after you redeploy the module or restart the server.

Default Value:

"SALTEDHASHED"

Valid Values:

"PLAINTEXT","HASHED","SALTEDHASHED"

isPasswordStyleRetained

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

Changes take effect after you redeploy the module or restart the server.

Default Value:

true

setPasswordStyleRetained

void setPasswordStyleRetained(boolean newValue)
                              throws InvalidAttributeValueException

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

Parameters:

newValue - - new value for attribute PasswordStyleRetained

Throws:

InvalidAttributeValueException

Changes take effect after you redeploy the module or restart the server.

Default Value:

true

getSQLCreateUser

String getSQLCreateUser()

The SQL statement used to create a new user record. The SQL statement requirements depend on the value of Descriptions Supported. There is 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.

Changes take effect after you redeploy the module or restart the server.

Default Value:

"INSERT INTO USERS VALUES ( ? , ? , ? )"

setSQLCreateUser

void setSQLCreateUser(String newValue)
                      throws InvalidAttributeValueException

The SQL statement used to create a new user record. The SQL statement requirements depend on the value of Descriptions Supported. There is 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.

Parameters:

newValue - - new value for attribute SQLCreateUser

Throws:

InvalidAttributeValueException

Changes take effect after you redeploy the module or restart the server.

Default Value:

"INSERT INTO USERS VALUES ( ? , ? , ? )"

getSQLRemoveUser

String getSQLRemoveUser()

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

Changes take effect after you redeploy the module or restart the server.

Default Value:

"DELETE FROM USERS WHERE U_NAME = ?"

setSQLRemoveUser

void setSQLRemoveUser(String newValue)
                      throws InvalidAttributeValueException

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

Parameters:

newValue - - new value for attribute SQLRemoveUser

Throws:

InvalidAttributeValueException

Changes take effect after you redeploy the module or restart the server.

Default Value:

"DELETE FROM USERS WHERE U_NAME = ?"

getSQLRemoveGroupMemberships

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.

Changes take effect after you redeploy the module or restart the server.

Default Value:

"DELETE FROM GROUPMEMBERS WHERE G_MEMBER = ? OR G_NAME = ?"

setSQLRemoveGroupMemberships

void setSQLRemoveGroupMemberships(String newValue)
                                  throws InvalidAttributeValueException

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.

Parameters:

newValue - - new value for attribute SQLRemoveGroupMemberships

Throws:

InvalidAttributeValueException

Changes take effect after you redeploy the module or restart the server.

Default Value:

"DELETE FROM GROUPMEMBERS WHERE G_MEMBER = ? OR G_NAME = ?"

getSQLSetUserDescription

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.

Changes take effect after you redeploy the module or restart the server.

Default Value:

"UPDATE USERS SET U_DESCRIPTION = ? WHERE U_NAME = ?"

setSQLSetUserDescription

void setSQLSetUserDescription(String newValue)
                              throws InvalidAttributeValueException

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.

Parameters:

newValue - - new value for attribute SQLSetUserDescription

Throws:

InvalidAttributeValueException

Changes take effect after you redeploy the module or restart the server.

Default Value:

"UPDATE USERS SET U_DESCRIPTION = ? WHERE U_NAME = ?"

getSQLSetUserPassword

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.

Changes take effect after you redeploy the module or restart the server.

Default Value:

"UPDATE USERS SET U_PASSWORD = ? WHERE U_NAME = ?"

setSQLSetUserPassword

void setSQLSetUserPassword(String newValue)
                           throws InvalidAttributeValueException

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.

Parameters:

newValue - - new value for attribute SQLSetUserPassword

Throws:

InvalidAttributeValueException

Changes take effect after you redeploy the module or restart the server.

Default Value:

"UPDATE USERS SET U_PASSWORD = ? WHERE U_NAME = ?"

getSQLCreateGroup

String getSQLCreateGroup()

The SQL statement used to create a new group. 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.

Changes take effect after you redeploy the module or restart the server.

Default Value:

"INSERT INTO GROUPS VALUES ( ? , ? )"

setSQLCreateGroup

void setSQLCreateGroup(String newValue)
                       throws InvalidAttributeValueException

The SQL statement used to create a new group. 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.

Parameters:

newValue - - new value for attribute SQLCreateGroup

Throws:

InvalidAttributeValueException

Changes take effect after you redeploy the module or restart the server.

Default Value:

"INSERT INTO GROUPS VALUES ( ? , ? )"

getSQLSetGroupDescription

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.

Changes take effect after you redeploy the module or restart the server.

Default Value:

"UPDATE GROUPS SET G_DESCRIPTION = ? WHERE G_NAME = ?"

setSQLSetGroupDescription

void setSQLSetGroupDescription(String newValue)
                               throws InvalidAttributeValueException

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.

Parameters:

newValue - - new value for attribute SQLSetGroupDescription

Throws:

InvalidAttributeValueException

Changes take effect after you redeploy the module or restart the server.

Default Value:

"UPDATE GROUPS SET G_DESCRIPTION = ? WHERE G_NAME = ?"

getSQLAddMemberToGroup

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.

Changes take effect after you redeploy the module or restart the server.

Default Value:

"INSERT INTO GROUPMEMBERS VALUES( ?, ?)"

setSQLAddMemberToGroup

void setSQLAddMemberToGroup(String newValue)
                            throws InvalidAttributeValueException

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.

Parameters:

newValue - - new value for attribute SQLAddMemberToGroup

Throws:

InvalidAttributeValueException

Changes take effect after you redeploy the module or restart the server.

Default Value:

"INSERT INTO GROUPMEMBERS VALUES( ?, ?)"

getSQLRemoveMemberFromGroup

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.

Changes take effect after you redeploy the module or restart the server.

Default Value:

"DELETE FROM GROUPMEMBERS WHERE G_NAME = ? AND G_MEMBER = ?"

setSQLRemoveMemberFromGroup

void setSQLRemoveMemberFromGroup(String newValue)
                                 throws InvalidAttributeValueException

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.

Parameters:

newValue - - new value for attribute SQLRemoveMemberFromGroup

Throws:

InvalidAttributeValueException

Changes take effect after you redeploy the module or restart the server.

Default Value:

"DELETE FROM GROUPMEMBERS WHERE G_NAME = ? AND G_MEMBER = ?"

getSQLRemoveGroup

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.

Changes take effect after you redeploy the module or restart the server.

Default Value:

"DELETE FROM GROUPS WHERE G_NAME = ?"

setSQLRemoveGroup

void setSQLRemoveGroup(String newValue)
                       throws InvalidAttributeValueException

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

Parameters:

newValue - - new value for attribute SQLRemoveGroup

Throws:

InvalidAttributeValueException

Changes take effect after you redeploy the module or restart the server.

Default Value:

"DELETE FROM GROUPS WHERE G_NAME = ?"

getSQLRemoveGroupMember

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.

Changes take effect after you redeploy the module or restart the server.

Default Value:

"DELETE FROM GROUPMEMBERS WHERE G_NAME = ?"

setSQLRemoveGroupMember

void setSQLRemoveGroupMember(String newValue)
                             throws InvalidAttributeValueException

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.

Parameters:

newValue - - new value for attribute SQLRemoveGroupMember

Throws:

InvalidAttributeValueException

Changes take effect after you redeploy the module or restart the server.

Default Value:

"DELETE FROM GROUPMEMBERS WHERE G_NAME = ?"

getSQLListGroupMembers

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.

Changes take effect after you redeploy the module or restart the server.

Default Value:

"SELECT G_MEMBER FROM GROUPMEMBERS WHERE G_NAME = ? AND G_MEMBER LIKE ?"

setSQLListGroupMembers

void setSQLListGroupMembers(String newValue)
                            throws InvalidAttributeValueException

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.

Parameters:

newValue - - new value for attribute SQLListGroupMembers

Throws:

InvalidAttributeValueException

Changes take effect after you redeploy the module or restart the server.

Default Value:

"SELECT G_MEMBER FROM GROUPMEMBERS WHERE G_NAME = ? AND G_MEMBER LIKE ?"

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 DBMSAuthenticatorMBean

Specified by:

getName in interface ProviderMBean

Specified by:

getName in interface ReadOnlySQLAuthenticatorMBean

Default Value:

"SQLAuthenticator"