weblogic.security.providers.authentication
Interface ReadOnlySQLAuthenticatorMBean

All Superinterfaces:

AuthenticationProviderMBean, AuthenticatorMBean, DBMSAuthenticatorMBean, GroupMembershipHierarchyCacheMBean, GroupReaderMBean, ListerMBean, NameListerMBean, ProviderMBean, UserReaderMBean

All Known Subinterfaces:

SQLAuthenticatorMBean

public interface ReadOnlySQLAuthenticatorMBean
extends DBMSAuthenticatorMBean, UserReaderMBean, GroupReaderMBean

This MBean contains configuration information for the Read-Only 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. For more information, see "Developing Manageable Applications with JMX" on http://edocs.bea.com.

getProviderClassName

String getProviderClassName()

The name of the Java class for the Read-Only DBMS Authentication Provider.

Specified by:

getProviderClassName in interface DBMSAuthenticatorMBean

Default Value:

"weblogic.security.providers.authentication.DBMSSQLReadOnlyAuthenticationProviderImpl"

getDescriptionsSupported

boolean getDescriptionsSupported()

Indicates whether user and group descriptions are supported by the database used by the authentication provider.

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

Default Value:

true

setDescriptionsSupported

void setDescriptionsSupported(boolean newValue)
                              throws InvalidAttributeValueException

Indicates whether user and group descriptions are supported by the database used by the authentication provider.

Parameters:

newValue - - new value for attribute DescriptionsSupported

Throws:

InvalidAttributeValueException

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

Default Value:

true

getSQLGetUsersPassword

String getSQLGetUsersPassword()

The SQL statement used to look up a user's password. The SQL statement requires a single parameter for the username and must return a resultSet containing at most a single record containing the password.

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

Default Value:

"SELECT U_PASSWORD FROM USERS WHERE U_NAME = ?"

setSQLGetUsersPassword

void setSQLGetUsersPassword(String newValue)
                            throws InvalidAttributeValueException

The SQL statement used to look up a user's password. The SQL statement requires a single parameter for the username and must return a resultSet containing at most a single record containing the password.

Parameters:

newValue - - new value for attribute SQLGetUsersPassword

Throws:

InvalidAttributeValueException

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

Default Value:

"SELECT U_PASSWORD FROM USERS WHERE U_NAME = ?"

getSQLUserExists

String getSQLUserExists()

The SQL statement used to look up a user. The SQL statement requires a single parameter for the username and must return a resultSet containing at most a single record containing the user.

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

Default Value:

"SELECT U_NAME FROM USERS WHERE U_NAME = ?"

setSQLUserExists

void setSQLUserExists(String newValue)
                      throws InvalidAttributeValueException

The SQL statement used to look up a user. The SQL statement requires a single parameter for the username and must return a resultSet containing at most a single record containing the user.

Parameters:

newValue - - new value for attribute SQLUserExists

Throws:

InvalidAttributeValueException

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

Default Value:

"SELECT U_NAME FROM USERS WHERE U_NAME = ?"

getSQLListMemberGroups

String getSQLListMemberGroups()

The SQL statement used to look up the groups a user or group is a member of. The SQL statement requires a single parameter for the username or group name and returns a resultSet containing the names of the groups that matched.

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

Default Value:

"SELECT G_NAME FROM GROUPMEMBERS WHERE G_MEMBER = ?"

setSQLListMemberGroups

void setSQLListMemberGroups(String newValue)
                            throws InvalidAttributeValueException

The SQL statement used to look up the groups a user or group is a member of. The SQL statement requires a single parameter for the username or group name and returns a resultSet containing the names of the groups that matched.

Parameters:

newValue - - new value for attribute SQLListMemberGroups

Throws:

InvalidAttributeValueException

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

Default Value:

"SELECT G_NAME FROM GROUPMEMBERS WHERE G_MEMBER = ?"

getSQLListUsers

String getSQLListUsers()

The SQL statement used to retrieve users that match a particular wildcard search The SQL statement requires a single parameter for the wildcarded usernames and returns a resultSet containing matching usernames

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

Default Value:

"SELECT U_NAME FROM USERS WHERE U_NAME LIKE ?"

setSQLListUsers

void setSQLListUsers(String newValue)
                     throws InvalidAttributeValueException

The SQL statement used to retrieve users that match a particular wildcard search The SQL statement requires a single parameter for the wildcarded usernames and returns a resultSet containing matching usernames

Parameters:

newValue - - new value for attribute SQLListUsers

Throws:

InvalidAttributeValueException

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

Default Value:

"SELECT U_NAME FROM USERS WHERE U_NAME LIKE ?"

getSQLGetUserDescription

String getSQLGetUserDescription()

The SQL statement used to retrieve the description of a specific user. Only valid if Descriptions Supported is enabled. The SQL statement requires a single parameter for the username and must return a resultSet containing at most a single record containing the user description.

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

Default Value:

"SELECT U_DESCRIPTION FROM USERS WHERE U_NAME = ?"

setSQLGetUserDescription

void setSQLGetUserDescription(String newValue)
                              throws InvalidAttributeValueException

The SQL statement used to retrieve the description of a specific user. Only valid if Descriptions Supported is enabled. The SQL statement requires a single parameter for the username and must return a resultSet containing at most a single record containing the user description.

Parameters:

newValue - - new value for attribute SQLGetUserDescription

Throws:

InvalidAttributeValueException

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

Default Value:

"SELECT U_DESCRIPTION FROM USERS WHERE U_NAME = ?"

getSQLListGroups

String getSQLListGroups()

The SQL statement used to retrieve group names that match a wildcard The SQL statement requires a single parameter for the wildcarded group name and return a resultSet containing matching group names

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

Default Value:

"SELECT G_NAME FROM GROUPS WHERE G_NAME LIKE ?"

setSQLListGroups

void setSQLListGroups(String newValue)
                      throws InvalidAttributeValueException

The SQL statement used to retrieve group names that match a wildcard The SQL statement requires a single parameter for the wildcarded group name and return a resultSet containing matching group names

Parameters:

newValue - - new value for attribute SQLListGroups

Throws:

InvalidAttributeValueException

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

Default Value:

"SELECT G_NAME FROM GROUPS WHERE G_NAME LIKE ?"

getSQLGroupExists

String getSQLGroupExists()

The SQL statement used to look up a group. The SQL statement requires a single parameter for the group name and must return a resultSet containing at most a single record containing the group

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

Default Value:

"SELECT G_NAME FROM GROUPS WHERE G_NAME = ?"

setSQLGroupExists

void setSQLGroupExists(String newValue)
                       throws InvalidAttributeValueException

The SQL statement used to look up a group. The SQL statement requires a single parameter for the group name and must return a resultSet containing at most a single record containing the group

Parameters:

newValue - - new value for attribute SQLGroupExists

Throws:

InvalidAttributeValueException

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

Default Value:

"SELECT G_NAME FROM GROUPS WHERE G_NAME = ?"

getSQLIsMember

String getSQLIsMember()

The SQL statement used to look up members of a group. The SQL statement requires two parameters: a group name and a member or group name. It must return a resultSet containing the group names that matched

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 = ?"

setSQLIsMember

void setSQLIsMember(String newValue)
                    throws InvalidAttributeValueException

The SQL statement used to look up members of a group. The SQL statement requires two parameters: a group name and a member or group name. It must return a resultSet containing the group names that matched

Parameters:

newValue - - new value for attribute SQLIsMember

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 = ?"

getSQLGetGroupDescription

String getSQLGetGroupDescription()

The SQL statement used to retrieve the description of a group. Only valid if Descriptions Supported is enabled. The SQL statement requires a single parameter for the group name and must return a resultSet containing at most a single record containing the group description.

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

Default Value:

"SELECT G_DESCRIPTION FROM GROUPS WHERE G_NAME = ?"

setSQLGetGroupDescription

void setSQLGetGroupDescription(String newValue)
                               throws InvalidAttributeValueException

The SQL statement used to retrieve the description of a group. Only valid if Descriptions Supported is enabled. The SQL statement requires a single parameter for the group name and must return a resultSet containing at most a single record containing the group description.

Parameters:

newValue - - new value for attribute SQLGetGroupDescription

Throws:

InvalidAttributeValueException

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

Default Value:

"SELECT G_DESCRIPTION FROM GROUPS WHERE G_NAME = ?"

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

Default Value:

"ReadOnlySQLAuthenticator"