weblogic.management.security.authentication
Interface UserAttributeReaderMBean

All Known Subinterfaces:

DefaultAuthenticatorMBean, UserAttributeEditorMBean

public interface UserAttributeReaderMBean

Provides a set of methods for getting a list of supported users attributes and their types. Methods are also provided to get user attribute values. An Authentication provider MBean can optionally implement this MBean. The WebLogic Server Administration Console detects when an Authentication provider implements this MBean and automatically provides a tab for using these methods.

Deprecation of MBeanHome and Type-Safe Interfaces

In addition to being used as a base class that provides functionality to security provider MBeans, JMX applications can use this class directly as a type-safe interface. When used as a type-safe interface, a JMX application imports this class and accesses it through weblogic.management.MBeanHome. As of 9.0, the MBeanHome interface and all type-safe interfaces for WebLogic Server MBeans are deprecated. Instead, JMX applications 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/products/weblogic/index.html.

getSupportedUserAttributeNames

String[] getSupportedUserAttributeNames()

Provides a list of supported user attribute names for the provider.

Returns:

String array containing supported user attribute names

isUserAttributeNameSupported

boolean isUserAttributeNameSupported(String userAttributeName)
                                     throws InvalidParameterException

Checks if a user attribute is supported.

Parameters:

User - attribute name

Returns:

true if user attribute name is supported, false otherwise

Throws:

InvalidParameterException - - if user attribute name is null

getSupportedUserAttributeType

OpenType getSupportedUserAttributeType(String userAttributeName)
                                       throws InvalidParameterException

Returns the user attribute type

Parameters:

User - attribute name

Returns:

User attribute type in OpenType format (e.g SimpleType.STRING)

Throws:

InvalidParameterException - - if attribute name is not supported

getUserAttributeValue

Object getUserAttributeValue(String userName,
                             String userAttributeName)
                             throws NotFoundException,
                                    InvalidParameterException

Gets a user attribute value for a user. If the user attribute is unset,a null would be returned.

Parameters:

userName - - The name of an existing user.

userAttributeName - - The name of an existing attribute

Returns:

user attribute value or null

Throws:

NotFoundException - - if user is not found

InvalidParameterException - - if attribute name is not supported