Interface AlfrescoKeyStore

All Known Implementing Classes:
AlfrescoKeyStoreImpl

public interface AlfrescoKeyStore
Manages a Java Keystore for Alfresco, including caching keys where appropriate.
Since:
4.0
  • Field Details

  • Method Details

    • getName

      String getName()
      The name of the keystore.
      Returns:
      the name of the keystore.
    • backup

      void backup()
      Backup the keystore to the backup location. Write the keys to the backup keystore.
    • getKeyStoreParameters

      KeyStoreParameters getKeyStoreParameters()
      The key store parameters.
      Returns:
      KeyStoreParameters
    • getBackupKeyStoreParameters

      KeyStoreParameters getBackupKeyStoreParameters()
      The backup key store parameters.
      Returns:
      * @return
    • exists

      boolean exists()
      Does the underlying key store exist?
      Returns:
      true if it exists, false otherwise
    • getKey

      Key getKey(String keyAlias)
      Return the key with the given key alias.
      Parameters:
      keyAlias - String
      Returns:
      Key
    • getKeyTimestamp

      long getKeyTimestamp(String keyAlias)
      Return the timestamp (in ms) of when the key was last loaded from the keystore on disk.
      Parameters:
      keyAlias - String
      Returns:
      long
    • getBackupKey

      Key getBackupKey(String keyAlias)
      Return the backup key with the given key alias.
      Parameters:
      keyAlias - String
      Returns:
      Key
    • getKeyAliases

      Set<String> getKeyAliases()
      Return all key aliases in the key store.
      Returns:
      Set
    • createKeyManagers

      KeyManager[] createKeyManagers()
      Create an array of key managers from keys in the key store.
      Returns:
      KeyManager[]
    • createTrustManagers

      TrustManager[] createTrustManagers()
      Create an array of trust managers from certificates in the key store.
      Returns:
      TrustManager[]
    • create

      void create()
      Create the key store if it doesn't exist. A key for each key alias will be written to the keystore on disk, either from the cached keys or, if not present, a key will be generated.
    • reload

      Reload the keys from the key store.
      Throws:
      InvalidKeystoreException
      MissingKeyException
    • validateKeys

      void validateKeys() throws InvalidKeystoreException, MissingKeyException
      Check that the keys in the key store are valid i.e. that they match those registered.
      Throws:
      InvalidKeystoreException
      MissingKeyException