weblogic.management.security.credentials
Interface UserPasswordCredentialMapReaderMBean

All Superinterfaces:

ListerMBean

All Known Subinterfaces:

UserPasswordCredentialMapEditorMBean, UserPasswordCredentialMapExtendedReaderMBean

public interface UserPasswordCredentialMapReaderMBean
extends ListerMBean

Provides a set of methods for reading credentials and credential mappings. Credential mappings match WebLogic users to remote usernames and passwords. A Credential Mapping-provider MBean can optionally extend this MBean. The WebLogic Server Administration Console detects when a Credential Mapping provider extends this MBean and automatically provides a GUI 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/documentation/index.html.

getRemoteUserName

String getRemoteUserName(String resourceId,
                         String wlsUserName)
                         throws NotFoundException

Gets the external username that is mapped to a local webLogic username for the specified resource.

Parameters:

resourceId - - The resource on which the mapping between the local weblogic user and the remote user was created.

wlsUserName - - The local weblogic username.

Returns:

the remote username.

Throws:

NotFoundException

getRemotePassword

String getRemotePassword(String resourceId,
                         String remoteUserName)
                         throws NotFoundException

Deprecated. 9.0.0.0

Gets the remote password corresponding to the remote username in the credential created for the specified resource. Deprecated in WLS 9.0

Parameters:

resourceId - - The resource for which the credential was created.

remoteUserName - - The external username.

Returns:

the external password.

Throws:

NotFoundException

listCredentials

String listCredentials(String resourceId)

Gets a list of credentials mapped to the resource. Returns a cursor as a string. Use the getCurrentCredentialRemoteUserName and getCurrentCredentialRemotePassword methods to get the username and password for the current item in the list.

Parameters:

resourceId - - The resource for which the credentials are to be returned.

Returns:

a string which is a cursor used to get each credential.

getCurrentCredentialRemoteUserName

String getCurrentCredentialRemoteUserName(String cursor)
                                          throws InvalidCursorException

Gets a remote username from a list that has been returned from the listCredentials method. This method returns the remote username that corresponds to current location in the list.

Parameters:

cursor - - The cursor that has been returned from the listCredentials method.

Returns:

a string which is the current remote user name.

Throws:

InvalidCursorException

getCurrentCredentialRemotePassword

String getCurrentCredentialRemotePassword(String cursor)
                                          throws InvalidCursorException

Deprecated. 9.0.0.0

Gets a password from a list that has been returned from the listCredentials method. This method returns the password that corresponds to current location in the list. Deprecated in WLS 9.0

Parameters:

cursor - - The cursor that has been returned from the listCredentials method.

Returns:

a string which is the current remote user password.

Throws:

InvalidCursorException

listMappings

String listMappings(String resourceId)

Gets a list of credential mappings created for the given resource id. Returns a cursor as a string. Use the getCurrentMappingWLSUserName and getCurrentMappingRemoteUserName methods to return the webLogic username and remote user name for the current item in the list.

Parameters:

resourceId - - The resource for which the credential mappings are to be returned.

Returns:

a string which is a cursor used to get each credential mapping.

getCurrentMappingWLSUserName

String getCurrentMappingWLSUserName(String cursor)
                                    throws InvalidCursorException

Gets a webLogic username from a credentials mapping that has been returned from the listMappings method. This method returns the local webLogic username that corresponds to current location in the list.

Parameters:

cursor - - The cursor that has been returned from the listMappings method.

Returns:

a string which is local weblogic username.

Throws:

InvalidCursorException

getCurrentMappingRemoteUserName

String getCurrentMappingRemoteUserName(String cursor)
                                       throws InvalidCursorException

Gets an remote username from a credentials mapping that has been returned from the listMappings method. This method returns the remote username that corresponds to current location in the list.

Parameters:

cursor - - The cursor that has been returned from the listMappings method.

Returns:

a string which is remote username.

Throws:

InvalidCursorException