com.entrust.toolkit.credentials

Class CapiCredentialReader

java.lang.Object

com.entrust.toolkit.credentials.CredentialReader

com.entrust.toolkit.credentials.CapiCredentialReader

public final class CapiCredentialReader
extends CredentialReader

A CredentialReader for reading a Digital Identity from CAPI. This class can be created in one of two ways, either by providing an array of handles to CAPI certificates, or by providing a CapiIdentity object. The method using the CapiIdentity object is the preferred way, the array of certificate handles is for specialized uses for when the set of certificates chosen by the CapiIdentity is not appropriate.

No CredentialWriter object can be used in conjunction with a CapiCredentialReader; a Digital Identity read from CAPI is strictly read-only.

When calling User.login() with a CapiCredentialReader, supply null as the password. With CAPI, the key protection mechanism may not be password based, and is up to the CAPI CSP to enforce.

Since:

7.0

See Also:

CapiIdentity, CapiIdentities

Constructor Summary

Constructors

Constructor and Description
CapiCredentialReader(CapiIdentity identity) Create a CapiCredentialReader that reads certificates and keys for the given CapiIdentity.
CapiCredentialReader(CertContext[] contexts) Create a CapiCredentialReader that reads certificates and keys from the given array CertContext objects.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getType() Returns the type (name) of this CredentialReader.

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

checkPwd

Methods inherited from class java.lang.Object

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

Constructor Detail

CapiCredentialReader

public CapiCredentialReader(CapiIdentity identity)

Create a CapiCredentialReader that reads certificates and keys for the given CapiIdentity. The identity should be created by calling CapiIdentities.findIdentities(), then selecting the appropriate identity from the returned list.

Parameters:

identity - The identity to read keys and certificates for.

CapiCredentialReader

public CapiCredentialReader(CertContext[] contexts)

Create a CapiCredentialReader that reads certificates and keys from the given array CertContext objects. This is for advanced usage, when the set of keys and certificates selected by a CapiIdentity is not appropriate. While it would be possible to pick certificates from different identities, and even different CAs, the behaviour under such circumstances is undefined.

Parameters:

contexts - The certificates from which to obtain the private key/certificate pairs.

Method Detail

getType

public java.lang.String getType()

Returns the type (name) of this CredentialReader.

Specified by:

getType in class CredentialReader

Returns:

The type (name) of the CredentialReader