UserPasswordCredentialMapReaderMBean (Abstract)


Overview  |   Child MBeans  |   Attributes  |   Operations

Overview

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.

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.UserPasswordCredentialMapReaderMBean

Factory Methods

No factory methods. Instances of this MBean are created automatically.

Subtypes

The following MBeans extend or implement this MBean type:


Operations

This section describes the following operations:


advance

Advances the list to the next element in the list.

   
Operation Name"advance"
ParametersObject [] {  cursor }

where:

  • cursor is an object of type java.lang.String that specifies:

    - The cursor returned from a previous list method.

SignatureString [] { "java.lang.String" }
Returns void

Exceptions

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"
ParametersObject [] {  cursor }

where:

  • cursor is an object of type java.lang.String that specifies:

    - The cursor returned from a previous list method.

SignatureString [] { "java.lang.String" }
Returns void

Exceptions

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"
ParametersObject [] {  cursor }

where:

  • cursor is an object of type java.lang.String that specifies:

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

SignatureString [] { "java.lang.String" }
ReturnsString

Exceptions

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"
ParametersObject [] {  cursor }

where:

  • cursor is an object of type java.lang.String that specifies:

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

SignatureString [] { "java.lang.String" }
ReturnsString

Exceptions

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"
ParametersObject [] {  cursor }

where:

  • cursor is an object of type java.lang.String that specifies:

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

SignatureString [] { "java.lang.String" }
ReturnsString

Exceptions

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"
ParametersObject [] {  cursor }

where:

  • cursor is an object of type java.lang.String that specifies:

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

SignatureString [] { "java.lang.String" }
ReturnsString

Exceptions

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"
ParametersObject [] {  resourceIdremoteUserName }

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.

SignatureString [] { "java.lang.String", "java.lang.String" }
ReturnsString

Exceptions

getRemoteUserName

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

   
Operation Name"getRemoteUserName"
ParametersObject [] {  resourceIdwlsUserName }

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.

SignatureString [] { "java.lang.String", "java.lang.String" }
ReturnsString

Exceptions

haveCurrent

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

   
Operation Name"haveCurrent"
ParametersObject [] {  cursor }

where:

  • cursor is an object of type java.lang.String that specifies:

    - The cursor returned from a previous list method.

SignatureString [] { "java.lang.String" }
Returns boolean

Exceptions

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"
ParametersObject [] {  resourceId }

where:

  • resourceId is an object of type java.lang.String that specifies:

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

SignatureString [] { "java.lang.String" }
ReturnsString

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"
ParametersObject [] {  resourceId }

where:

  • resourceId is an object of type java.lang.String that specifies:

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

SignatureString [] { "java.lang.String" }
ReturnsString

wls_getDisplayName

   
Operation Name"wls_getDisplayName"
Parametersnull
Signaturenull
ReturnsString