PKICredentialMapperMBean

Overview  |   Child MBeans  |   Attributes  |   Operations

Overview

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

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

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:

    Child MBeans

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

      Realm

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

             
      Factory Methods No explicit creator method. The child shares the lifecycle of its parent.
      Privileges Read only
      TypeRealmMBean

      Attributes

      This section describes the following attributes:

      Description

      A short description of the PKI Credential Mapping provider.

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

      KeyStoreFileName

      No description provided.

             
      Privileges Read/Write
      Typejava.lang.String
      Default Value
      Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

      KeyStorePassPhrase

      No description provided.

             
      Privileges Read/Write
      Typejava.lang.String
      Default Value
      Encryptedtrue
      Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

      KeyStorePassPhraseEncrypted

             
      Privileges Read/Write
      Typebyte[]
      Encryptedtrue
      Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

      KeyStoreProvider

      No description provided.

             
      Privileges Read/Write
      Typejava.lang.String
      Default Value
      Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

      KeyStoreType

      No description provided.

             
      Privileges Read/Write
      Typejava.lang.String
      Default ValueJKS
      Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

      Name

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

      ProviderClassName

      No description provided.

             
      Privileges Read only
      Typejava.lang.String
      Default Valueweblogic.security.providers.credentials.PKICredentialMapperProviderImpl
      Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

      SupportedExportConstraints

      No description provided.

             
      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

      No description provided.

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

      SupportedImportConstraints

      No description provided.

             
      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

      No description provided.

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

      UseInitiatorGroupNames

      No description provided.

             
      Privileges Read/Write
      Typeboolean
      Default Valuetrue
      Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

      UseResourceHierarchy

      No description provided.

             
      Privileges Read/Write
      Typeboolean
      Default Valuetrue
      Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

      Version

      The version of the PKI 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

      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

      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 [] {  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.
      SignatureString [] { "java.lang.String", "java.lang.String", "java.util.Properties" }
      Returns void

      Exceptions

      getCertificate

      For a certificate entry this method will return the certificate corresponding to the alias. For a keyentry it will return the first Certificate entry in a CertificateChain.

         
      Operation Name"getCertificate"
      ParametersObject [] {  keystoreAlias }

      where:

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

        - The keystore alias.
      SignatureString [] { "java.lang.String" }
      ReturnsCertificate

      Exceptions

      getCurrentCredAction

      Gets an credential action from a list that has been returned from the listMappings or the listMappingsByPattern() method. This method returns the credential action that corresponds to current location in the list.

         
      Operation Name"getCurrentCredAction"
      ParametersObject [] {  cursor }

      where:

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

        - The cursor that has been returned from the listMappings method or the listMappingsByPattern.
      SignatureString [] { "java.lang.String" }
      ReturnsString

      Exceptions

      getCurrentCredential

      Gets the keystore alias from a credentials map that has been returned from the listMappings or the listMappingsByPattern() method. This method returns the keystore alias that corresponds to current location in the list.

         
      Operation Name"getCurrentCredential"
      ParametersObject [] {  cursor }

      where:

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

        - The cursor that has been returned from the listMappings or the listMappingsByPattern method.
      SignatureString [] { "java.lang.String" }
      ReturnsString

      Exceptions

      getCurrentInitiatorName

      Gets an username from a list that has been returned from the listMappings or the listMappingsByPattern() method. This method returns the username that corresponds to current location in the list.

         
      Operation Name"getCurrentInitiatorName"
      ParametersObject [] {  cursor }

      where:

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

        - The cursor that has been returned from the listMappings method or the listMappingsByPattern.
      SignatureString [] { "java.lang.String" }
      ReturnsString

      Exceptions

      getCurrentResourceId

      Gets the current resource id from a list that has been returned from the and listMappingsByPattern() method. This method returns the resource id that corresponds to current location in the list.

         
      Operation Name"getCurrentResourceId"
      ParametersObject [] {  cursor }

      where:

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

        - The cursor that has been returned from the listMappingsByPattern method.
      SignatureString [] { "java.lang.String" }
      ReturnsString

      Exceptions

      getKeystoreAlias

      Gets the keystore alias that is mapped to a username for a particular resource and credential action.

         
      Operation Name"getKeystoreAlias"
      ParametersObject [] {  resourceId, userName, isInitiatorUserName, credAction, credType }

      where:

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

        - The resource id that is used to map user names to keystore alias and password. A resource object such as weblogic.security.service.ResourceManager assigns IDs to external sources.

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

        - The username that is mapped to the alias and password.

      • isInitiatorUserName is an object of type java.lang.Boolean that specifies:

        - Set true if the initiator name passed in is the username. False otherwise.

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

        - The credential action for which the mapping is created for.

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

        - The credential type.
      SignatureString [] { "java.lang.String", "java.lang.String", "java.lang.Boolean", "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

      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 [] {  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.
      SignatureString [] { "java.lang.String", "java.lang.String", "java.util.Properties" }
      Returns void

      Exceptions

      isInitiatorUserName

      Returns whether the initiator name from a list that has been returned from the listMappings or the listMappingsByPattern()method is a user name or a group name. Method returns true if the username returned by the getCurrentInitiatorName is a user name. If the initiator name returned is a Group name this method returns false.

         
      Operation Name"isInitiatorUserName"
      ParametersObject [] {  cursor }

      where:

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

        - The cursor that has been returned from the listMappings method or the listMappingsByPattern.
      SignatureString [] { "java.lang.String" }
      Returns boolean

      Exceptions

      listAllCertEntryAliases

      Returns a list of all the public certificate aliases currently configured in the keystore. Console can call this method to display a list of all possible certificate aliases.

         
      Operation Name"listAllCertEntryAliases"
      Parametersnull
      Signaturenull
      Returns class

      Exceptions

      listAllKeypairEntryAliases

      Returns a list of all the key pair aliases that currently configured in the keystore. Console can call this method to display a list of all possible keypair aliases.

         
      Operation Name"listAllKeypairEntryAliases"
      Parametersnull
      Signaturenull
      Returns class

      Exceptions

      listMappings

      Gets a list of usernames, credential actions, keystore aliases and their passwords. Returns a cursor as a string. Use the getCurrentUserName(),getCurrentCredential(), getCurrentCredAction() methods to get the username, keystore alias and credential action 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 id that the credential mappings are created for. A resource object such as weblogic.security.service.ResourceManager assigns IDs to external sources.
      SignatureString [] { "java.lang.String", "java.lang.String" }
      ReturnsString

      listMappingsByPattern

      Gets a list of all the configured credential mappings. Returns a cursor as a string. Use the getCurrentUserName(), getCurrentCredAction(), getCurrentResourceId(), getCurrentCredential() methods to get the username, credential action, resource id and keystore alias for the current item in the list.

         
      Operation Name"listMappingsByPattern"
      ParametersObject [] {  resourceIdPattern, maxToReturn, credType }

      where:

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

        - the resource id pattern to filter the records to be returned. If you pass null or * the method will not filter and return all records.

      • maxToReturn is an object of type java.lang.Integer that specifies:

        - The maximum number of records to return

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

        - The credential type
      SignatureString [] { "java.lang.String", "java.lang.Integer", "java.lang.String" }
      ReturnsString

      removePKICredentialMapping

      Removes the mapping between the principalName, resourceid and credential action to the keystore alias.

         
      Operation Name"removePKICredentialMapping"
      ParametersObject [] {  resourceId, principalName, isInitiatorUserName, credAction, credType }

      where:

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

        - The resource for which the user name is mapped to the keystore alias and password.

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

        - The principalName used in the credential mapping.

      • isInitiatorUserName is an object of type java.lang.Boolean that specifies:

        - True if the initiator name is a user name. False if it is a group.

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

        - The credential action.

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

        - The credential type.
      SignatureString [] { "java.lang.String", "java.lang.String", "java.lang.Boolean", "java.lang.String", "java.lang.String" }
      Returns void

      Exceptions

      setCertificateCredential

      Creates a public certificate mapping between the principalName, resourceid and credential action to the keystore alias.

         
      Operation Name"setCertificateCredential"
      ParametersObject [] {  resourceId, principalName, isInitiatorUserName, credAction, keystoreAlias }

      where:

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

        - The resource for which the user name is mapped to the keystore alias.

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

        - The principalName used in the credential mapping.

      • isInitiatorUserName is an object of type java.lang.Boolean that specifies:

        - True if the initiator name is a user name. False if it is a group.

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

        - The credential action.

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

        - The keystore alias.
      SignatureString [] { "java.lang.String", "java.lang.String", "java.lang.Boolean", "java.lang.String", "java.lang.String" }
      Returns void

      Exceptions

      setKeypairCredential

      Creates a keypair mapping between the principalName, resourceid and credential action to the keystore alias and the corresponding password.

         
      Operation Name"setKeypairCredential"
      ParametersObject [] {  resourceId, principalName, isInitiatorUserName, credAction, keystoreAlias, password }

      where:

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

        - The resource for which the user name is mapped to the keystore alias and password.

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

        - The principalName used in the credential mapping.

      • isInitiatorUserName is an object of type java.lang.Boolean that specifies:

        - True if the initiator name is a user name. False if it is a group.

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

        - The credential action.

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

        - The keystore alias.

      • password is an object of type [C that specifies:

        - The password for the keystore entry.
      SignatureString [] { "java.lang.String", "java.lang.String", "java.lang.Boolean", "java.lang.String", "java.lang.String", "[C" }
      Returns void

      Exceptions

      wls_getDisplayName

         
      Operation Name"wls_getDisplayName"
      Parametersnull
      Signaturenull
      ReturnsString