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

All Superinterfaces:

Serializable

All Known Implementing Classes:

AbstractProxyFactory, ProxyFactoryCGLIBImpl, ProxyFactoryJDKImpl

public interface ProxyFactory
extends Serializable

Factory class for creating instances of the indirection handler used by OJB's proxies, and for the collection proxies.

Version:

$Id: ProxyFactory.java,v 1.1 2007-08-24 22:17:32 ewestfal Exp $

Author:

Thomas Dudziak

Method Summary

ManageableCollection	createCollectionProxy(PBKey brokerKey, Query query, Class collectionClass) Create a Collection Proxy for a given context.
IndirectionHandler	createIndirectionHandler(PBKey pbKey, Identity id) Creates a new indirection handler instance.
OJBProxy	createProxy(Class baseClass, IndirectionHandler handler)
CollectionProxy	getCollectionProxy(Object item) Return CollectionProxy for item is item is a CollectionProxy, otherwise return null
Class	getCollectionProxyClass() Returns the collection proxy class.
Class	getDefaultIndirectionHandlerClass() Returns the class of a default IndirectionHandler that can be used for this implementaiton if now IndirectionHandlerClass implementation is given.
IndirectionHandler	getIndirectionHandler(Object obj) Returns the invocation handler object of the given proxy object.
Class	getIndirectionHandlerBaseClass() Returns the class of the base class that the given IndirectionHandler must extend/implement
Class	getIndirectionHandlerClass() Returns the indirection handler class.
Class	getListProxyClass() Returns the list proxy class.
Class	getRealClass(Object objectOrProxy) Get the real Class
Object	getRealObject(Object objectOrProxy) Get the real Object
Object	getRealObjectIfMaterialized(Object objectOrProxy) Get the real Object for already materialized Handler
Class	getSetProxyClass() Returns the set proxy class.
boolean	interfaceRequiredForProxyGeneration() Method that returns whether or not this ProxyFactory can generate reference Proxies for classes regardless if they extend an interface or not.
boolean	isCollectionProxy(Object item) Reports if item is a CollectionProxy.
boolean	isMaterialized(Object object) Determines whether the object is a materialized object, i.e.
boolean	isNormalOjbProxy(Object proxyOrObject) Determines whether the given object is an OJB proxy.
boolean	isProxy(Object proxyOrObject) Returns true if the given object is a Proxy or a VirtualProxy instance.
boolean	isVirtualOjbProxy(Object proxyOrObject) Determines whether the given object is an OJB virtual proxy.
void	setCollectionProxyClass(Class collectionProxyClass) Dets the proxy class to use for generic collection classes implementing the Collection interface.
void	setIndirectionHandlerClass(Class indirectionHandlerClass) Sets the indirection handler class.
void	setListProxyClass(Class listProxyClass) Dets the proxy class to use for collection classes that implement the List interface.
void	setSetProxyClass(Class setProxyClass) Dets the proxy class to use for collection classes that implement the Set interface.
String	toString(Object proxy) Materialization-safe version of toString.

Method Detail

getIndirectionHandlerClass

Class getIndirectionHandlerClass()

Returns the indirection handler class.

Returns:

The class for indirection handlers

setIndirectionHandlerClass

void setIndirectionHandlerClass(Class indirectionHandlerClass)

Sets the indirection handler class.

Parameters:

indirectionHandlerClass - The class for indirection handlers

getDefaultIndirectionHandlerClass

Class getDefaultIndirectionHandlerClass()

Returns the class of a default IndirectionHandler that can be used for this implementaiton if now IndirectionHandlerClass implementation is given.

getIndirectionHandlerBaseClass

Class getIndirectionHandlerBaseClass()

Returns the class of the base class that the given IndirectionHandler must extend/implement

createIndirectionHandler

IndirectionHandler createIndirectionHandler(PBKey pbKey,
                                            Identity id)

Creates a new indirection handler instance.

Parameters:

