iaik.pkcs.pkcs11

Class SelfDestructor

java.lang.Object

iaik.pkcs.pkcs11.SelfDestructor

Direct Known Subclasses:

Module, PKCS11Implementation, UniqueIvParameters

public abstract class SelfDestructor
extends java.lang.Object

Objects that need to be cleaned up when they are no longer reachable should extend this class and implement the clean method. For Java 8 and below the Cleaner class is not available and the finalize method is used to clean up the object. Java between 9 and 17 registers the object for cleanup using the Cleaner class. In this case the finalize method skips the cleanup call. Java 18 and above do not support the finalize method anymore and the Cleaner class is the only way to clean up objects. Implement the AutoCloseable interface if the object should be cleaned up when used in a try-with-resources block. At its end the close method is called which in turn calls the clean method. This is the recommended way to use this class, but it is only available if compiled with Java 7 or above and not always feasible.

Constructor Summary

Constructors

Constructor and Description
SelfDestructor()

Method Summary

Modifier and Type	Method and Description
protected abstract void	clean() Do not call this method directly.
void	close() Cleans up the object and marks it as cleaned.
protected void	finalize() Do not call this method directly.

Methods inherited from class java.lang.Object

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

Constructor Detail

SelfDestructor

public SelfDestructor()

Method Detail

clean

protected abstract void clean()
                       throws java.lang.Exception

Do not call this method directly. Use the close method instead. If the object is no longer reachable, this method is called either by the garbage collector through the finalize method or directly by the cleaner thread if it is available (Java 9 and above). Exceptions thrown by this method are ignored by both the garbage collector and the cleaner thread. If this class implements the AutoCloseable interface, this method is called through the close method when this object is used in a try-with-resources block. In this case exceptions thrown propagate to the caller.

Throws:

java.lang.Exception - if an error occurs during cleanup

See Also:

close()

close

public void close()
           throws java.lang.Exception

Cleans up the object and marks it as cleaned. This method is automatically called when exiting a try-with-resources block for which this object has been declared in the resource specification header. If overridden, the close method should call super.close() to ensure that the object is properly cleaned up. This only available if compiled with Java 7 or above and if this class implements the AutoCloseable interface.

Throws:

java.lang.Exception - if an error occurs during cleanup

finalize

protected void finalize()
                 throws java.lang.Throwable

Do not call this method directly. Use the close method instead. Invoked by the garbage collector on an object in Java 17 and below. If overridden, the finalize method must call super.finalize() to ensure that the object is properly cleaned up.

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable - if an error occurs during finalization

See Also:

close()