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

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

weblogic.security.providers.authentication
Interface ReadOnlySQLAuthenticatorMBean

All Superinterfaces:

AuthenticationProviderMBean, AuthenticatorMBean, DBMSAuthenticatorMBean, weblogic.descriptor.DescriptorBean, GroupMembershipHierarchyCacheMBean, GroupReaderMBean, ListerMBean, NameListerMBean, ProviderMBean, weblogic.descriptor.SettableBean, weblogic.management.commo.StandardInterface, UserReaderMBean

All Known Subinterfaces:

SQLAuthenticatorMBean

public interface ReadOnlySQLAuthenticatorMBean

extends weblogic.management.commo.StandardInterface, weblogic.descriptor.DescriptorBean, 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://www.oracle.com/technology/documentation/index.html.

Method Summary

boolean	getDescriptionsSupported() Indicates whether user and group descriptions are supported by the database used by the authentication provider.
String	getName() The name of this configuration.
String	getProviderClassName() The name of the Java class for the Read-Only DBMS Authentication Provider.
String	getSQLGetGroupDescription() The SQL statement used to retrieve the description of a group.
String	getSQLGetUserDescription() The SQL statement used to retrieve the description of a specific user.
String	getSQLGetUsersPassword() The SQL statement used to look up a user's password.
String	getSQLGroupExists() The SQL statement used to look up a group.
String	getSQLIsMember() The SQL statement used to look up members of a group.
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
String	getSQLListMemberGroups() The SQL statement used to look up the groups a user or group is a member of.
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
String	getSQLUserExists() The SQL statement used to look up a user.
void	setDescriptionsSupported(boolean newValue) Indicates whether user and group descriptions are supported by the database used by the authentication provider.
void	setSQLGetGroupDescription(String newValue) The SQL statement used to retrieve the description of a group.
void	setSQLGetUserDescription(String newValue) The SQL statement used to retrieve the description of a specific user.
void	setSQLGetUsersPassword(String newValue) The SQL statement used to look up a user's password.
void	setSQLGroupExists(String newValue) The SQL statement used to look up a group.
void	setSQLIsMember(String newValue) The SQL statement used to look up members of a group.
void	setSQLListGroups(String newValue) 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
void	setSQLListMemberGroups(String newValue) The SQL statement used to look up the groups a user or group is a member of.
void	setSQLListUsers(String newValue) 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
void	setSQLUserExists(String newValue) The SQL statement used to look up 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.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

Method Detail

getDescriptionsSupported

public boolean getDescriptionsSupported()

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

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

getProviderClassName

public String getProviderClassName()

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

Specified by:

getProviderClassName in interface DBMSAuthenticatorMBean

getSQLGetGroupDescription

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

getSQLGetUserDescription

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

getSQLGetUsersPassword

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

getSQLGroupExists

public 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

getSQLIsMember

public 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

getSQLListGroups

public 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

getSQLListMemberGroups

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

getSQLListUsers

public 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

getSQLUserExists

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

setDescriptionsSupported

public 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

setSQLGetGroupDescription

public 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

setSQLGetUserDescription

public 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

setSQLGetUsersPassword

public 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

setSQLGroupExists

public 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

setSQLIsMember

public 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

setSQLListGroups

public 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

setSQLListMemberGroups

public 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

setSQLListUsers

public 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

setSQLUserExists

public 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