# UserPasswordCredentialMapEditorMBean (Abstract)

Overview | Related MBeans | Attributes | Operations

## Overview

Provides a set of methods for creating, editing, and removing a credential map that matches WebLogic users to remote usernames and their corresponding 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.

Fully Qualified Interface Name | If you use the `getMBeanInfo` operation in MBeanTypeServiceMBean, supply the following value as this MBean's fully qualified interface name: `weblogic.management.security.credentials.UserPasswordCredentialMapEditorMBean`
Factory Methods | No factory methods. Instances of this MBean are created automatically.
Subtypes | The following MBeans extend or implement this MBean type:
DefaultCredentialMapperMBean |

## Operations

This section describes the following operations:

advance close getCurrentCredentialRemotePassword getCurrentCredentialRemoteUserName getCurrentMappingRemoteUserName getCurrentMappingWLSUserName getRemotePassword getRemoteUserName haveCurrent | listCredentials listMappings removeUserPasswordCredential removeUserPasswordCredentialMapping setUserPasswordCredential setUserPasswordCredentialMapping wls_getDisplayName

### advance

Advances the list to the next element in the list.

Operation Name | `"advance"`
Parameters | `Object [] { cursor }` where: `cursor` is an object of type `java.lang.String` that specifies: - The cursor returned from a previous list method.
Signature | `String [] { "java.lang.String" }`
Returns | `void`
Exceptions | `weblogic.management.utils.InvalidCursorException`

### close

Indicates that the caller is finished using the list, and that the resources held on behalf of the list may be released. If the caller traverses through all the elements in the list, the caller need not call this method. In other words, it is used to let the caller close the list without reading each element that is returned.

Operation Name | `"close"`
Parameters | `Object [] { cursor }` where: `cursor` is an object of type `java.lang.String` that specifies: - The cursor returned from a previous list method.
Signature | `String [] { "java.lang.String" }`
Returns | `void`
Exceptions | `weblogic.management.utils.InvalidCursorException`

### getCurrentCredentialRemotePassword

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

Deprecated. 9.0.0.0

Operation Name | `"getCurrentCredentialRemotePassword"`
Parameters | `Object [] { cursor }` where: `cursor` is an object of type `java.lang.String` that specifies: - The cursor that has been returned from the `listCredentials` method.
Signature | `String [] { "java.lang.String" }`
Returns | `String`
Exceptions | `weblogic.management.utils.InvalidCursorException`

### getCurrentCredentialRemoteUserName

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.

Operation Name | `"getCurrentCredentialRemoteUserName"`
Parameters | `Object [] { cursor }` where: `cursor` is an object of type `java.lang.String` that specifies: - The cursor that has been returned from the `listCredentials` method.
Signature | `String [] { "java.lang.String" }`
Returns | `String`
Exceptions | `weblogic.management.utils.InvalidCursorException`

### getCurrentMappingRemoteUserName

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.

Operation Name | `"getCurrentMappingRemoteUserName"`
Parameters | `Object [] { cursor }` where: `cursor` is an object of type `java.lang.String` that specifies: - The cursor that has been returned from the `listMappings` method.
Signature | `String [] { "java.lang.String" }`
Returns | `String`
Exceptions | `weblogic.management.utils.InvalidCursorException`

### getCurrentMappingWLSUserName

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.

Operation Name | `"getCurrentMappingWLSUserName"`
Parameters | `Object [] { cursor }` where: `cursor` is an object of type `java.lang.String` that specifies: - The cursor that has been returned from the `listMappings` method.
Signature | `String [] { "java.lang.String" }`
Returns | `String`
Exceptions | `weblogic.management.utils.InvalidCursorException`

### getRemotePassword

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

Deprecated. 9.0.0.0

Operation Name | `"getRemotePassword"`
Parameters | `Object [] { resourceId, remoteUserName }` where: `resourceId` is an object of type `java.lang.String` that specifies: - The resource for which the credential was created. `remoteUserName` is an object of type `java.lang.String` that specifies: - The external username.
Signature | `String [] { "java.lang.String", "java.lang.String" }`
Returns | `String`
Exceptions | `weblogic.management.utils.NotFoundException`

### getRemoteUserName

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

