com.adaptris.security.keystore

Class CompositeKeystore

java.lang.Object

com.adaptris.security.keystore.CompositeKeystore

All Implemented Interfaces:

KeystoreProxy

public class CompositeKeystore
extends java.lang.Object
implements KeystoreProxy

Composite keystore which manages keystores of different types.

This is essentially a convenience wrapper around a list of KeystoreProxy objects and exposes commonly used methods.

The CompositeKeystore is case insensitive for matching aliases, MYPRIVATEKEY is considered semantically equivalent to myprivatekey

Constructor Summary

Constructors

Constructor and Description
CompositeKeystore() Default constructor.
CompositeKeystore(KeystoreFactory kf, java.util.List<KeystoreLocation> keystoreList) Constructor supplying both the factory and list of keystore locations.
CompositeKeystore(java.util.List<KeystoreLocation> l) Constructor using the default KeystoreFactory

Method Summary

Modifier and Type	Method and Description
void	addKeystore(KeystoreLocation keyFile) Adds a keystore file to the keystore list.
java.util.Enumeration<java.lang.String>	aliases() Gets all the aliases of the keystores pointed by this composite keystore.
boolean	containsAlias(java.lang.String alias) Checks if the given alias exists in this keystore.
java.security.cert.Certificate	getCertificate(java.lang.String alias) Return the certificate specified by the given alias.
java.security.cert.Certificate[]	getCertificateChain(java.lang.String alias) Return the certificate specified by the given alias.
java.security.KeyStore	getKeystore() Return the keystore.
java.security.PrivateKey	getPrivateKey(java.lang.String alias, char[] password) Method to extract a Partner's Private Key from their Keystore entry and return a PrivateKey object to the caller.
void	load() Load the keystore.
void	setKeystoreLocation(KeystoreLocation k) Set the internal KeystoreLocation object to be used.
void	setKeystores(java.util.List<KeystoreLocation> l)
int	size() Gets the total number of keys/certificates in all the keystores pointed by this composite keystore.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.adaptris.security.keystore.KeystoreProxy

commit, importCertificateChain, importCertificateChain, importCertificateChain, importPrivateKey, importPrivateKey, importPrivateKey, setCertificate, setCertificate, setCertificate, setCertificate, setPrivateKey, wrapException

Constructor Detail

CompositeKeystore

public CompositeKeystore()

Default constructor.

CompositeKeystore

public CompositeKeystore(java.util.List<KeystoreLocation> l)

Constructor using the default KeystoreFactory

Parameters:

l - a list of KeystoreLocation objects

CompositeKeystore

public CompositeKeystore(KeystoreFactory kf,
                         java.util.List<KeystoreLocation> keystoreList)

Constructor supplying both the factory and list of keystore locations.

Parameters:

kf - the keystoreFactory to use.

keystoreList - a list of KeystoreLocation objects

Method Detail

addKeystore

public void addKeystore(KeystoreLocation keyFile)

Adds a keystore file to the keystore list.

Parameters:

keyFile - the name of the keystore file

setKeystores

public void setKeystores(java.util.List<KeystoreLocation> l)

Parameters:

l - the list of KeystoreLocation objects.

load

public void load()
          throws AdaptrisSecurityException

Description copied from interface: KeystoreProxy

Load the keystore.

Load the keystore ready for operations upon it

Specified by:

load in interface KeystoreProxy

Throws:

AdaptrisSecurityException - if there was an error reading the contents of the keystore

See Also:

KeystoreProxy.load()

aliases

public java.util.Enumeration<java.lang.String> aliases()
                                                throws AdaptrisSecurityException

Gets all the aliases of the keystores pointed by this composite keystore.

Returns:

an enumeration of string, holding the aliases of the keys

Throws:

AdaptrisSecurityException

size

public int size()
         throws AdaptrisSecurityException

Gets the total number of keys/certificates in all the keystores pointed by this composite keystore.

Returns:

the total number of keys/certificates

Throws:

AdaptrisSecurityException

containsAlias

public boolean containsAlias(java.lang.String alias)
                      throws AdaptrisSecurityException

Description copied from interface: KeystoreProxy

Checks if the given alias exists in this keystore.

Specified by:

containsAlias in interface KeystoreProxy

Parameters:

alias - the alias to check of

Returns:

true if it does contain this alias

Throws:

AdaptrisSecurityException - for any error

See Also:

KeystoreProxy.containsAlias(String)

getCertificate

public java.security.cert.Certificate getCertificate(java.lang.String alias)
                                              throws AdaptrisSecurityException

Description copied from interface: KeystoreProxy

Return the certificate specified by the given alias.

Specified by:

getCertificate in interface KeystoreProxy

Parameters:

alias - the alias of the Certificate

Returns:

Certificate the requested certificate, or null if the alias does not exist/not a certificate

Throws:

AdaptrisSecurityException - for any error

See Also:

KeystoreProxy.getCertificate(String)

getPrivateKey

public java.security.PrivateKey getPrivateKey(java.lang.String alias,
                                              char[] password)
                                       throws AdaptrisSecurityException

Description copied from interface: KeystoreProxy

Method to extract a Partner's Private Key from their Keystore entry and return a PrivateKey object to the caller.

Specified by:

getPrivateKey in interface KeystoreProxy

Parameters:

alias - the alias in the keystore

password - the associated password

Returns:

the requested private key, or null if the alias does not exist/not a key entry

Throws:

AdaptrisSecurityException - for any error

See Also:

KeystoreProxy.getPrivateKey(String, char[])

getCertificateChain

public java.security.cert.Certificate[] getCertificateChain(java.lang.String alias)
                                                     throws AdaptrisSecurityException

Description copied from interface: KeystoreProxy

Return the certificate specified by the given alias.

Specified by:

getCertificateChain in interface KeystoreProxy

Parameters:

alias - the alias of the Certificate Chain

Returns:

the requested certificate chain, or null if the alias does not exist/not a certificate.

Throws:

AdaptrisSecurityException - for any error

See Also:

KeystoreProxy.getCertificateChain(java.lang.String)

getKeystore

public java.security.KeyStore getKeystore()

Return the keystore.

In this instance, the keystore object is always null as we do not wrap multiple keystore.

Specified by:

getKeystore in interface KeystoreProxy

Returns:

the underlying keystore, maybe null if there is no underlying keystore

See Also:

KeystoreProxy.getKeystore()

setKeystoreLocation

public void setKeystoreLocation(KeystoreLocation k)
                         throws AdaptrisSecurityException

Description copied from interface: KeystoreProxy

Set the internal KeystoreLocation object to be used.

Based on this information, a new KeyStore object is created, and initialised.

Specified by:

setKeystoreLocation in interface KeystoreProxy

Parameters:

k - the KeystoreProxy object

Throws:

AdaptrisSecurityException - wrapping the underlying exception

See Also:

KeystoreProxy.setKeystoreLocation(KeystoreLocation)