com.entrust.toolkit.credentials

Class CapiIdentity

java.lang.Object

com.entrust.toolkit.credentials.Identity

com.entrust.toolkit.credentials.CapiIdentity

public class CapiIdentity
extends Identity

This class stores information about a user identity in CAPI.

This class cannot be instantiated directly. An instance can only be obtained by calling the method CapiIdentities.findIdentities(), and iterating over the result.

A CapiIdentity is formed by grouping together certificates which belong to the same identity in the Certification Authority. The matching of certificates to an identity is done by private key container name, which have specific naming rules.

Since:

7.0

See Also:

CapiIdentities

Nested Class Summary

Nested classes/interfaces inherited from class com.entrust.toolkit.credentials.Identity

Identity.Format

Field Summary

Fields inherited from class com.entrust.toolkit.credentials.Identity

m_idenityName, m_identityIssuer, m_unverifiedIdentity

Method Summary

Modifier and Type	Method and Description
protected void	addCertificateAndKeyInfo(CertificateAndKeyInfo certAndKeyInfo) Adds the given certificate and key information to the current identity.
java.util.Collection<CapiCertificateAndKeyInfo>	getCertificateAndKeyInfo() Returns an unmodifiable collection of CapiCertificateAndKeyInfos
CapiContainerName	getContainerName() Returns a key container name associated with this identity.
Identity.Format	getFormat() Returns the digital identity format.

Methods inherited from class com.entrust.toolkit.credentials.Identity

getChainToRoot, getDistinguishedIssuerName, getDistinguishedName, getIssuerName, getName, isUnverifiedIdentity, setChainToRoot

Methods inherited from class java.lang.Object

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

Method Detail

addCertificateAndKeyInfo

protected void addCertificateAndKeyInfo(CertificateAndKeyInfo certAndKeyInfo)

Adds the given certificate and key information to the current identity. The information is only added if the key container name has not already been added to this identity.

Parameters:

certAndKeyInfo - the certificate and key information to add.

getCertificateAndKeyInfo

public java.util.Collection<CapiCertificateAndKeyInfo> getCertificateAndKeyInfo()

Returns an unmodifiable collection of CapiCertificateAndKeyInfos

Specified by:

getCertificateAndKeyInfo in class Identity

Returns:

an unmodifiable collection of CapiCertificateAndKeyInfos

getContainerName

public CapiContainerName getContainerName()

Returns a key container name associated with this identity.

Specified by:

getContainerName in class Identity

Returns:

a container name associated with this identity.

getFormat

public Identity.Format getFormat()

Returns the digital identity format.

Specified by:

getFormat in class Identity

Returns:

the digital identity format