com.entrust.toolkit.credentials

Class CapiCSPConfig

java.lang.Object

com.entrust.toolkit.credentials.CapiCSPConfig

Direct Known Subclasses:

CapiCSPConfigESP

public abstract class CapiCSPConfig
extends java.lang.Object

This class is used to configure the CSP used when generating keys in CAPI. It can be used for configuring the Smart Card CSP that is used when the "Any SmartCard" CSP policy is configured at Security Manager or the Default CSP to use when no CSP is configured at Security Manager. It is intended to be used as a CallBack, meaning the toolkit will call the methods specified below when required.

Since:

8.0

Constructor Summary

Constructors

Constructor and Description
CapiCSPConfig(java.lang.String defaultCSP, boolean requestAnySCCSPOnUpdate) Create A CapiCSPConfig object
CapiCSPConfig(java.lang.String defaultCSP, boolean requestAnySCCSPOnUpdate, boolean failOnGetPreviousCSPFailure) Create A CapiCSPConfig object

Method Summary

Modifier and Type	Method and Description
abstract java.lang.String	getAnySCCSPName(java.lang.String CertDefnName, java.lang.String[] cspList) This method is used when generating the keys in CAPI.
java.lang.String	getDefaultCSP() Return the default CSP used when generating the keys in CAPI.
boolean	getFailOnGetPreviousCSPFailure()
boolean	getRequestAnySCCSPOnUpdate()

Methods inherited from class java.lang.Object

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

Constructor Detail

CapiCSPConfig

public CapiCSPConfig(java.lang.String defaultCSP,
                     boolean requestAnySCCSPOnUpdate)

Create A CapiCSPConfig object

Parameters:

defaultCSP - the defaltCSP to use when no CSP is supplied

requestAnySCCSPOnUpdate - If the Any SmartCard CSP policy is required by the PKI, this parameters is used to determine whether the application will call this Objects getAnySCCSPName(String, String[]) when a key update is required. If set to false the previously used CSP will be used.

CapiCSPConfig

public CapiCSPConfig(java.lang.String defaultCSP,
                     boolean requestAnySCCSPOnUpdate,
                     boolean failOnGetPreviousCSPFailure)

Create A CapiCSPConfig object

Parameters:

defaultCSP - the defaltCSP to use when no CSP is supplied

requestAnySCCSPOnUpdate - If the Any SmartCard CSP policy is required by the PKI, this parameters is used to determine whether the application will call this Objects getAnySCCSPName(String, String[]) when a key update is required. If set to false the previously used CSP will be used.

failOnGetPreviousCSPFailure - Flag to indicate if the key management will fail if the users previous CSP cannot be determined. An Exception will be thrown to denote the failure.

Method Detail

getAnySCCSPName

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

This method is used when generating the keys in CAPI. This allows the application to provide a customized way to select the Smart Card CSP that should be used when the key is generated

Parameters:

CertDefnName - The Certificate Definition Policy Name for the key that will be generated

cspList - The List of Smart Card CSP's that can be used for the specified CertDefnName

Returns:

A String representing the selected Smart Card CSP

Throws:

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

getDefaultCSP

public java.lang.String getDefaultCSP()
                               throws CapiException

Return the default CSP used when generating the keys in CAPI. The default will be used when no "CSP to Manage Keys" has been specified

Returns:

The Name of the DefaultCSP

Throws:

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

getRequestAnySCCSPOnUpdate

public boolean getRequestAnySCCSPOnUpdate()

Returns:

True to request the Smart Card SSP to use when performing a CMP update operation when the PKI policy is set to Any smartCard. Return false to indicate that the previously used CSP will be used when performing an update operation.

getFailOnGetPreviousCSPFailure

public boolean getFailOnGetPreviousCSPFailure()

Returns:

True to cause exception when the Previous CSP cannot be determined from the users certificates. Will return false to indicate the the processing should continue and use the default CSP.