weblogic.management.security.authentication

Interface UserAttributeReaderMBean

All Superinterfaces:

DescriptorBean, SettableBean, StandardInterface

All Known Subinterfaces:

UserAttributeEditorMBean

public interface UserAttributeReaderMBean
extends StandardInterface, DescriptorBean

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.

Method Summary

Modifier and Type	Method and Description
java.lang.String[]	getSupportedUserAttributeNames() Provides a list of supported user attribute names for the provider.
javax.management.openmbean.OpenType	getSupportedUserAttributeType(java.lang.String userAttributeName) Returns the user attribute type
java.lang.Object	getUserAttributeValue(java.lang.String userName, java.lang.String userAttributeName) Gets a user attribute value for a user.
boolean	isUserAttributeNameSupported(java.lang.String userAttributeName) Checks if a user attribute is supported.

Methods inherited from interface weblogic.management.commo.StandardInterface

getName, 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

Method Detail

getSupportedUserAttributeNames

java.lang.String[] getSupportedUserAttributeNames()

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

Returns:

String array containing supported user attribute names

Changes to this property take effect after you redeploy the module or restart the server. If the resource is in a partition, restart the partition.

isUserAttributeNameSupported

boolean isUserAttributeNameSupported(java.lang.String userAttributeName)
                              throws InvalidParameterException

Checks if a user attribute is supported.

Parameters:

userAttributeName - User attribute name

Returns:

true if user attribute name is supported, false otherwise

Throws:

InvalidParameterException - - if user attribute name is null

getSupportedUserAttributeType

javax.management.openmbean.OpenType getSupportedUserAttributeType(java.lang.String userAttributeName)
                                                           throws InvalidParameterException

Returns the user attribute type

Parameters:

userAttributeName - User attribute name

Returns:

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

Throws:

InvalidParameterException - - if attribute name is not supported

getUserAttributeValue

java.lang.Object getUserAttributeValue(java.lang.String userName,
                                       java.lang.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