Class KeyStoreDescriptor

java.lang.Object

org.refcodes.security.TrustStoreDescriptor

org.refcodes.security.KeyStoreDescriptor

All Implemented Interfaces:

org.refcodes.mixin.Disposable

public class KeyStoreDescriptor
extends TrustStoreDescriptor

The immutable KeyStoreDescriptor implements the TrustStoreDescriptor interface.

Constructor Summary

Constructors

Constructor	Description
KeyStoreDescriptor(File aStoreFile)	Constructs a KeyStoreDescriptor with the data required to access a KeyStore.
KeyStoreDescriptor(File aStoreFile, char[] aStorePassword)	Constructs a KeyStoreDescriptor with the data required to access a KeyStore.
KeyStoreDescriptor(File aStoreFile, char[] aStorePassword, char[] aKeyPassword)	Constructs a KeyStoreDescriptor with the data required to access a KeyStore.
KeyStoreDescriptor(File aStoreFile, StoreType aStoreType)	Constructs a KeyStoreDescriptor with the data required to access a KeyStore.
KeyStoreDescriptor(File aStoreFile, StoreType aStoreType, char[] aStorePassword)	Constructs a KeyStoreDescriptor with the data required to access a KeyStore.
KeyStoreDescriptor(File aStoreFile, StoreType aStoreType, char[] aStorePassword, char[] aKeyPassword)	Constructs a KeyStoreDescriptor with the data required to access a KeyStore.

Method Summary

Modifier and Type	Method	Description
void	dispose()
char[]	getKeyPassword()	Retrieves the key's password.

Methods inherited from class org.refcodes.security.TrustStoreDescriptor

getStoreFile, getStorePassword, getStoreType

Methods inherited from class java.lang.Object

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

Constructor Details

KeyStoreDescriptor

public KeyStoreDescriptor(File aStoreFile)

Constructs a KeyStoreDescriptor with the data required to access a KeyStore. The StoreType defaults to StoreType.JKS.

Parameters:

aStoreFile - The KeyStore File.

KeyStoreDescriptor

public KeyStoreDescriptor(File aStoreFile,
 StoreType aStoreType)

Constructs a KeyStoreDescriptor with the data required to access a KeyStore.

Parameters:

aStoreFile - The KeyStore File.

aStoreType - The KeyStore's StoreType.

KeyStoreDescriptor

public KeyStoreDescriptor(File aStoreFile,
 StoreType aStoreType,
 char[] aStorePassword)

Constructs a KeyStoreDescriptor with the data required to access a KeyStore.

Parameters:

aStoreFile - The KeyStore File.

aStoreType - The KeyStore's StoreType.

aStorePassword - The KeyStore password.

KeyStoreDescriptor

public KeyStoreDescriptor(File aStoreFile,
 char[] aStorePassword)

Constructs a KeyStoreDescriptor with the data required to access a KeyStore.

Parameters:

aStoreFile - The KeyStore File.

aStorePassword - The KeyStore password.

KeyStoreDescriptor

public KeyStoreDescriptor(File aStoreFile,
 char[] aStorePassword,
 char[] aKeyPassword)

Constructs a KeyStoreDescriptor with the data required to access a KeyStore.

Parameters:

aStoreFile - The KeyStore File.

aStorePassword - The KeyStore password.

aKeyPassword - The key password.

KeyStoreDescriptor

public KeyStoreDescriptor(File aStoreFile,
 StoreType aStoreType,
 char[] aStorePassword,
 char[] aKeyPassword)

Constructs a KeyStoreDescriptor with the data required to access a KeyStore.

Parameters:

aStoreFile - The KeyStore File.

aStoreType - The KeyStore's StoreType.

aStorePassword - The KeyStore password.

aKeyPassword - The key password.

Method Details

getKeyPassword

public char[] getKeyPassword()

Retrieves the key's password.

Returns:

The key password.

dispose

public void dispose()

Note: The passwords are overwritten with zeros and all fields are set to null: The instance will not be usable afterwards.

Specified by:

dispose in interface org.refcodes.mixin.Disposable

Overrides:

dispose in class TrustStoreDescriptor