com.entrust.toolkit.credentials

Class CapiCSPConfigESP

java.lang.Object

com.entrust.toolkit.credentials.CapiCSPConfig

com.entrust.toolkit.credentials.CapiCSPConfigESP

Direct Known Subclasses:

CapiCSPConfigDefault

public abstract class CapiCSPConfigESP
extends CapiCSPConfig

This is a CapiCSPConfig object which behaves similar to Entrust Security Provider (ESP).

When a subclass of this CapiCSPConfig object is used, it will only call the getAnySCCSPSection() CallBack API at most 1 time when it encounters the "Any SmartCard" CSP policy. Therefore, all Certificate Definition Policies which have "Any SmartCard" defined in policy will use the same CSP.

Similar to Entrust Security Provider, the callBack API will only be called when a user is created or recovered, it will not be asked when an update operation is being performed.

Since:

8.0

Constructor Summary

Constructors

Constructor and Description
CapiCSPConfigESP(java.lang.String defaultCSP) Create a CapiCSPConfigESP that will use the default CSP

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAnySCCSPName(java.lang.String CertDefnName, java.lang.String[] cspList) This method will only ever call getAnySCCSPSelection(String, String[]) once.
abstract java.lang.String	getAnySCCSPSelection(java.lang.String CertDefnName, java.lang.String[] cspList) This method will be called when there is more than 1 smart card CSP installed on the System and the "Any SmartCard" policy has been selected in the PKI.

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

getDefaultCSP, getFailOnGetPreviousCSPFailure, getRequestAnySCCSPOnUpdate

Methods inherited from class java.lang.Object

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

Constructor Detail

CapiCSPConfigESP

public CapiCSPConfigESP(java.lang.String defaultCSP)

Create a CapiCSPConfigESP that will use the default CSP

Parameters:

defaultCSP - The default CSP to use

Method Detail

getAnySCCSPName

public java.lang.String getAnySCCSPName(java.lang.String CertDefnName,
                                        java.lang.String[] cspList)
                                 throws CapiException

This method will only ever call getAnySCCSPSelection(String, String[]) once. All Keys using the Any SmartCard policy will be mapped to the selected CSP.

Specified by:

getAnySCCSPName in class CapiCSPConfig

Parameters:

CertDefnName - The Certificate Definition Name of the policy which requires a Smart Card CSP to be selected

cspList - The list of Smart Card CSP's that are available

Returns:

A String representing the selected Smart Card CSP

Throws:

CapiException - if a problem occurs when trying to get the CSP

getAnySCCSPSelection

public abstract java.lang.String getAnySCCSPSelection(java.lang.String CertDefnName,
                                                      java.lang.String[] cspList)
                                               throws CapiException

This method will be called when there is more than 1 smart card CSP installed on the System and the "Any SmartCard" policy has been selected in the PKI.

Parameters:

CertDefnName - The Certificate definition policy setting

cspList - The list of SmartCard CSP's which the Smart Card CSP needs to select.

Returns:

the selected smart card CSP

Throws:

CapiException