persistenceConf - The persistence configuration

id - The subject's ids

Returns:

The new instance

getListProxyClass

Class getListProxyClass()

Returns the list proxy class.

Returns:

The class used for list proxies

setListProxyClass

void setListProxyClass(Class listProxyClass)

Dets the proxy class to use for collection classes that implement the List interface. Notes that the proxy class must implement the List interface, and have a constructor of the signature (PBKey, Class, Query).

Parameters:

listProxyClass - The proxy class

getSetProxyClass

Class getSetProxyClass()

Returns the set proxy class.

Returns:

The class used for set proxies

setSetProxyClass

void setSetProxyClass(Class setProxyClass)

Dets the proxy class to use for collection classes that implement the Set interface.

Parameters:

setProxyClass - The proxy class

getCollectionProxyClass

Class getCollectionProxyClass()

Returns the collection proxy class.

Returns:

The class used for collection proxies

setCollectionProxyClass

void setCollectionProxyClass(Class collectionProxyClass)

Dets the proxy class to use for generic collection classes implementing the Collection interface.

Parameters:

collectionProxyClass - The proxy class

createCollectionProxy

ManageableCollection createCollectionProxy(PBKey brokerKey,
                                           Query query,
                                           Class collectionClass)

Create a Collection Proxy for a given context.

Parameters:

persistenceConf - The persistence configuration that the proxy will be bound to

context - The creation context

Returns:

The collection proxy

createProxy

OJBProxy createProxy(Class baseClass,
                     IndirectionHandler handler)
                     throws Exception

Throws:

Exception

getRealObject

Object getRealObject(Object objectOrProxy)

Get the real Object

Parameters:

objectOrProxy -

Returns:

Object

getRealObjectIfMaterialized

Object getRealObjectIfMaterialized(Object objectOrProxy)

Get the real Object for already materialized Handler

Parameters:

objectOrProxy -

Returns:

Object or null if the Handel is not materialized

getRealClass

Class getRealClass(Object objectOrProxy)

Get the real Class

Parameters:

objectOrProxy -

Returns:

Class

isNormalOjbProxy

boolean isNormalOjbProxy(Object proxyOrObject)

Determines whether the given object is an OJB proxy.

Returns:

true if the object is an OJB proxy

isVirtualOjbProxy

boolean isVirtualOjbProxy(Object proxyOrObject)

Determines whether the given object is an OJB virtual proxy.

Returns:

true if the object is an OJB virtual proxy

isProxy

boolean isProxy(Object proxyOrObject)

Returns true if the given object is a Proxy or a VirtualProxy instance.

getIndirectionHandler

IndirectionHandler getIndirectionHandler(Object obj)

Returns the invocation handler object of the given proxy object.

Parameters:

obj - The object

Returns:

The invocation handler if the object is an OJB proxy, or null otherwise

isMaterialized

boolean isMaterialized(Object object)

Determines whether the object is a materialized object, i.e. no proxy or a proxy that has already been loaded from the database.

Parameters:

object - The object to test

Returns:

true if the object is materialized

getCollectionProxy

CollectionProxy getCollectionProxy(Object item)

Return CollectionProxy for item is item is a CollectionProxy, otherwise return null

isCollectionProxy

boolean isCollectionProxy(Object item)

Reports if item is a CollectionProxy. TODO: Provide handling for pluggable collection proxy implementations

toString

String toString(Object proxy)

Materialization-safe version of toString. If the object is a yet-unmaterialized proxy, then only the text "unmaterialized proxy for ..." is returned and the proxy is NOT materialized. Otherwise, the normal toString method is called. This useful e.g. for logging etc.

Parameters:

object - The object for which a string representation shall be generated

Returns:

The string representation

interfaceRequiredForProxyGeneration

boolean interfaceRequiredForProxyGeneration()

Method that returns whether or not this ProxyFactory can generate reference Proxies for classes regardless if they extend an interface or not.