com.entrust.toolkit.credentials

Class Handle

java.lang.Object

com.entrust.toolkit.credentials.Handle

Direct Known Subclasses:

CapiHandle, KeychainHandle

public abstract class Handle
extends java.lang.Object

This class represents a handle to an object. 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

Modifier and Type	Field and Description
protected long	m_handle The value of the handle.

Constructor Summary

Constructors

Constructor and Description
Handle()

Method Summary

Modifier and Type	Method and Description
void	clearHandle() Clears the handle without freeing memory.
abstract void	close() Close the handle, releasing the memory allocated by native functions.
boolean	equals(java.lang.Object anotherHandle) Equals method, for debugging purposes.
void	finalize() Attempts to release the handle owned by this object.
long	getHandle() Returns the actual handle represented by this object.
int	hashCode() hashCode method, for debugging purposes.

Methods inherited from class java.lang.Object

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

Field Detail

m_handle

protected transient long m_handle

The value of the handle. Support 64-bit

Constructor Detail

Handle

public Handle()

Method Detail

close

public abstract void close()

Close the handle, releasing the memory allocated by native functions. After this call, the handle cannot be used for any more native calls.

It is okay to call this method multiple times on the same object.

getHandle

public long getHandle()

Returns the actual handle represented by this object.

Returns:

the actual handle represented by this object.

clearHandle

public void clearHandle()

Clears the handle without freeing memory. Useful after native calls that implicitly close a handle

equals

public boolean equals(java.lang.Object anotherHandle)

Equals method, for debugging purposes.

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

hashCode method, for debugging purposes.

Overrides:

hashCode in class java.lang.Object

finalize

public void finalize()
              throws java.lang.Throwable

Attempts to release the handle owned by this object. This mechanism should not be relied upon, programs should explicitly call the close method when a handle is no longer required. This method is a "last resort" to attempt to prevent memory leaks.

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable