com.entrust.toolkit.capi

Class CapiHandle

java.lang.Object

com.entrust.toolkit.credentials.Handle

com.entrust.toolkit.capi.CapiHandle

Direct Known Subclasses:

CertChainContext, CertContext, CertStore, CryptHash, CryptKey, CryptProvider

public abstract class CapiHandle
extends Handle

This class represents a handle to an object in Microsoft's CAPI. It acts as the base class for all native types for which a handle or pointer is allocated and returned.

It is very important that the close method be called after the object is no longer needed to free memory allocated by native code. Not calling close can result in memory leaks, and possibly even crash the Java VM.

Most toolkit users will not need to use this class directly.

Since:

7.0

Field Summary

Fields inherited from class com.entrust.toolkit.credentials.Handle

m_handle

Method Summary

Modifier and Type	Method and Description
static void	debugInfo() Writes information about current handle allocation to System.out.
static void	debugInfo(boolean showAllocation) Writes information about current handle allocation to System.out.
boolean	equals(java.lang.Object anotherHandle) Equals method, for debugging purposes.
static void	setExtendedDebugging(boolean extendedDebugging) Turn on or off extended debugging information.

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

clearHandle, close, finalize, getHandle, hashCode

Methods inherited from class java.lang.Object

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

Method Detail

debugInfo

public static void debugInfo()

Writes information about current handle allocation to System.out. This method is useful for debugging memory allocation and making sure resources allocated in native code are being correctly released.

This method is not guaranteed to remain in future toolkit versions, it should be used in debug code only.

debugInfo

public static void debugInfo(boolean showAllocation)

Writes information about current handle allocation to System.out. This method is useful for debugging memory allocation and making sure resources allocated in native code are being correctly released.

This method is not guaranteed to remain in future toolkit versions, it should be used in debug code only.

Parameters:

showAllocation - Show where handles were allocated, if the information is available.

setExtendedDebugging

public static void setExtendedDebugging(boolean extendedDebugging)

Turn on or off extended debugging information.

This method is not guaranteed to remain in future toolkit versions, it should be used in debug code only.

Parameters:

extendedDebugging -

equals

public boolean equals(java.lang.Object anotherHandle)

Equals method, for debugging purposes.

Overrides:

equals in class Handle