com.entrust.toolkit.credentials

Class CapiIdentity

java.lang.Object

com.entrust.toolkit.credentials.CapiIdentity

public class CapiIdentity
extends java.lang.Object

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

Modifier and Type	Class and Description
static class	CapiIdentity.Format An MSCAPI-based digital identity format.

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Collection<CapiCertificateAndKeyInfo>	getCertificateAndKeyInfo() Returns an unmodifiable collection of CapiCertificateAndKeyInfos
X509Certificate[]	getChainToRoot()
CapiContainerName	getContainerName() Returns a key container name associated with this identity.
Name	getDistinguishedIssuerName() Returns the distinguished name of the issuer of this Identity This is the issuer name of the newest certificate associated with this identity.
Name	getDistinguishedName() Returns the distinguished name of this identity.
CapiIdentity.Format	getFormat() Returns the MSCAPI-based digital identity format.
java.lang.String	getIssuerName() Returns the name of the issuer of this identity.
java.lang.String	getName() Returns the name of this identity.
boolean	isUnverifiedIdentity()
void	setChainToRoot(X509Certificate[] chainToRoot) This method is for injecting the chainToRoot into the CapiIdentity.

Methods inherited from class java.lang.Object

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

Method Detail

getName

public java.lang.String getName()

Returns the name of this identity. This simply calls getDistinguishedName().toString().

Returns:

the name of this identity as a String

getIssuerName

public java.lang.String getIssuerName()

Returns the name of the issuer of this identity. This simply calls getDistinguishedIssuerName().toString().

Returns:

the name of the issuer of this identity as a String

getDistinguishedName

public Name getDistinguishedName()

Returns the distinguished name of this identity. This is the subject name of the newest certificate associated with this identity.

Returns:

the distinguished name of this identity

getDistinguishedIssuerName

public Name getDistinguishedIssuerName()

Returns the distinguished name of the issuer of this Identity This is the issuer name of the newest certificate associated with this identity.

Returns:

the distinguished name of this identity's issuer

getContainerName

public CapiContainerName getContainerName()

Returns a key container name associated with this identity.

Returns:

a container name associated with this identity.

getCertificateAndKeyInfo

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

Returns an unmodifiable collection of CapiCertificateAndKeyInfos

Returns:

an unmodifiable collection of CapiCertificateAndKeyInfos

isUnverifiedIdentity

public boolean isUnverifiedIdentity()

Returns:

whether or not this Identity represents an Unverified identity. An unverified identity only contains end-user certificates in CAPI. The chain to the root CA is not stored in CAPI in an unverified identity.

setChainToRoot

public void setChainToRoot(X509Certificate[] chainToRoot)

This method is for injecting the chainToRoot into the CapiIdentity. This will allow an unverified identity to be used by injecting the required CA certificates for this identity.

Parameters:

chainToRoot - The chain of CA certificates to the self-signed root

getChainToRoot

public X509Certificate[] getChainToRoot()

Returns:

the List of certificates injected into this identity

getFormat

public CapiIdentity.Format getFormat()

Returns the MSCAPI-based digital identity format.

Returns:

the MSCAPI-based digital identity format