ch.icosys.popjava.core.util.ssl

Class KeyStoreDetails

java.lang.Object

ch.icosys.popjava.core.util.ssl.KeyStoreDetails

public class KeyStoreDetails
extends java.lang.Object

This class is meant describe a KeyStore for Configuration

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	KeyStoreDetails.KeyStoreFormat

Field Summary

Fields

Modifier and Type	Field and Description
protected java.io.File	keyStoreFile
protected KeyStoreDetails.KeyStoreFormat	keyStoreFormat
protected java.lang.String	keyStorePassword
protected java.lang.String	privateKeyPassword

Constructor Summary

Constructors

Constructor and Description
KeyStoreDetails() When using this constructor we must ensure validate() return true
KeyStoreDetails(KeyStoreDetails other) Copy constructor
KeyStoreDetails(java.lang.String storepass, java.lang.String keypass, java.io.File keyStoreFile) Parameters to create a KeyStore with JKS as default keystore
KeyStoreDetails(java.lang.String storepass, java.lang.String keypass, java.io.File keyStoreFile, KeyStoreDetails.KeyStoreFormat keyStoreFormat) Full constructor

Method Summary

Modifier and Type	Method and Description
java.io.File	getKeyStoreFile() The file pointing to the keystore
KeyStoreDetails.KeyStoreFormat	getKeyStoreFormat() The format of the keystore
java.lang.String	getKeyStorePassword()
java.lang.String	getPrivateKeyPassword() The password used to encrypt the private keys.
void	setKeyStoreFile(java.io.File keyStoreFile) Where to save the file
void	setKeyStoreFormat(KeyStoreDetails.KeyStoreFormat keyStoreFormat) Format of the keystore.
void	setKeyStorePassword(java.lang.String storepass) Password of the keystore file, protect the integrity of the file
void	setPrivateKeyPassword(java.lang.String keypass) Password of the Private Key in the KeyStore
void	validate()

Methods inherited from class java.lang.Object

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

Field Detail

keyStorePassword

protected java.lang.String keyStorePassword

privateKeyPassword

protected java.lang.String privateKeyPassword

keyStoreFile

protected java.io.File keyStoreFile

keyStoreFormat

protected KeyStoreDetails.KeyStoreFormat keyStoreFormat

Constructor Detail

KeyStoreDetails

public KeyStoreDetails()

When using this constructor we must ensure validate() return true

KeyStoreDetails

public KeyStoreDetails(KeyStoreDetails other)

Copy constructor

Parameters:

other - the key store we want to copy

KeyStoreDetails

public KeyStoreDetails(java.lang.String storepass,
                       java.lang.String keypass,
                       java.io.File keyStoreFile,
                       KeyStoreDetails.KeyStoreFormat keyStoreFormat)

Full constructor

Parameters:

storepass - The main password for the KeyStore, protect from tempering with the file

keypass - The password of the primate key, used to extract it

keyStoreFile - Where to save the file

keyStoreFormat - Which format to save the KeyStore: JKS, PKCS12 (may have issue)

KeyStoreDetails

public KeyStoreDetails(java.lang.String storepass,
                       java.lang.String keypass,
                       java.io.File keyStoreFile)

Parameters to create a KeyStore with JKS as default keystore

Parameters:

storepass - The main password for the KeyStore, protect from tempering with the file

keypass - The password of the primate key, used to extract it

keyStoreFile - Where to save the file

Method Detail

getKeyStorePassword

public java.lang.String getKeyStorePassword()

setKeyStorePassword

public void setKeyStorePassword(java.lang.String storepass)

Password of the keystore file, protect the integrity of the file

Parameters:

storepass - the new key store password

getPrivateKeyPassword

public java.lang.String getPrivateKeyPassword()

The password used to encrypt the private keys.

Returns:

the password of the key

setPrivateKeyPassword

public void setPrivateKeyPassword(java.lang.String keypass)

Password of the Private Key in the KeyStore

Parameters:

keypass - the new password of the key

getKeyStoreFile

public java.io.File getKeyStoreFile()

The file pointing to the keystore

Returns:

the location of the keystore

setKeyStoreFile

public void setKeyStoreFile(java.io.File keyStoreFile)

Where to save the file

Parameters:

keyStoreFile - the new keystore location

getKeyStoreFormat

public KeyStoreDetails.KeyStoreFormat getKeyStoreFormat()

The format of the keystore

Returns:

the format of the keystore

setKeyStoreFormat

public void setKeyStoreFormat(KeyStoreDetails.KeyStoreFormat keyStoreFormat)

Format of the keystore. Be aware that format different from JKS could have issues.

Parameters:

keyStoreFormat - the new format of the keystore

validate

public void validate()

Throws:

java.security.InvalidParameterException - when something is set incorrectly for creating a new KeyStore