com.entrust.toolkit.capi

Class CryptKeyProvInfo

java.lang.Object

com.entrust.toolkit.capi.CryptKeyProvInfo

public final class CryptKeyProvInfo
extends java.lang.Object

This class contains information about a CSP and private key that are associated with a public certificate. This class contains all the information needed to get a handle to a private key.

Instances are obtained by calling CertContext.getCertificateProperty and specifying CertPropertyId.CERT_KEY_PROV_INFO_PROP_ID as the property to get.

Since:

7.0

See Also:

MSDN library documentation for CertGetCertificateProperty

Constructor Summary

Constructors

Constructor and Description
CryptKeyProvInfo(CryptKey cryptKey) A constructor; creates a CryptKeyProvInfo that represents the provided MSAPI key.
CryptKeyProvInfo(java.lang.String containerName, java.lang.String providerName, ProviderType providerType, int flags, KeySpec keySpec) Public constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getContainerName() Returns the name of the container where the private key is stored.
int	getFlags() Returns the flags to use when acquiring a handle to the provider.
KeySpec	getKeySpec() Returns the key specification of the private key.
int	getKeySpecInt() Returns the key specification of the private key.
java.lang.String	getProviderName() Returns the name of the provider that owns the private key.
ProviderType	getProviderType() Returns the type of the provider that owns the private key.
int	getProviderTypeInt() Returns the type of the provider that owns the private key.
int	hashCode()
protected void	setParameters(java.lang.String containerName, java.lang.String providerName, int providerType, int flags, int keySpec) This method is called by native code to correctly initialize this object.

Methods inherited from class java.lang.Object

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

Constructor Detail

CryptKeyProvInfo

public CryptKeyProvInfo(java.lang.String containerName,
                        java.lang.String providerName,
                        ProviderType providerType,
                        int flags,
                        KeySpec keySpec)

Public constructor. It should not be necessary for code outside of the Toolkit to call this constructor.

Parameters:

containerName - The name of the container requested when the provider was acquired.

providerName - The name of the provider.

providerType - The type of the provider

flags - Any flags used when acquiring the provider.

keySpec - The key specifier

CryptKeyProvInfo

public CryptKeyProvInfo(CryptKey cryptKey)
                 throws CapiException

A constructor; creates a CryptKeyProvInfo that represents the provided MSAPI key.

Parameters:

cryptKey - an MSCAPI key

Throws:

CapiException - if the operation fails

Since:

8.0

Method Detail

setParameters

protected void setParameters(java.lang.String containerName,
                             java.lang.String providerName,
                             int providerType,
                             int flags,
                             int keySpec)

This method is called by native code to correctly initialize this object. It is not intended to be used by code outside the Toolkit.

Parameters:

containerName - The name of the container requested when the provider was acquired.

providerName - The name of the provider.

providerType - The type of the provider

flags - Any flags used when acquiring the provider.

keySpec - The key specification.

getContainerName

public java.lang.String getContainerName()

Returns the name of the container where the private key is stored.

Returns:

the name of the container where the private key is stored.

getFlags

public int getFlags()

Returns the flags to use when acquiring a handle to the provider.

Returns:

the flags to use when acquiring a handle to the provider.

getKeySpec

public KeySpec getKeySpec()

Returns the key specification of the private key.

Returns:

the key specification of the private key

getKeySpecInt

public int getKeySpecInt()

Returns the key specification of the private key. Should not be called by code outside of the toolkit.

Returns:

the key specification of the private key

getProviderName

public java.lang.String getProviderName()

Returns the name of the provider that owns the private key.

Returns:

the name of the provider that owns the private key.

getProviderType

public ProviderType getProviderType()

Returns the type of the provider that owns the private key.

Returns:

the type of the provider that owns the private key.

getProviderTypeInt

public int getProviderTypeInt()

Returns the type of the provider that owns the private key. Should not be called by code outside of the toolkit.

Returns:

the type of the provider that owns the private key.

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object