# DefaultCredentialMapperMBean

Overview | Related MBeans | Attributes | Operations

## Overview

This MBean represents configuration attributes for the WebLogic Credential Mapping provider.Deprecation of MBeanHome and Type-Safe InterfacesThis is a type-safe interface for a WebLogic Server MBean, which you can import into your client classes and access through weblogic.management.MBeanHome. As of 9.0, the MBeanHome interface and all type-safe interfaces for WebLogic Server MBeans are deprecated. Instead, client classes 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://edocs.bea.com.

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.security.providers.credentials.DefaultCredentialMapperMBean`
Factory Methods | No factory methods. Instances of this MBean are created automatically.
Access Points Inherited from CredentialMapperMBean | Because this MBean extends or implements CredentialMapperMBean, you can also access this MBean by retrieving CredentialMapperMBeans. The following attributes contain CredentialMapperMBeans and its subtypes:
RealmMBean.CredentialMappers |

## Related MBeans

This section describes attributes that provide access to other MBeans. For more information about the MBean hierarchy, refer to WebLogic Server MBean Data Model.

Realm |

### Realm

Returns the realm that contains this security provider. Returns null if this security provider is not contained by a realm.

Privileges | Read only
Type | RealmMBean
Relationship type: | Reference.

## Attributes

This section describes the following attributes:

CredentialMappingDeploymentEnabled Description Name ProviderClassName SupportedExportConstraints | SupportedExportFormats SupportedImportConstraints SupportedImportFormats Version

### CredentialMappingDeploymentEnabled

Returns whether this Credential Mapping provider stores stores credential maps created when deploying a resource adapter.

Privileges | Read/Write
Type | boolean
Default Value | true

### Description

A short description of the WebLogic Credential Mapping provider.

Privileges | Read only
Type | java.lang.String
Default Value | WebLogic Credential Mapping Provider
Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server.

### Name

Privileges | Read only
Type | java.lang.String
Default Value | DefaultCredentialMapper
Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server.

### ProviderClassName

The name of the Java class that loads the WebLogic Credential Mapping provider.

Privileges | Read only
Type | java.lang.String
Default Value | weblogic.security.providers.credentials.DefaultCredentialMapperProviderImpl
Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server.

### SupportedExportConstraints

The credential maps that you want to be exported from this Credential Mapping provider's database. If none are specified, all are exported.

Privileges | Read only
Type | class java.lang.String[]
Default Value | passwords
Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server.

### SupportedExportFormats

The format of the file to export. The list of supported export formats is determined by this Credential Mapping provider.

Privileges | Read only
Type | class java.lang.String[]
Default Value | DefaultCreds
Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server.

### SupportedImportConstraints

The credential maps that you want to be imported into this Credential Mapping provider's database. If none are specified, all are imported.

Privileges | Read only
Type | class java.lang.String[]
Default Value |
Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server.

### SupportedImportFormats

The format of the fie to import. The list of supported import formats is determined by the Credential Mapping provider from which the credential maps were originally exported.

Privileges | Read only
Type | class java.lang.String[]
Default Value | DefaultCreds
Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server.

### Version

The version of the WebLogic Credential Mapping provider.

Privileges | Read only
Type | java.lang.String
Default Value | 1.0
Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server.

## Operations

This section describes the following operations:

advance close exportData getCurrentCredentialRemotePassword getCurrentCredentialRemoteUserName getCurrentMappingRemoteUserName getCurrentMappingResourceID getCurrentMappingWLSUserName getRemotePassword getRemoteUserName haveCurrent | importData listCredentials listMappings listMappingsByPattern 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`

### exportData

Exports provider specific data in a specified format. When errors occur, the MBean throws an ErrorCollectionException containing a list of `java.lang.Exceptions`, where the text of each exception describes the error.

Operation Name | `"exportData"`
Parameters | `Object [] { format, filename, constraints }` where: `format` is an object of type `java.lang.String` that specifies: - The format for exporting provider specific data. `filename` is an object of type `java.lang.String` that specifies: - The full path to the filename used to write data. `constraints` is an object of type `java.util.Properties` that specifies: - The constraints to be used when exporting data. A null value indicates that all data will be exported.
Signature | `String [] { "java.lang.String", "java.lang.String", "java.util.Properties" }`
Returns | `void`
Exceptions | `weblogic.management.utils.InvalidParameterException` `weblogic.management.utils.ErrorCollectionException`

### 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`

### getCurrentMappingResourceID

Gets an resource id from a credentials map that has been returned from the `listMappingsByPattern` method. This method returns the resource id that corresponds to current location in the list.

Operation Name | `"getCurrentMappingResourceID"`
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 and the `listMappingsByPattern`.
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`

### importData

Imports provider specific data from a specified format. When errors occur, the MBean throws an ErrorCollectionException containing a list of `java.lang.Exceptions`, where the text of each exception describes the error.

Operation Name | `"importData"`
Parameters | `Object [] { format, filename, constraints }` where: `format` is an object of type `java.lang.String` that specifies: - The format for importing provider specific data. `filename` is an object of type `java.lang.String` that specifies: - The full path to the filename used to read data. `constraints` is an object of type `java.util.Properties` that specifies: - The constraints to be used when importing data. A null value indicates that all data will be imported.
Signature | `String [] { "java.lang.String", "java.lang.String", "java.util.Properties" }`
Returns | `void`
Exceptions | `weblogic.management.utils.InvalidParameterException` `weblogic.management.utils.ErrorCollectionException`

### 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`

### listMappingsByPattern

Gets a list of all credential mappings with the resource id matching the specified resource id pattern. Returns a cursor as a string. Use the `getCurrentMappingWLSUserName` and `getCurrentMappingRemoteUserName()` and `getCurrentMappingResourceID()` methods to return the WebLogic username and external user name and the current resource ID for the current item in the list.

Operation Name | `"listMappingsByPattern"`
Parameters | `Object [] { resourceIdPattern, maxToReturn }` where: `resourceIdPattern` is an object of type `java.lang.String` that specifies: - Resource Id string pattern, that can contain '*' - wild card, and '' - escape character. `maxToReturn` is an object of type `java.lang.Integer` that specifies: - Maximum number of returned mappings
Signature | `String [] { "java.lang.String", "java.lang.Integer" }`
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`