PKICredentialMapReaderMBean (Abstract)

Overview  |   Related MBeans  |   Attributes  |   Operations

Overview

Provides a set of methods for reading a credential map that matches users and resources to aliases and their corresponding passwords that can then be used to retrieve key information or public certificate information from the configured keystores.

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.PKICredentialMapReaderMBean
   
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"    
    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

     

    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"    
    Parameters Object [] {  keystoreAlias }

    where:

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

      - The keystore alias.

    Signature String [] { "java.lang.String" }
    Returns Certificate
    Exceptions

    • weblogic.management.utils.NotFoundException

     

    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"    
    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 or the listMappingsByPattern.

    Signature String [] { "java.lang.String" }
    Returns String
    Exceptions

    • weblogic.management.utils.InvalidCursorException

     

    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"    
    Parameters Object [] {  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.

    Signature String [] { "java.lang.String" }
    Returns String
    Exceptions

    • weblogic.management.utils.InvalidCursorException

     

    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"    
    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 or the listMappingsByPattern.

    Signature String [] { "java.lang.String" }
    Returns String
    Exceptions

    • weblogic.management.utils.InvalidCursorException

     

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

    where:

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

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

    Signature String [] { "java.lang.String" }
    Returns String
    Exceptions

    • weblogic.management.utils.InvalidCursorException

     

    getKeystoreAlias

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

    Operation Name "getKeystoreAlias"    
    Parameters Object [] {  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.

    Signature String [] { "java.lang.String", "java.lang.String", "java.lang.Boolean", "java.lang.String", "java.lang.String" }
    Returns String
    Exceptions

    • weblogic.management.utils.NotFoundException
      NotFoundException - This exception is thrown if the keystore alias is not found.

     

    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

     

    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"    
    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 or the listMappingsByPattern.

    Signature String [] { "java.lang.String" }
    Returns boolean
    Exceptions

    • weblogic.management.utils.InvalidCursorException

     

    isSet

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

    Operation Name "isSet"    
    Parameters Object [] {  propertyName }

    where:

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

      property to check

    Signature String [] { "java.lang.String" }
    Returns boolean
    Exceptions

    • java.lang.IllegalArgumentException

     

    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"    
    Parameters null
    Signature null
    Returns class
    Exceptions

    • weblogic.management.utils.NotFoundException

     

    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"    
    Parameters null
    Signature null
    Returns class
    Exceptions

    • weblogic.management.utils.NotFoundException

     

    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"    
    Parameters Object [] {  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.

    Signature String [] { "java.lang.String", "java.lang.String" }
    Returns String

     

    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"    
    Parameters Object [] {  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

    Signature String [] { "java.lang.String", "java.lang.Integer", "java.lang.String" }
    Returns String

     

    unSet

    Restore the given property to its default value.

    Operation Name "unSet"    
    Parameters Object [] {  propertyName }

    where:

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

      property to restore

    Signature String [] { "java.lang.String" }
    Returns void
    Exceptions

    • java.lang.IllegalArgumentException
      UnsupportedOperationException if called on a runtime implementation.

     

    wls_getDisplayName

    Operation Name "wls_getDisplayName"    
    Parameters null
    Signature null
    Returns String