org.apache.clerezza.ssl.keygen

Interface Certificate

All Known Implementing Classes:

DefaultCertificate

public interface Certificate

Author:

Henry J. Story

Field Summary

Fields

Modifier and Type	Field and Description
static long	DAY
static long	HOUR
static long	SECOND
static long	YEAR

Method Summary

Methods

Modifier and Type	Method and Description
void	addDurationInDays(String days) set duration of cert in days.
void	addDurationInHours(String hours) set the duration of the certificate in hours Useful for short durations ( for public kiosks for example ) If days is set then this will be added to the days.
void	addSubjectAlternativeName(String san) Set the WebID for the certificate.
X509Certificate	getCertificate()
Date	getEndDate()
CertSerialisation	getSerialisation() get the encoded version of this certificate in a binary form
Date	getStartDate()
PubKey	getSubjectPublicKey()
void	setDefaultSerialisation(CertSerialisation ser) When we create a certificate we already know the serialisation it is going to require.
void	setEndDate(Date endDate) set the end date of validity of the certificate.
void	setStartDate(Date startDate)
void	setSubjectCommonName(String name)
void	startEarlier(String hours) in order to avoid synchronization problems it is good to set the start date to be somewhat earlier than the current time.

Field Detail

SECOND

static final long SECOND

See Also:

Constant Field Values

HOUR

static final long HOUR

See Also:

Constant Field Values

DAY

static final long DAY

See Also:

Constant Field Values

YEAR

static final long YEAR

See Also:

Constant Field Values

Method Detail

getCertificate

X509Certificate getCertificate()

Returns:

the X509 Certificate

addSubjectAlternativeName

void addSubjectAlternativeName(String san)

Set the WebID for the certificate. The first SAN added will appear in the Distinguished Name

Parameters:

san, - a Subject Alternative Name to add. Must be a full URL, usually the WebID

setSubjectCommonName

void setSubjectCommonName(String name)

Parameters:

name - he user should set a himself a name that will be easily recognised in the browser. Eg: "Henry-public"

setStartDate

void setStartDate(Date startDate)

Parameters:

startDate - Set the start date for the validity of the certificate. If unset it will be now.

getStartDate

Date getStartDate()

Returns:

the start validity date for the certificate

setEndDate

void setEndDate(Date endDate)

set the end date of validity of the certificate. If unset it will be one year from start date, if the duration is not set. Or the duration in days and hours from the start date.

Parameters:

endDate - end date

getEndDate

Date getEndDate()

Returns:

end validity date for the certificate

addDurationInDays

void addDurationInDays(String days)

set duration of cert in days. Easier to set than the end date.

Parameters:

days - the duration of the certificate in days, as a floating point number

startEarlier

void startEarlier(String hours)

in order to avoid synchronization problems it is good to set the start date to be somewhat earlier than the current time. This time is then added to the length of time the certificate is meant to last.

Parameters:

hours - a floating point number

addDurationInHours

void addDurationInHours(String hours)

set the duration of the certificate in hours Useful for short durations ( for public kiosks for example ) If days is set then this will be added to the days.

Parameters:

hours - as floats, encoded as strings (it is easier to get a string from velocity). Partial hours are possible

getSubjectPublicKey

PubKey getSubjectPublicKey()

Returns:

the subject's public key

setDefaultSerialisation

void setDefaultSerialisation(CertSerialisation ser)

When we create a certificate we already know the serialisation it is going to require. So this method is here to set it.

note: this could perhaps better be done in the constructor. It is not clear that this will be needed by scripts, so perhaps it should not be here

Parameters:

ser - the serialisation implementation

getSerialisation

CertSerialisation getSerialisation()
                                   throws Exception

get the encoded version of this certificate in a binary form

Returns:

the serialisation object (which sets headers, mime types, length, etc..)

Throws:

Exception - why? //todo: is this really needed