BEA Systems, Inc.

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 CustomDBMSAuthenticatorMBean

All Superinterfaces:
AuthenticationProviderMBean, AuthenticatorMBean, DBMSAuthenticatorMBean, weblogic.descriptor.DescriptorBean, GroupMembershipHierarchyCacheMBean, ProviderMBean, weblogic.descriptor.SettableBean, weblogic.management.commo.StandardInterface

public interface CustomDBMSAuthenticatorMBean
extends weblogic.management.commo.StandardInterface, weblogic.descriptor.DescriptorBean, DBMSAuthenticatorMBean

The MBean that represents configuration information for the Custom DBMS 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.

Copyright © 2005 BEA Systems, Inc. All Rights Reserved.

Method Summary
 String getName()
          The name of this configuration.
 String getPluginClassName()
          Specifies the name of a class that implements the weblogic.security.providers.authentication.CustomDBMSAuthenticatorPlugin interface.
 Properties getPluginProperties()
          Defines configuration properties for the specified plug-in class.
 String getProviderClassName()
          The name of the Java class for the Custom DBMS Authentication provider.
 void setPluginClassName(String newValue)
          Specifies the name of a class that implements the weblogic.security.providers.authentication.CustomDBMSAuthenticatorPlugin interface.
 void setPluginProperties(Properties newValue)
          Defines configuration properties for the specified plug-in class.
 
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
 

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:
"CustomDBMSAuthenticator"
A dynamic MBean attribute.
false

getPluginClassName

public String getPluginClassName()
Specifies the name of a class that implements the weblogic.security.providers.authentication.CustomDBMSAuthenticatorPlugin interface. The class must exist in the CLASSPATH. Required. No default value.

A dynamic MBean attribute.
true

getPluginProperties

public Properties getPluginProperties()
Defines configuration properties for the specified plug-in class. The property names are defined by the plug-in class. Optional. No default value.

A dynamic MBean attribute.
true

getProviderClassName

public String getProviderClassName()
The name of the Java class for the Custom DBMS Authentication provider.

Specified by:
getProviderClassName in interface DBMSAuthenticatorMBean
Default value:
"weblogic.security.providers.authentication.DBMSPluggableRuntimeAuthenticationProviderImpl"
A dynamic MBean attribute.
false
A non-configurable MBean attribute.

setPluginClassName

public void setPluginClassName(String newValue)
                        throws InvalidAttributeValueException
Specifies the name of a class that implements the weblogic.security.providers.authentication.CustomDBMSAuthenticatorPlugin interface. The class must exist in the CLASSPATH. Required. No default value.

Parameters:
newValue - - new value for attribute PluginClassName
Throws:
InvalidAttributeValueException
A dynamic MBean attribute.
true

setPluginProperties

public void setPluginProperties(Properties newValue)
                         throws InvalidAttributeValueException
Defines configuration properties for the specified plug-in class. The property names are defined by the plug-in class. Optional. No default value.

Parameters:
newValue - - new value for attribute PluginProperties
Throws:
InvalidAttributeValueException
A dynamic MBean attribute.
true

Documentation is available at
http://download.oracle.com/docs/cd/E13222_01/wls/docs90
Copyright 2005 BEA Systems Inc.