com.entrust.toolkit.credentials

Class CertificateAndKeyInfo

java.lang.Object

com.entrust.toolkit.credentials.CertificateAndKeyInfo

Direct Known Subclasses:

CapiCertificateAndKeyInfo, GenericCertificateAndKeyInfo, KeychainCertificateAndKeyInfo

public class CertificateAndKeyInfo
extends java.lang.Object

This class is used to encapsulate information regarding an asymmetric key pair (a public key and a private key). It also stores other information related to this keypair such as information that allow these keypairs to be managed.

Since:

9.0

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.Boolean	m_archived The cached value of the Archived flag
protected byte[]	m_certDefinitionPolicyCert The cached value of the Certificate Definition Policy certificate
protected X509Certificate	m_certificate The end user certificate.
protected java.lang.Integer	m_certPubPending The cached value of the certificate publication pending property
protected java.util.List<X509Certificate>	m_chainToRoot The CA certificate chain for the end user certificate; excludes the end user certificate.
protected ContainerName	m_containerName The name of the key container in which the end user private key is stored
protected EntrustEventIdentifier	m_eventIdentifier The cached value of the Entrust event Identifier
protected java.lang.Byte	m_eventIndicator The cached value of the event Indicator
protected java.lang.String	m_friendlyName The cached value of the Friendly Name
protected byte[]	m_policyCert The cached value of the certificate property.
protected byte[]	m_userRoleId The cached value of the user Role ID

Constructor Summary

Constructors

Constructor and Description
CertificateAndKeyInfo()

Method Summary

Modifier and Type	Method and Description
X509Certificate	getCertificate() Returns the certificate associated with this object
java.util.List<X509Certificate>	getChainToRoot() Returns a List of X509Certificate objects that form a chain from the certificate up to a trusted root.
ContainerName	getContainerName() Returns the private key container name associated with this object.
protected EntrustEventIdentifier	getEventIdentifier() Gets the cached value of the certificate property nkeypair event identifier certificate property.
protected java.lang.Byte	getEventIndicator() Gets the cached value of the event indicator certificate property.
protected java.lang.String	getFriendlyName() Gets the cached value of the friendly Name certificate property.
boolean	isArchived() Returns whether or not the certificate is archived.
protected void	setChainToRoot(java.util.List<X509Certificate> list) Sets the chain to the root.
protected static java.lang.String	toMessageString(X509Certificate cert) Creates a string identifier for a certificate intended for use in exception messages and log messages ; contains the issuer DN, subject DN, and serial number.

Methods inherited from class java.lang.Object

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

Field Detail

m_certificate

protected X509Certificate m_certificate

The end user certificate.

m_chainToRoot

protected java.util.List<X509Certificate> m_chainToRoot

The CA certificate chain for the end user certificate; excludes the end user certificate.

m_containerName

protected ContainerName m_containerName

The name of the key container in which the end user private key is stored

m_friendlyName

protected java.lang.String m_friendlyName

The cached value of the Friendly Name

m_archived

protected java.lang.Boolean m_archived

The cached value of the Archived flag

m_policyCert

protected byte[] m_policyCert

The cached value of the certificate property.

m_certPubPending

protected java.lang.Integer m_certPubPending

The cached value of the certificate publication pending property

m_certDefinitionPolicyCert

protected byte[] m_certDefinitionPolicyCert

The cached value of the Certificate Definition Policy certificate

m_eventIdentifier

protected EntrustEventIdentifier m_eventIdentifier

The cached value of the Entrust event Identifier

m_eventIndicator

protected java.lang.Byte m_eventIndicator

The cached value of the event Indicator

m_userRoleId

protected byte[] m_userRoleId

The cached value of the user Role ID

Constructor Detail

CertificateAndKeyInfo

public CertificateAndKeyInfo()

Method Detail

toMessageString

protected static java.lang.String toMessageString(X509Certificate cert)

Creates a string identifier for a certificate intended for use in exception messages and log messages ; contains the issuer DN, subject DN, and serial number.

Parameters:

cert - an X.509 certificate

Returns:

a string identifier for the certificate

Since:

8.0

getCertificate

public X509Certificate getCertificate()

Returns the certificate associated with this object

Returns:

the certificate associated with this object

getChainToRoot

public java.util.List<X509Certificate> getChainToRoot()

Returns a List of X509Certificate objects that form a chain from the certificate up to a trusted root. The certificates are ordered from the target certificate at the start of the list to the root at the end.

Returns:

a List of X509Certificate objects that form a chain from the certificate up to a trusted root.

getContainerName

public ContainerName getContainerName()

Returns the private key container name associated with this object.

Returns:

the private key container name associated with this object.

isArchived

public boolean isArchived()

Returns whether or not the certificate is archived.

Returns:

true if the certificate has been marked as archived or false otherwise.

getFriendlyName

protected java.lang.String getFriendlyName()

Gets the cached value of the friendly Name certificate property.

Returns:

the value of the friendly name certificate property; null if the certificate property was not set or is invalid

Since:

8.0

getEventIdentifier

protected EntrustEventIdentifier getEventIdentifier()

Gets the cached value of the certificate property nkeypair event identifier certificate property.

Returns:

the value of the certificate property nkeypair event identifier certificate property; null if the certificate property was not set or is invalid

Since:

8.0

getEventIndicator

protected java.lang.Byte getEventIndicator()

Gets the cached value of the event indicator certificate property.

Returns:

the value of the event indicator certificate property; null if the certificate property was not set or is invalid

Since:

8.0

setChainToRoot

protected void setChainToRoot(java.util.List<X509Certificate> list)

Sets the chain to the root.

Parameters:

list - a List of X509Certificate objects that form a chain from the certificate to a trusted root.