org.exolab.castor.persist.spi

Interface LogInterceptor

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: 1.1.1.1 $ $Date: 2003/03/03 07:08:51 $
Author:
Assaf Arkin

Method Summary

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

Method Details

creating

public void creating(Object objClass,
                     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

exception

public void exception(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:

getPrintWriter

public PrintWriter getPrintWriter()
Returns the PrintWriter for this LogInterceptor

loading

public void loading(Object objClass,
                    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

message

public void message(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

queryStatement

public void queryStatement(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:

removing

public void removing(Object objClass,
                     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

storeStatement

public void storeStatement(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:

storing

public void storing(Object objClass,
                    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

Intalio Inc. (C) 1999-2003. All rights reserved http://www.intalio.com