UserAttributeReaderMBean (Java API Reference for Oracle WebLogic Server)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Oracle Fusion Middleware
Java API Reference for Oracle WebLogic Server
12c (12.1.2)

Part Number E27170-01

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

weblogic.management.security.authentication
Interface UserAttributeReaderMBean

All Superinterfaces:: DescriptorBean, SettableBean, StandardInterface

All Known Subinterfaces:: DefaultAuthenticatorMBean, UserAttributeEditorMBean

public interface UserAttributeReaderMBean
extends StandardInterface, DescriptorBean
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
`String[]`	`getSupportedUserAttributeNames()` Provides a list of supported user attribute names for the provider.
`OpenType`	`getSupportedUserAttributeType(String userAttributeName)` Returns the user attribute type
`Object`	`getUserAttributeValue(String userName, String userAttributeName)` Gets a user attribute value for a user.
`boolean`	`isUserAttributeNameSupported(String userAttributeName)` Checks if a user attribute is supported.

Methods inherited from interface weblogic.management.commo.StandardInterface
`getName`

Methods inherited from interface weblogic.descriptor.DescriptorBean
`addPropertyChangeListener, createChildCopyIncludingObsolete, getParentBean, isEditable, removePropertyChangeListener`

Methods inherited from interface weblogic.descriptor.SettableBean
`isSet, unSet`

Method Detail

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:: userAttributeName - 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:: userAttributeName - 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