Class KeyStoreKeyManager

  • All Implemented Interfaces:
    java.io.Serializable, javax.net.ssl.KeyManager, javax.net.ssl.X509KeyManager

    @NotMutable
    @ThreadSafety(level=COMPLETELY_THREADSAFE)
    public final class KeyStoreKeyManager
    extends WrapperKeyManager
    implements java.io.Serializable
    This class provides an SSL key manager that may be used to retrieve certificates from a key store file. By default it will use the default key store format for the JVM (e.g., "JKS" for Sun-provided Java implementations), but alternate formats like PKCS12 may be used.
    See Also:
    Serialized Form
    • Constructor Summary

      Constructors 
      Constructor Description
      KeyStoreKeyManager​(java.io.File keyStoreFile, char[] keyStorePIN)
      Creates a new instance of this key store key manager that provides the ability to retrieve certificates from the specified key store file.
      KeyStoreKeyManager​(java.io.File keyStoreFile, char[] keyStorePIN, java.lang.String keyStoreFormat, java.lang.String certificateAlias)
      Creates a new instance of this key store key manager that provides the ability to retrieve certificates from the specified key store file.
      KeyStoreKeyManager​(java.io.File keyStoreFile, char[] keyStorePIN, java.lang.String keyStoreFormat, java.lang.String certificateAlias, boolean validateKeyStore)
      Creates a new instance of this key store key manager that provides the ability to retrieve certificates from the specified key store file.
      KeyStoreKeyManager​(java.lang.String keyStoreFile, char[] keyStorePIN)
      Creates a new instance of this key store key manager that provides the ability to retrieve certificates from the specified key store file.
      KeyStoreKeyManager​(java.lang.String keyStoreFile, char[] keyStorePIN, java.lang.String keyStoreFormat, java.lang.String certificateAlias)
      Creates a new instance of this key store key manager that provides the ability to retrieve certificates from the specified key store file.
      KeyStoreKeyManager​(java.lang.String keyStoreFile, char[] keyStorePIN, java.lang.String keyStoreFormat, java.lang.String certificateAlias, boolean validateKeyStore)
      Creates a new instance of this key store key manager that provides the ability to retrieve certificates from the specified key store file.
    • Constructor Detail

      • KeyStoreKeyManager

        public KeyStoreKeyManager​(java.io.File keyStoreFile,
                                  char[] keyStorePIN)
                           throws java.security.KeyStoreException
        Creates a new instance of this key store key manager that provides the ability to retrieve certificates from the specified key store file. It will use the default key store format.
        Parameters:
        keyStoreFile - The path to the key store file to use. It must not be null.
        keyStorePIN - The PIN to use to access the contents of the key store. It may be null if no PIN is required.
        Throws:
        java.security.KeyStoreException - If a problem occurs while initializing this key manager.
      • KeyStoreKeyManager

        public KeyStoreKeyManager​(java.lang.String keyStoreFile,
                                  char[] keyStorePIN)
                           throws java.security.KeyStoreException
        Creates a new instance of this key store key manager that provides the ability to retrieve certificates from the specified key store file. It will use the default key store format.
        Parameters:
        keyStoreFile - The path to the key store file to use. It must not be null.
        keyStorePIN - The PIN to use to access the contents of the key store. It may be null if no PIN is required.
        Throws:
        java.security.KeyStoreException - If a problem occurs while initializing this key manager.
      • KeyStoreKeyManager

        public KeyStoreKeyManager​(java.io.File keyStoreFile,
                                  char[] keyStorePIN,
                                  java.lang.String keyStoreFormat,
                                  java.lang.String certificateAlias)
                           throws java.security.KeyStoreException
        Creates a new instance of this key store key manager that provides the ability to retrieve certificates from the specified key store file.
        Parameters:
        keyStoreFile - The path to the key store file to use. It must not be null.
        keyStorePIN - The PIN to use to access the contents of the key store. It may be null if no PIN is required.
        keyStoreFormat - The format to use for the key store. It may be null if the default format should be used.
        certificateAlias - The nickname of the certificate that should be selected. It may be null if any acceptable certificate found in the keystore may be used.
        Throws:
        java.security.KeyStoreException - If a problem occurs while initializing this key manager.
      • KeyStoreKeyManager

        public KeyStoreKeyManager​(java.lang.String keyStoreFile,
                                  char[] keyStorePIN,
                                  java.lang.String keyStoreFormat,
                                  java.lang.String certificateAlias)
                           throws java.security.KeyStoreException
        Creates a new instance of this key store key manager that provides the ability to retrieve certificates from the specified key store file.
        Parameters:
        keyStoreFile - The path to the key store file to use. It must not be null.
        keyStorePIN - The PIN to use to access the contents of the key store. It may be null if no PIN is required.
        keyStoreFormat - The format to use for the key store. It may be null if the default format should be used.
        certificateAlias - The nickname of the certificate that should be selected. It may be null if any acceptable certificate found in the keystore may be used.
        Throws:
        java.security.KeyStoreException - If a problem occurs while initializing this key manager.
      • KeyStoreKeyManager

        public KeyStoreKeyManager​(java.io.File keyStoreFile,
                                  char[] keyStorePIN,
                                  java.lang.String keyStoreFormat,
                                  java.lang.String certificateAlias,
                                  boolean validateKeyStore)
                           throws java.security.KeyStoreException
        Creates a new instance of this key store key manager that provides the ability to retrieve certificates from the specified key store file.
        Parameters:
        keyStoreFile - The path to the key store file to use. It must not be null.
        keyStorePIN - The PIN to use to access the contents of the key store. It may be null if no PIN is required.
        keyStoreFormat - The format to use for the key store. It may be null if the default format should be used.
        certificateAlias - The nickname of the certificate that should be selected. It may be null if any acceptable certificate found in the keystore may be used.
        validateKeyStore - Indicates whether to validate that the provided key store is acceptable and can actually be used to obtain a valid certificate. If a certificate alias was specified, then this will ensure that the key store contains a valid private key entry with that alias. If no certificate alias was specified, then this will ensure that the key store contains at least one valid private key entry.
        Throws:
        java.security.KeyStoreException - If a problem occurs while initializing this key manager, or if validation fails.
      • KeyStoreKeyManager

        public KeyStoreKeyManager​(java.lang.String keyStoreFile,
                                  char[] keyStorePIN,
                                  java.lang.String keyStoreFormat,
                                  java.lang.String certificateAlias,
                                  boolean validateKeyStore)
                           throws java.security.KeyStoreException
        Creates a new instance of this key store key manager that provides the ability to retrieve certificates from the specified key store file.
        Parameters:
        keyStoreFile - The path to the key store file to use. It must not be null.
        keyStorePIN - The PIN to use to access the contents of the key store. It may be null if no PIN is required.
        keyStoreFormat - The format to use for the key store. It may be null if the default format should be used.
        certificateAlias - The nickname of the certificate that should be selected. It may be null if any acceptable certificate found in the keystore may be used.
        validateKeyStore - Indicates whether to validate that the provided key store is acceptable and can actually be used to obtain a valid certificate. If a certificate alias was specified, then this will ensure that the key store contains a valid private key entry with that alias. If no certificate alias was specified, then this will ensure that the key store contains at least one valid private key entry.
        Throws:
        java.security.KeyStoreException - If a problem occurs while initializing this key manager, or if validation fails.
    • Method Detail

      • getKeyStoreFile

        public java.lang.String getKeyStoreFile()
        Retrieves the path to the key store file to use.
        Returns:
        The path to the key store file to use.
      • getKeyStoreFormat

        public java.lang.String getKeyStoreFormat()
        Retrieves the name of the key store file format.
        Returns:
        The name of the key store file format.