Overview | Package | Class | Use | Tree | Deprecated | Index | Help
|  | Oracle
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## weblogic.management.security.credentials
Interface PKICredentialMapReaderMBean

All Superinterfaces:
  ListerMBean

All Known Subinterfaces:
  PKICredentialMapEditorMBean

    public interface PKICredentialMapReaderMBean

extends ListerMBean

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.

Method Summary
`Certificate` | `getCertificate(String keystoreAlias)` For a certificate entry this method will return the certificate corresponding to the alias.
`String` | `getCurrentCredAction(String cursor)` Gets an credential action from a list that has been returned from the `listMappings` or the `listMappingsByPattern()` method.
`String` | `getCurrentCredential(String cursor)` Gets the keystore alias from a credentials map that has been returned from the `listMappings` or the `listMappingsByPattern()` method.
`String` | `getCurrentInitiatorName(String cursor)` Gets an username from a list that has been returned from the `listMappings` or the `listMappingsByPattern()` method.
`String` | `getCurrentResourceId(String cursor)` Gets the current resource id from a list that has been returned from the and `listMappingsByPattern()` method.
`String` | `getKeystoreAlias(String resourceId, String userName, boolean isInitiatorUserName, String credAction, String credType)` Gets the keystore alias that is mapped to a username for a particular resource and credential action.
`boolean` | `isInitiatorUserName(String cursor)` 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.
`String[]` | `listAllCertEntryAliases()` Returns a list of all the public certificate aliases currently configured in the keystore.
`String[]` | `listAllKeypairEntryAliases()` Returns a list of all the key pair aliases that currently configured in the keystore.
`String` | `listMappings(String resourceId, String credType)` Gets a list of usernames, credential actions, keystore aliases and their passwords.
`String` | `listMappingsByPattern(String resourceIdPattern, int maxToReturn, String credType)` Gets a list of all the configured credential mappings.

Methods inherited from interface weblogic.management.utils.ListerMBean
`advance, close, haveCurrent`

Method Detail

### getKeystoreAlias

    String getKeystoreAlias(String resourceId,
                            String userName,
                            boolean isInitiatorUserName,
                            String credAction,
                            String credType)
                            throws NotFoundException

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

  Parameters:
    `resourceId` - - 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` - - The username that is mapped to the alias and password.
    `isInitiatorUserName` - - Set true if the initiator name passed in is the username. False otherwise.
    `credAction` - - The credential action for which the mapping is created for.
    `credType` - - The credential type.
  Returns:
    The keystore Alias corresponding to the resourceId and username.
  Throws:
    `NotFoundException` - - This exception is thrown if the keystore alias is not found.

### getCurrentInitiatorName

    String getCurrentInitiatorName(String cursor)
                                   throws InvalidCursorException

  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.

  Parameters:
    `cursor` - - The cursor that has been returned from the `listMappings` method or the `listMappingsByPattern`.
  Returns:
    Returns the username.
  Throws:
    `InvalidCursorException`

### isInitiatorUserName

    boolean isInitiatorUserName(String cursor)
                                throws InvalidCursorException

  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.

  Parameters:
    `cursor` - - The cursor that has been returned from the `listMappings` method or the `listMappingsByPattern`.
  Throws:
    `InvalidCursorException`

### getCurrentCredAction

    String getCurrentCredAction(String cursor)
                                throws InvalidCursorException

  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.

  Parameters:
    `cursor` - - The cursor that has been returned from the `listMappings` method or the `listMappingsByPattern`.
  Throws:
    `InvalidCursorException`

### getCurrentCredential

    String getCurrentCredential(String cursor)
                                throws InvalidCursorException

  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.

  Parameters:
    `cursor` - - The cursor that has been returned from the `listMappings` or the `listMappingsByPattern` method.
  Throws:
    `InvalidCursorException`

### listMappings

    String listMappings(String resourceId,
                        String credType)

  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.

  Parameters:
    `resourceId` - - the resource id that the credential mappings are created for. A resource object such as `weblogic.security.service.ResourceManager` assigns IDs to external sources.

### getCurrentResourceId

    String getCurrentResourceId(String cursor)
                                throws InvalidCursorException

  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.

  Parameters:
    `cursor` - - The cursor that has been returned from the `listMappingsByPattern` method.
  Throws:
    `InvalidCursorException`

### listMappingsByPattern

    String listMappingsByPattern(String resourceIdPattern,
                                 int maxToReturn,
                                 String credType)

  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.

  Parameters:
    `resourceIdPattern` - - 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` - - The maximum number of records to return
    `credType` - - The credential type

### listAllCertEntryAliases

    String[] listAllCertEntryAliases()
                                     throws NotFoundException

  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.

  Throws:
    `NotFoundException`

### listAllKeypairEntryAliases

    String[] listAllKeypairEntryAliases()
                                        throws NotFoundException

  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.

  Throws:
    `NotFoundException`

### getCertificate

    Certificate getCertificate(String keystoreAlias)
                               throws NotFoundException

  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.

  Parameters:
    `keystoreAlias` - - The keystore alias.
  Throws:
    `NotFoundException`

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| Documentation is available at http://edocs.bea.com/wls/docs103 Copyright 1996,2008, Oracle and/or its affiliates. All rights reserved. Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners.
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD