org.apache.ojb.broker.core.proxy
Interface IndirectionHandler

All Superinterfaces:
java.io.Serializable
All Known Subinterfaces:
IndirectionHandlerCGLIB, IndirectionHandlerJDK
All Known Implementing Classes:
AbstractIndirectionHandler, IndirectionHandlerCGLIBImpl, IndirectionHandlerJDKImpl

public interface IndirectionHandler
extends java.io.Serializable

Base interface for indirection handlers used by OJB's proxies. Note that this interface needs JDK 1.3 or above. Implemening classes are required to have a public constructor with the signature (PBKey, Identity).
Implementing classes should use this interface to acquire a logger.

Version:
$Id: IndirectionHandler.java 365232 2005-12-21 22:36:07Z tomdz $

Method Summary
 void addListener(MaterializationListener l)
          Adds a materialization listener.
 boolean alreadyMaterialized()
          Determines whether the real subject already has been materialized.
 PBKey getBrokerKey()
          Returns the key of the persistence broker used by this indirection handler. .
 Identity getIdentity()
          Returns the identity of the subject.
 java.lang.Object getRealSubject()
          Returns the proxies real subject.
 java.lang.Object invoke(java.lang.Object proxy, java.lang.reflect.Method method, java.lang.Object[] args)
          [Copied from InvocationHandler]:
Processes a method invocation on a proxy instance and returns the result.
 void removeListener(MaterializationListener l)
          Removes a materialization listener.
 void setRealSubject(java.lang.Object object)
          Sets the real subject of this proxy.
 

Method Detail

getBrokerKey

PBKey getBrokerKey()
Returns the key of the persistence broker used by this indirection handler. .

Returns:
The broker key

getIdentity

Identity getIdentity()
Returns the identity of the subject.

Returns:
The identity

invoke

java.lang.Object invoke(java.lang.Object proxy,
                        java.lang.reflect.Method method,
                        java.lang.Object[] args)
[Copied from InvocationHandler]:
Processes a method invocation on a proxy instance and returns the result. This method will be invoked on an invocation handler when a method is invoked on a proxy instance that it is associated with.

Parameters:
proxy - The proxy instance that the method was invoked on
method - The Method instance corresponding to the interface method invoked on the proxy instance. The declaring class of the Method object will be the interface that the method was declared in, which may be a superinterface of the proxy interface that the proxy class inherits the method through.
args - An array of objects containing the values of the arguments passed in the method invocation on the proxy instance, or null if interface method takes no arguments. Arguments of primitive types are wrapped in instances of the appropriate primitive wrapper class, such as java.lang.Integer or java.lang.Boolean.
Returns:
The value to return from the method invocation on the proxy instance. If the declared return type of the interface method is a primitive type, then the value returned by this method must be an instance of the corresponding primitive wrapper class; otherwise, it must be a type assignable to the declared return type. If the value returned by this method is null and the interface method's return type is primitive, then a NullPointerException will be thrown by the method invocation on the proxy instance. If the value returned by this method is otherwise not compatible with the interface method's declared return type as described above, a ClassCastException will be thrown by the method invocation on the proxy instance.
Throws:
PersistenceBrokerException - The exception to throw from the method invocation on the proxy instance. The exception's type must be assignable either to any of the exception types declared in the throws clause of the interface method or to the unchecked exception types java.lang.RuntimeException or java.lang.Error. If a checked exception is thrown by this method that is not assignable to any of the exception types declared in the throws clause of the interface method, then an UndeclaredThrowableException containing the exception that was thrown by this method will be thrown by the method invocation on the proxy instance.
See Also:
UndeclaredThrowableException

getRealSubject

java.lang.Object getRealSubject()
                                throws PersistenceBrokerException
Returns the proxies real subject. The subject will be materialized if necessary.

Returns:
The subject
Throws:
PersistenceBrokerException

setRealSubject

void setRealSubject(java.lang.Object object)
Sets the real subject of this proxy. [olegnitz] This looks stupid, but is really necessary for OTM: the materialization listener replaces the real subject by its clone to ensure transaction isolation. Is there a better way to do this?


alreadyMaterialized

boolean alreadyMaterialized()
Determines whether the real subject already has been materialized.

Returns:
true if the real subject has already been loaded

addListener

void addListener(MaterializationListener l)
Adds a materialization listener.

Parameters:
l - The listener to add

removeListener

void removeListener(MaterializationListener l)
Removes a materialization listener.

Parameters:
l - The listener to remove


(C) 2002 - 2006 Apache Software Foundation
All rights reserved. Published under the Apache License 2.0.
http://db.apache.org/ojb
Version: 1.0.4, 2005-12-30