Class PEMKeyStoreParameters

  • All Implemented Interfaces:
    java.security.KeyStore.LoadStoreParameter

    public class PEMKeyStoreParameters
    extends java.lang.Object
    implements java.security.KeyStore.LoadStoreParameter
    This parameter class provides all of the options for creating a FileBasedKeyStore.

    It is immutable.

    Since:
    1.0
    Version:
    ${vesion}
    • Constructor Summary

      Constructors 
      Constructor Description
      PEMKeyStoreParameters​(java.lang.String initDefaultCertDir)
      This is the simplest constructor which only accepts a directory where all of the security material is stored.
      PEMKeyStoreParameters​(java.lang.String initCertDirs, java.lang.String initDefaultCertDir)
      This is a slightly more complicated constructor which allows the user to specify one or more directory where the certificates are currently stored.
      PEMKeyStoreParameters​(java.lang.String initCertDirs, java.lang.String initDefaultCertDir, java.lang.String initProxyFileName)
      This constructor is for users who have a proxy certificate in addition to other security materials.
      PEMKeyStoreParameters​(java.lang.String initCertDirs, java.lang.String initDefaultCertDir, java.lang.String initUserCertFileName, java.lang.String initUserKeyFileName, java.security.KeyStore.ProtectionParameter initProtectionParameter)
      A Constructor supporting the initial storage directories for the certificates, the default storage directory, the filename of the user's certificate file, the file name of the user's key file and a ProtectionParameter.
      PEMKeyStoreParameters​(java.lang.String initCertDirs, java.lang.String initDefaultCertDir, java.lang.String initUserCertFileName, java.lang.String initUserKeyFileName, java.security.KeyStore.ProtectionParameter initProtectionParameter, java.lang.String initProxyFileName)
      This is the full constructor for users with proxy certificates.
    • Field Detail

      • certDirs

        private java.lang.String certDirs
      • defaultCertDir

        private java.lang.String defaultCertDir
      • userCertFilename

        private java.lang.String userCertFilename
      • userKeyFilename

        private java.lang.String userKeyFilename
      • protectionParameter

        private java.security.KeyStore.ProtectionParameter protectionParameter
      • proxyFilename

        private java.lang.String proxyFilename
    • Constructor Detail

      • PEMKeyStoreParameters

        public PEMKeyStoreParameters​(java.lang.String initDefaultCertDir)
        This is the simplest constructor which only accepts a directory where all of the security material is stored. New security material written to this KeyStore will be stored in this directory as well.
        Parameters:
        initDefaultCertDir - The directory for storage of security material
      • PEMKeyStoreParameters

        public PEMKeyStoreParameters​(java.lang.String initCertDirs,
                                     java.lang.String initDefaultCertDir)
        This is a slightly more complicated constructor which allows the user to specify one or more directory where the certificates are currently stored. The user can also specify a default directory where new security material can be stored.
        Parameters:
        initCertDirs - Directories where security material exists.
        initDefaultCertDir - A default directory for the storage of security material
      • PEMKeyStoreParameters

        public PEMKeyStoreParameters​(java.lang.String initCertDirs,
                                     java.lang.String initDefaultCertDir,
                                     java.lang.String initUserCertFileName,
                                     java.lang.String initUserKeyFileName,
                                     java.security.KeyStore.ProtectionParameter initProtectionParameter)
        A Constructor supporting the initial storage directories for the certificates, the default storage directory, the filename of the user's certificate file, the file name of the user's key file and a ProtectionParameter.
        Parameters:
        initCertDirs - Directories where security material exists.
        initDefaultCertDir - A default directory for the storage of security material.
        initUserCertFileName - The file name for the user's certificate.
        initUserKeyFileName - The file name for the user's key.
        initProtectionParameter - A protection parameter for this keystore.
      • PEMKeyStoreParameters

        public PEMKeyStoreParameters​(java.lang.String initCertDirs,
                                     java.lang.String initDefaultCertDir,
                                     java.lang.String initProxyFileName)
        This constructor is for users who have a proxy certificate in addition to other security materials.
        Parameters:
        initCertDirs - Directories where security material exists.
        initDefaultCertDir - A default directory for the storage of security material.
        initProxyFileName - The file name for the user's proxy certificate.
      • PEMKeyStoreParameters

        public PEMKeyStoreParameters​(java.lang.String initCertDirs,
                                     java.lang.String initDefaultCertDir,
                                     java.lang.String initUserCertFileName,
                                     java.lang.String initUserKeyFileName,
                                     java.security.KeyStore.ProtectionParameter initProtectionParameter,
                                     java.lang.String initProxyFileName)
        This is the full constructor for users with proxy certificates.
        Parameters:
        initCertDirs - Directories where security material exists.
        initDefaultCertDir - A default directory for the storage of security material.
        initUserCertFileName - The file name for the user's certificate.
        initUserKeyFileName - The file name for the user's key.
        initProtectionParameter - A protection parameter for this keystore.
        initProxyFileName - The file name for the user's proxy certificate.
    • Method Detail

      • getProtectionParameter

        public java.security.KeyStore.ProtectionParameter getProtectionParameter()
        Specified by:
        getProtectionParameter in interface java.security.KeyStore.LoadStoreParameter
      • getCertDirs

        public java.lang.String getCertDirs()
      • getDefaultCertDir

        public java.lang.String getDefaultCertDir()
      • getUserCertFilename

        public java.lang.String getUserCertFilename()
      • getUserKeyFilename

        public java.lang.String getUserKeyFilename()
      • getProxyFilename

        public java.lang.String getProxyFilename()