Package org.mozilla.jss.util

Class NativeProxy

  • All Implemented Interfaces:
    java.lang.AutoCloseable
    Direct Known Subclasses:
    BufferProxy, PRFDProxy, TokenProxy
    public abstract class NativeProxy
extends java.lang.Object
implements java.lang.AutoCloseable
    NativeProxy, a superclass for Java classes that mirror C data structures. It contains some code to help make sure that native memory is getting freed properly.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static org.slf4j.Logger logger  

    • Constructor Summary

      Constructors 
      Constructor Description
      NativeProxy​(byte[] pointer)
      Create a NativeProxy from a byte array representing a C pointer.

    • Method Summary

      All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      static void assertRegistryEmpty()
      Assert that the Registry is empty.
      void clear()
      Call clear(...) to clear the value of the pointer, setting it to null.
      void close()
      Close this NativeProxy by releasing its native resources if they haven't otherwise been freed.
      boolean equals​(java.lang.Object obj)
      Deep comparison operator.
      protected void finalize()
      Deprecated.
      finalize() in Object has been deprecated.
      protected abstract void releaseNativeResources()
      Release the native resources used by this proxy.

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • logger

        public static org.slf4j.Logger logger

    • Constructor Detail

      • NativeProxy

        public NativeProxy​(byte[] pointer)
        Create a NativeProxy from a byte array representing a C pointer. This is the only way to create a NativeProxy, it should be called from the constructor of your subclass.
        Parameters:
        pointer - A byte array, created with JSS_ptrToByteArray, that contains a pointer pointing to a native data structure. The NativeProxy instance acts as a proxy for that native data structure.

    • Method Detail

      • equals

        public boolean equals​(java.lang.Object obj)
        Deep comparison operator.
        Overrides:
        equals in class java.lang.Object
        Returns:
        true if obj has the same underlying native pointer. false if the obj is null or has a different underlying native pointer.

      • releaseNativeResources

        protected abstract void releaseNativeResources()
        Release the native resources used by this proxy. Subclasses of NativeProxy must define this method to clean up data structures in C code that are referenced by this proxy. releaseNativeResources() will usually be implemented as a native method.

        You don't call this method; NativeProxy.finalize() or close() calls it for you.

        If you free these resources explicitly, call clear(); instead.

      • finalize

        @Deprecated
protected void finalize()
                 throws java.lang.Throwable
        Deprecated.
        finalize() in Object has been deprecated. Use close(...) from the AutoCloseable interface instead.
        Finalize this NativeProxy by releasing its native resources. The finalizer calls releaseNativeResources() so you don't have to. This finalizer should be called from the finalize() method of all subclasses: class MyProxy extends NativeProxy { [...] protected void finalize() throws Throwable { // do any object-specific finalization other than // releasing native resources [...] super.finalize(); } }
        Overrides:
        finalize in class java.lang.Object
        Throws:
        java.lang.Throwable

      • close

        public final void close()
                 throws java.lang.Exception
        Close this NativeProxy by releasing its native resources if they haven't otherwise been freed. See comment in finalize.
        Specified by:
        close in interface java.lang.AutoCloseable
        Throws:
        java.lang.Exception

      • clear

        public final void clear()
        Call clear(...) to clear the value of the pointer, setting it to null. This should be used when the pointer has been freed by another means. Similar to finalize(...) or close(...), except that it doesn't call releaseNativeResources(...). See also: JSS_clearPtrFromProxy(...) in jssutil.h

      • assertRegistryEmpty

        public static void assertRegistryEmpty()
        Assert that the Registry is empty. Only works in debug mode; in ship mode, it is a no-op. If the Registry is not empty when this is called, an assertion (org.mozilla.jss.util.AssertionException) is thrown.