org.symphonyoss.s2.common.crypto.cert

Class CertificateBuilder

java.lang.Object

org.symphonyoss.s2.common.crypto.cert.CertificateBuilder

public class CertificateBuilder
extends Object

A builder for certificates. The builder maintains a complete set of parameters for creating new certificates. All parameters have valid defaults so new CertificateBuilder(signingCert).build(); will not fail, but it would be unwise to rely on the defaults and callers should carefully consider initializing all values. CertificateBuilder instances are reusable and the withXXX() methods all return the existing builder, not a copy. Each certificate should have a unique serial number. The build method increments the serial number so if you use the same builder to create several certificates then they will have consecutive serial numbers. You can provide a KeyPair to the builder, or if you do not it will generate one. The KeyPair is automatically cleared by the build method to prevent the same key being used for multiple certificate inadvertently.

Author:

Bruce Skingle

Constructor Summary

Constructors

Constructor and Description
CertificateBuilder(IIntermediateCertificate signingCert) Create a CertificateBuilder for the given certificate signing certificate.
CertificateBuilder(IIntermediateCertificate signingCert, CertificateBuilder other) Create a CertificateBuilder for the given certificate signing certificate.

Method Summary

Modifier and Type	Method and Description
CertificateBuilder	addOrgUnitName(String orgUnitName)
IOpenCertificate	build()
CertType	getCertType()
String	getCommonName()
String	getCountryName()
KeyPair	getKeyPair()
Date	getNotAfter()
Date	getNotBefore()
URL	getOcspUrl()
String	getOrgName()
List<String>	getOrgUnitNames()
BigInteger	getSerial()
String	getStateName()
CertificateBuilder	withCertType(CertType certType)
CertificateBuilder	withCommonName(String commonName)
CertificateBuilder	withCountryName(String countryName)
CertificateBuilder	withKeyPair(KeyPair keyPair) Set the KeyPair to be used for the next certificate creation.
CertificateBuilder	withNotAfter(Date notAfter)
CertificateBuilder	withNotBefore(Date notBefore)
CertificateBuilder	withOcspUrl(URL ocspUrl)
CertificateBuilder	withOrganizationName(String orgName)
CertificateBuilder	withOrgName(String orgName)
CertificateBuilder	withOrgUnitName(String orgUnitName)
CertificateBuilder	withSerial(BigInteger serial)
CertificateBuilder	withStateName(String stateName)
CertificateBuilder	withValidityDays(int days)
CertificateBuilder	withValidityMonths(int months)

Methods inherited from class java.lang.Object

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

Constructor Detail

CertificateBuilder

public CertificateBuilder(IIntermediateCertificate signingCert)

Create a CertificateBuilder for the given certificate signing certificate.

Parameters:

signingCert - a certificate signing certificate.

CertificateBuilder

public CertificateBuilder(IIntermediateCertificate signingCert,
                          CertificateBuilder other)

Create a CertificateBuilder for the given certificate signing certificate.

Parameters:

signingCert - a certificate signing certificate.

other - Another CertificateBuilder from which other parameters should be initialized.

Method Detail

withCertType

public CertificateBuilder withCertType(CertType certType)

withNotBefore

public CertificateBuilder withNotBefore(Date notBefore)

withNotAfter

public CertificateBuilder withNotAfter(Date notAfter)

withValidityMonths

public CertificateBuilder withValidityMonths(int months)

withValidityDays

public CertificateBuilder withValidityDays(int days)

withSerial

public CertificateBuilder withSerial(BigInteger serial)

withOrgName

public CertificateBuilder withOrgName(String orgName)

withCountryName

public CertificateBuilder withCountryName(String countryName)

withStateName

public CertificateBuilder withStateName(String stateName)

withOrganizationName

public CertificateBuilder withOrganizationName(String orgName)

withOrgUnitName

public CertificateBuilder withOrgUnitName(String orgUnitName)

addOrgUnitName

public CertificateBuilder addOrgUnitName(String orgUnitName)

withCommonName

public CertificateBuilder withCommonName(String commonName)

withOcspUrl

public CertificateBuilder withOcspUrl(URL ocspUrl)

withKeyPair

public CertificateBuilder withKeyPair(KeyPair keyPair)
                               throws InvalidKeyException

Set the KeyPair to be used for the next certificate creation.

Parameters:

keyPair - The KeyPair which is to be bound to the certificate.

Returns:

The current CertificateBuilder. (Fluent interface)

Throws:

InvalidKeyException - If the given KeyPair is incompatible with the CipherSuirte of the signing cert associated with this builder.

getNotBefore

public Date getNotBefore()

getNotAfter

public Date getNotAfter()

getSerial

public BigInteger getSerial()

getCountryName

public String getCountryName()

getStateName

public String getStateName()

getOrgName

public String getOrgName()

getOrgUnitNames

public List<String> getOrgUnitNames()

getCommonName

public String getCommonName()

getCertType

public CertType getCertType()

getKeyPair

public KeyPair getKeyPair()

getOcspUrl

public URL getOcspUrl()

build

public IOpenCertificate build()