ch.icosys.popjava.core.util.ssl

Class KeyPairDetails

java.lang.Object

ch.icosys.popjava.core.util.ssl.KeyPairDetails

public class KeyPairDetails
extends java.lang.Object

This class is meant to be send to SSLUtils#generateKeyPair(popjava.util.ssl.KeyPairDetails)

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	alias
protected int	privateKeySize
protected java.util.Map<org.bouncycastle.asn1.ASN1ObjectIdentifier,java.lang.String>	rdn
protected java.util.Date	validUntil

Constructor Summary

Constructors

Constructor and Description
KeyPairDetails() Empty constructor
KeyPairDetails(KeyPairDetails other) Copy constructor
KeyPairDetails(java.lang.String alias) Parameters to create a KeyStore with sane defaults.
KeyPairDetails(java.lang.String alias, java.util.Date validUntil, int privateKeySize) Full constructor

Method Summary

Modifier and Type	Method and Description
void	addRDN(org.bouncycastle.asn1.ASN1ObjectIdentifier name, java.lang.String value) Specify the certificate Relative Distinguished Name (RDN).
java.lang.String	getAlias() The alias of the certificate
int	getPrivateKeySize() Size in bits when creating a private key
java.util.Map<org.bouncycastle.asn1.ASN1ObjectIdentifier,java.lang.String>	getRDN() Get the whole certificate name as a unmodifiable map
java.util.Date	getValidUntil() Until when is the certificate valid, only used for the key store creation
void	removeRDN(org.bouncycastle.asn1.ASN1ObjectIdentifier name) Remove element from the certificate name
void	setAlias(java.lang.String alias) Set the alias of the certificate
void	setPrivateKeySize(int keySize) The complexity of the RSA key, must be greater than 1024 bits
void	setValidFor(int days) For how many day from now should the certificate be valid
void	setValidUntil(java.util.Date validUntil) Until when the certificate should be valid
void	validate() Check that the parameters are valid

Methods inherited from class java.lang.Object

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

Field Detail

alias

protected java.lang.String alias

validUntil

protected java.util.Date validUntil

privateKeySize

protected int privateKeySize

rdn

protected final java.util.Map<org.bouncycastle.asn1.ASN1ObjectIdentifier,java.lang.String> rdn

Constructor Detail

KeyPairDetails

public KeyPairDetails()

Empty constructor

KeyPairDetails

public KeyPairDetails(KeyPairDetails other)

Copy constructor

Parameters:

other - the other KeyPair

KeyPairDetails

public KeyPairDetails(java.lang.String alias,
                      java.util.Date validUntil,
                      int privateKeySize)

Full constructor

Parameters:

alias - The alias of this node, used to find its own public certificate

validUntil - Until when the certificate should be valid

privateKeySize - The complexity of the RSA key, must be greater than 1024 bits

KeyPairDetails

public KeyPairDetails(java.lang.String alias)

Parameters to create a KeyStore with sane defaults. Consider using setValidFor(int) Defaults are: validity := 365 days keySize := 2048 bits

Parameters:

alias - The alias of this node, used to find its own public certificate

Method Detail

getAlias

public java.lang.String getAlias()

The alias of the certificate

Returns:

the key alias

setAlias

public void setAlias(java.lang.String alias)

Set the alias of the certificate

Parameters:

alias - the new alias of the key

getValidUntil

public java.util.Date getValidUntil()

Until when is the certificate valid, only used for the key store creation

Returns:

the validity of the certificate

setValidUntil

public void setValidUntil(java.util.Date validUntil)

Until when the certificate should be valid

Parameters:

validUntil - the new validity date

setValidFor

public void setValidFor(int days)

For how many day from now should the certificate be valid

Parameters:

days - the number of days the certificate will be valid from today (now)

getPrivateKeySize

public int getPrivateKeySize()

Size in bits when creating a private key

Returns:

the size of the private key in bits

setPrivateKeySize

public void setPrivateKeySize(int keySize)

The complexity of the RSA key, must be greater than 1024 bits

Parameters:

keySize - the new key size

addRDN

public void addRDN(org.bouncycastle.asn1.ASN1ObjectIdentifier name,
                   java.lang.String value)

Specify the certificate Relative Distinguished Name (RDN).

Parameters:

name - What we want to specify, like BCStyle.CN

value - the value for the RDN key

See Also:

BCStyle

removeRDN

public void removeRDN(org.bouncycastle.asn1.ASN1ObjectIdentifier name)

Remove element from the certificate name

Parameters:

name - the RDN (key,value) pair to remove

getRDN

public java.util.Map<org.bouncycastle.asn1.ASN1ObjectIdentifier,java.lang.String> getRDN()

Get the whole certificate name as a unmodifiable map

Returns:

the RDN which of this key

validate

public void validate()

Check that the parameters are valid