Interface LogInterceptor

  • All Known Implementing Classes:
    OutputLogInterceptor

    public interface LogInterceptor
    A log interceptor recieves notifications on various events that occur in the persistence layer is responsible for reporting them. The interceptor cannot affect the outcome of any operation.

    The log interceptor is used for tracing persistence activity for performance tuning, viewing the generated SQL statements, and tracing messages that are not bubbled up to the application layer.

    Version:
    $Revision: 7121 $ $Date: 2004-05-03 16:25:38 -0600 (Mon, 03 May 2004) $
    Author:
    Assaf Arkin
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void creating​(java.lang.Object objClass, java.lang.Object identity)
      Called to indicate that an object of the given type and identity is about to be created in persistent storage.
      void exception​(java.lang.Exception except)
      Reports an exception of some sort that is not delivered to the application.
      java.io.PrintWriter getPrintWriter()
      Returns the PrintWriter for this LogInterceptor.
      void loading​(java.lang.Object objClass, java.lang.Object identity)
      Called to indicate that an object of the given type and identity is about to be loaded into memory.
      void message​(java.lang.String message)
      Reports a message of some sort that is not delivered to the application.
      void queryStatement​(java.lang.String statement)
      Reports a statement that will be used with the persistent engine to conduct a query.
      void removing​(java.lang.Object objClass, java.lang.Object identity)
      Called to indicate that an object of the given type and identity is about to be deleted from persistent storage.
      void storeStatement​(java.lang.String statement)
      Reports a statement that will be used with the persistent engine.
      void storing​(java.lang.Object objClass, java.lang.Object identity)
      Called to indicate that an object of the given type and identity is about to be stored in persistent storage.
    • Method Detail

      • loading

        void loading​(java.lang.Object objClass,
                     java.lang.Object identity)
        Called to indicate that an object of the given type and identity is about to be loaded into memory.

        This method is called when the cache engine decides to explicitly load the specified object from persistent storage and not use a cached copy. It is called prior to the retrieval.

        Parameters:
        objClass - The type of the object
        identity - The object identity
      • creating

        void creating​(java.lang.Object objClass,
                      java.lang.Object identity)
        Called to indicate that an object of the given type and identity is about to be created in persistent storage.

        This method is called when the cache engine decides to explicitly create the specified object in persistent storage, either in response to a create method or upon transaction commit. It is called prior to the creation.

        Parameters:
        objClass - The type of the object
        identity - The object identity
      • removing

        void removing​(java.lang.Object objClass,
                      java.lang.Object identity)
        Called to indicate that an object of the given type and identity is about to be deleted from persistent storage.

        This method is called when the cache engine decides to explicitly delete the specified object from persistent storage, either in response to a delete method or upon transaction commit. It is called prior to the deletion.

        Parameters:
        objClass - The type of the object
        identity - The object identity
      • storing

        void storing​(java.lang.Object objClass,
                     java.lang.Object identity)
        Called to indicate that an object of the given type and identity is about to be stored in persistent storage.

        This method is called when the cache engine decides to explicitly store the specified object in persistent storage, after detecting a modification in this object. It is called prior to storage.

        Parameters:
        objClass - The type of the object
        identity - The object identity
      • storeStatement

        void storeStatement​(java.lang.String statement)
        Reports a statement that will be used with the persistent engine.

        The SQL engine uses this method to report all the select, update, insert statements it creates upon initialization.

        Parameters:
        statement - The storage statement
      • queryStatement

        void queryStatement​(java.lang.String statement)
        Reports a statement that will be used with the persistent engine to conduct a query.

        The SQL engine uses this method to report select statements when running new queries.

        Parameters:
        statement - The query statement
      • message

        void message​(java.lang.String message)
        Reports a message of some sort that is not delivered to the application. Only the interceptor will be notified of this message.
        Parameters:
        message - The reported message
      • exception

        void exception​(java.lang.Exception except)
        Reports an exception of some sort that is not delivered to the application. Only the interceptor will be notified of this exception.
        Parameters:
        except - The exception
      • getPrintWriter

        java.io.PrintWriter getPrintWriter()
        Returns the PrintWriter for this LogInterceptor.