DefaultCredentialMapperMBean


Overview  |   Related MBeans  |   Attributes  |   Operations

Overview

This MBean represents configuration attributes for the WebLogic Credential Mapping provider.

   
Fully Qualified Interface NameIf 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:


    Related MBeans

    This section describes attributes that provide access to other MBeans.


      Realm

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

             
      Privileges Read only
      TypeRealmMBean
      Relationship type: Reference.


      Attributes

      This section describes the following attributes:


      CredentialMappingDeploymentEnabled

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

             
      Privileges Read/Write
      Typeboolean
      Default Valuetrue

      Description

      A short description of the WebLogic Credential Mapping provider.

             
      Privileges Read only
      Typejava.lang.String
      Default ValueWebLogic Credential Mapping Provider
      Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

      Name

             
      Privileges Read only
      Typejava.lang.String
      Default ValueDefaultCredentialMapper
      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
      Typejava.lang.String
      Default Valueweblogic.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
      Typeclass 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
      Typeclass 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
      Typeclass 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
      Typeclass 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
      Typejava.lang.String
      Default Value1.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

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

      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.

      SignatureString [] { "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"
      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
      • 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"
      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
      • 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"
      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
      • 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"
      ParametersObject [] {  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.

      SignatureString [] { "java.lang.String" }
      ReturnsString
      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"
      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
      • 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"
      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
      • weblogic.management.utils.NotFoundException

      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
      • weblogic.management.utils.NotFoundException

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

      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.

      SignatureString [] { "java.lang.String", "java.lang.String", "java.util.Properties" }
      Returns void
      Exceptions
      • weblogic.management.utils.InvalidParameterException
      • weblogic.management.utils.ErrorCollectionException

      isSet

      Returns true if the specified attribute has been set explicitly in this MBean instance.

         
      Operation Name"isSet"
      ParametersObject [] {  propertyName }

      where:

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

        property to check

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

      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

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

      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

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

      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. Use the removeUserPasswordCredentialMapping method.

         
      Operation Name"removeUserPasswordCredential"
      ParametersObject [] {  resourceIdremoteUserName }

      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.

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

      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.

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

      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.

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

      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.

      SignatureString [] { "java.lang.String", "java.lang.String", "java.lang.String" }
      Returns void
      Exceptions
      • weblogic.management.utils.NotFoundException

      unSet

      Restore the given property to its default value.

         
      Operation Name"unSet"
      ParametersObject [] {  propertyName }

      where:

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

        property to restore

      SignatureString [] { "java.lang.String" }
      Returns void
      Exceptions
      • java.lang.IllegalArgumentException
        UnsupportedOperationException if called on a runtime implementation.

      wls_getDisplayName

      Returns the display name of an MBean.

      Deprecated 9.0.0.0

         
      Operation Name"wls_getDisplayName"
      Parametersnull
      Signaturenull
      ReturnsString