Package org.alfresco.encryption
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 Summary
Fields Modifier and Type Field Description static String
KEY_KEYSTORE_PASSWORD
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
backup()
Backup the keystore to the backup location.void
create()
Create the key store if it doesn't exist.KeyManager[]
createKeyManagers()
Create an array of key managers from keys in the key store.TrustManager[]
createTrustManagers()
Create an array of trust managers from certificates in the key store.boolean
exists()
Does the underlying key store exist?Key
getBackupKey(String keyAlias)
Return the backup key with the given key alias.KeyStoreParameters
getBackupKeyStoreParameters()
The backup key store parameters.Key
getKey(String keyAlias)
Return the key with the given key alias.Set<String>
getKeyAliases()
Return all key aliases in the key store.KeyStoreParameters
getKeyStoreParameters()
The key store parameters.long
getKeyTimestamp(String keyAlias)
Return the timestamp (in ms) of when the key was last loaded from the keystore on disk.String
getName()
The name of the keystore.void
reload()
Reload the keys from the key store.void
validateKeys()
Check that the keys in the key store are valid i.e.
-
-
-
Field Detail
-
KEY_KEYSTORE_PASSWORD
static final String KEY_KEYSTORE_PASSWORD
- See Also:
- Constant Field Values
-
-
Method Detail
-
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
-
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
void reload() throws InvalidKeystoreException, MissingKeyException
Reload the keys from the key store.
-
validateKeys
void validateKeys() throws InvalidKeystoreException, MissingKeyException
Check that the keys in the key store are valid i.e. that they match those registered.
-
-