Package org.wildfly.security.keystore

Class AtomicLoadKeyStore

java.lang.Object

java.security.KeyStore

org.wildfly.security.keystore.AtomicLoadKeyStore

public class AtomicLoadKeyStore
extends KeyStore

A KeyStore wrapper that makes the load operation atomic, in addition it also gives the ability to reverse the load call.

Author:

Darran Lofthouse

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AtomicLoadKeyStore.LoadKey	An opaque key representing an atomic keystore state.

Nested classes/interfaces inherited from class java.security.KeyStore

KeyStore.Builder, KeyStore.CallbackHandlerProtection, KeyStore.Entry, KeyStore.LoadStoreParameter, KeyStore.PasswordProtection, KeyStore.PrivateKeyEntry, KeyStore.ProtectionParameter, KeyStore.SecretKeyEntry, KeyStore.TrustedCertificateEntry

Field Summary

Fields

Modifier and Type	Field	Description
private AtomicLoadKeyStoreSpi	keyStoreSpi

Constructor Summary

Constructors

Modifier	Constructor	Description
private	AtomicLoadKeyStore(AtomicLoadKeyStoreSpi keyStoreSpi, Provider provider, String type)

Method Summary

Modifier and Type	Method	Description
static AtomicLoadKeyStore	atomize(KeyStore keyStore)	Create a new AtomicLoadKeyStore instance that wraps specified KeyStore.
static AtomicLoadKeyStore	newInstance(String type)	Create a new AtomicLoadKeyStore wrapping a KeyStore of the type specified.
static AtomicLoadKeyStore	newInstance(String type, String provider)	Create a new AtomicLoadKeyStore wrapping a KeyStore of the type specified.
static AtomicLoadKeyStore	newInstance(String type, Provider provider)	Create a new AtomicLoadKeyStore wrapping a KeyStore or the specified type, obtained from the supplied Provider.
void	revert(AtomicLoadKeyStore.LoadKey key)	Atomically evert the keystore to a previous state.
AtomicLoadKeyStore.LoadKey	revertibleLoad(InputStream inputStream, char[] password)	Performs the same action as KeyStore.load(InputStream, char[]) except a AtomicLoadKeyStore.LoadKey is returned that can be used to revert the load.
private void	setKeyStore(KeyStore keyStore)

Methods inherited from class java.security.KeyStore

aliases, containsAlias, deleteEntry, entryInstanceOf, getCertificate, getCertificateAlias, getCertificateChain, getCreationDate, getDefaultType, getEntry, getInstance, getInstance, getInstance, getInstance, getInstance, getKey, getProvider, getType, isCertificateEntry, isKeyEntry, load, load, setCertificateEntry, setEntry, setKeyEntry, setKeyEntry, size, store, store

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

keyStoreSpi

private final AtomicLoadKeyStoreSpi keyStoreSpi

Constructor Detail

AtomicLoadKeyStore

private AtomicLoadKeyStore(AtomicLoadKeyStoreSpi keyStoreSpi,
                           Provider provider,
                           String type)

Method Detail

newInstance

public static AtomicLoadKeyStore newInstance(String type,
                                             Provider provider)

Create a new AtomicLoadKeyStore wrapping a KeyStore or the specified type, obtained from the supplied Provider.

Parameters:

type - the type of the KeyStore to wrap

provider - the Provider to use to create the KeyStore instance.

Returns:

the new AtomicLoadKeyStore instance

newInstance

public static AtomicLoadKeyStore newInstance(String type,
                                             String provider)
                                      throws KeyStoreException,
                                             NoSuchProviderException

Create a new AtomicLoadKeyStore wrapping a KeyStore of the type specified.

Parameters:

type - the type of KeyStore to be wrapped

provider - the provide to use to create the KeyStore

Returns:

the new AtomicLoadKeyStore instance

Throws:

KeyStoreException - If there is a problem creating the KeyStore

NoSuchProviderException - if the provider specified can not be found.

newInstance

public static AtomicLoadKeyStore newInstance(String type)
                                      throws KeyStoreException

Create a new AtomicLoadKeyStore wrapping a KeyStore of the type specified.

Parameters:

type - the type of KeyStore to be wrapped

Returns:

the new AtomicLoadKeyStore instance

Throws:

KeyStoreException - If there is a problem creating the KeyStore

atomize

public static AtomicLoadKeyStore atomize(KeyStore keyStore)
                                  throws CertificateException,
                                         NoSuchAlgorithmException,
                                         IOException

Create a new AtomicLoadKeyStore instance that wraps specified KeyStore.

Parameters:

keyStore - the KeyStore to be wrapped

Returns:

the new AtomicLoadKeyStore instance

Throws:

CertificateException

NoSuchAlgorithmException

IOException

setKeyStore

private void setKeyStore(KeyStore keyStore)

revertibleLoad

public AtomicLoadKeyStore.LoadKey revertibleLoad(InputStream inputStream,
                                                 char[] password)
                                          throws NoSuchAlgorithmException,
                                                 CertificateException,
                                                 IOException

Performs the same action as KeyStore.load(InputStream, char[]) except a AtomicLoadKeyStore.LoadKey is returned that can be used to revert the load.

Parameters:

inputStream - the stream to load from or null

password - the password used to protect the contents of the KeyStore or null

Returns:

a AtomicLoadKeyStore.LoadKey that can be used to revert the load and restore the previous KeyStore state

Throws:

NoSuchAlgorithmException - if the keystore cannot be read due to a missing algorithm

CertificateException - if the keystore cannot be read due to a certificate problem

IOException - if the keystore cannot be read due to an I/O problem

revert

public void revert(AtomicLoadKeyStore.LoadKey key)

Atomically evert the keystore to a previous state.

Parameters:

key - the load key