Operation Name | `"getRemoteUserName"`
Parameters | `Object [] { resourceId, wlsUserName }` where: `resourceId` is an object of type `java.lang.String` that specifies: - The resource on which the mapping between the local weblogic user and the remote user was created. `wlsUserName` is an object of type `java.lang.String` that specifies: - The local weblogic username.
Signature | `String [] { "java.lang.String", "java.lang.String" }`
Returns | `String`
Exceptions | `weblogic.management.utils.NotFoundException`

### haveCurrent

Returns true if there are more objects in the list, and false otherwise.

Operation Name | `"haveCurrent"`
Parameters | `Object [] { cursor }` where: `cursor` is an object of type `java.lang.String` that specifies: - The cursor returned from a previous list method.
Signature | `String [] { "java.lang.String" }`
Returns | `boolean`
Exceptions | `weblogic.management.utils.InvalidCursorException`

### listCredentials

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.

Operation Name | `"listCredentials"`
Parameters | `Object [] { resourceId }` where: `resourceId` is an object of type `java.lang.String` that specifies: - The resource for which the credentials are to be returned.
Signature | `String [] { "java.lang.String" }`
Returns | `String`

### listMappings

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.

Operation Name | `"listMappings"`
Parameters | `Object [] { resourceId }` where: `resourceId` is an object of type `java.lang.String` that specifies: - The resource for which the credential mappings are to be returned.
Signature | `String [] { "java.lang.String" }`
Returns | `String`

### removeUserPasswordCredential

Removes the credential that is created on the specified resource and remote username. If you created a credential map that specifies this username, the map becomes invalid. Users must remove any credential mappings created for the credential and the specified resource before removing the credential.

Operation Name | `"removeUserPasswordCredential"`
Parameters | `Object [] { resourceId, remoteUserName }` where: `resourceId` is an object of type `java.lang.String` that specifies: - The resource for which the credential is to be removed. `remoteUserName` is an object of type `java.lang.String` that specifies: - The name of remote user.
Signature | `String [] { "java.lang.String", "java.lang.String" }`
Returns | `void`
Exceptions | `weblogic.management.utils.NotFoundException`

### removeUserPasswordCredentialMapping

Removes the mapping from a webLogic username to a remote username-password credential for the specified resource.

Operation Name | `"removeUserPasswordCredentialMapping"`
Parameters | `Object [] { resourceId, wlsUserName }` where: `resourceId` is an object of type `java.lang.String` that specifies: - The resource for which the credential mapping is removed. `wlsUserName` is an object of type `java.lang.String` that specifies: - The user name of the webLogic user.
Signature | `String [] { "java.lang.String", "java.lang.String" }`
Returns | `void`
Exceptions | `weblogic.management.utils.NotFoundException`

### setUserPasswordCredential

Sets a remote user-password credential for the specified resource. If a new new username is specified, this method creates a new user-password credential. If you specify an existing username, this method replaces the user's password.

Operation Name | `"setUserPasswordCredential"`
Parameters | `Object [] { resourceId, remoteUserName, remotePassword }` where: `resourceId` is an object of type `java.lang.String` that specifies: - The resource for which the credential is created. `remoteUserName` is an object of type `java.lang.String` that specifies: - The username for the credential. `remotePassword` is an object of type `java.lang.String` that specifies: - The password for the credential.
Signature | `String [] { "java.lang.String", "java.lang.String", "java.lang.String" }`
Returns | `void`

### setUserPasswordCredentialMapping

Creates a mapping from a webLogic username to a remote username-password credential for the specified resource. The credential for the remoteusername for the specified resource should be created before this mapping is created.

Operation Name | `"setUserPasswordCredentialMapping"`
Parameters | `Object [] { resourceId, wlsUserName, remoteUserName }` where: `resourceId` is an object of type `java.lang.String` that specifies: - The resource for which the credential mapping is created. `wlsUserName` is an object of type `java.lang.String` that specifies: - The user name of the webLogic user. `remoteUserName` is an object of type `java.lang.String` that specifies: - The name of remote user the mapping is being created for.
Signature | `String [] { "java.lang.String", "java.lang.String", "java.lang.String" }`
Returns | `void`
Exceptions | `weblogic.management.utils.NotFoundException`

### wls_getDisplayName

Operation Name | `"wls_getDisplayName"`
Parameters | `null`
Signature | `null`
Returns | `String`