er.extensions.eof

Class ERXObjectStoreCoordinatorPool

java.lang.Object

er.extensions.eof.ERXObjectStoreCoordinatorPool

public class ERXObjectStoreCoordinatorPool
extends Object

This class implements EOF stack pooling including EOF stack synchronizing. It provides a special ERXEC.Factory in order to work without any changes in existing applications. The number of EOObjectStoreCoordinators can be set with the system Property er.extensions.ERXObjectStoreCoordinatorPool.maxCoordinators. Each Session will become one EOObjectStoreCoordinator and the method newEditingContext will always return an EOEditingContext with the same EOObjectStoreCoordinator for the same WOSession. This first release uses round-robin pooling, future versions might use better algorithms to decide which EOObjectStoreCoordinator will be used for the next new WOSession.
The code is tested in a heavy multithreaded application and afawk no deadlock occures, neither in EOF nor directly in Java.

Author:

David Teran, Frank Caputo @ cluster9

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ERXObjectStoreCoordinatorPool.MultiOSCFactory This class uses different EOF stack when creating new EOEditingContexts.

Constructor Summary

Constructors

Constructor and Description
ERXObjectStoreCoordinatorPool(int maxObjectStoreCoordinators) Creates a new ERXObjectStoreCoordinatorPool.

Method Summary

Modifier and Type	Method and Description
static ERXObjectStoreCoordinatorPool	_pool()
com.webobjects.eocontrol.EOObjectStore	currentRootObjectStore() returns the session related EOObjectStoreCoordinator.
protected com.webobjects.eocontrol.EOObjectStore	currentThreadObjectStore() Returns the object store for the current thread (or requests one and sets it if there isn't one).
static void	initialize() Creates the singleton and registers the multi factory.
static void	initializeIfNecessary() Calls initialize() if the required system properties exist.
com.webobjects.eocontrol.EOObjectStore	nextObjectStore() Lazy initialises the objectStores and then returns the next one, this is based on round robin.
void	sessionDidCreate(com.webobjects.foundation.NSNotification n) checks if the new Session has already a EOObjectStoreCoordinator assigned, if not it assigns a EOObjectStoreCoordinator to the session.
void	sessionDidTimeout(com.webobjects.foundation.NSNotification n) Removes the timed out session from the internal array.
protected String	sessionID()
com.webobjects.eocontrol.EOSharedEditingContext	sharedEditingContextForObjectStore(com.webobjects.eocontrol.EOObjectStore os)

Methods inherited from class java.lang.Object

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

Constructor Detail

ERXObjectStoreCoordinatorPool

public ERXObjectStoreCoordinatorPool(int maxObjectStoreCoordinators)

Creates a new ERXObjectStoreCoordinatorPool. This object is a singleton. This object is responsible to provide EOObjectStoreCoordinators based on the current Threads' session. It is used by MultiOSCFactory to get a rootObjectStore if the MultiOSCFactory is asked for a new EOEditingContext.

Method Detail

_pool

public static ERXObjectStoreCoordinatorPool _pool()

initializeIfNecessary

public static void initializeIfNecessary()

Calls initialize() if the required system properties exist.

initialize

public static void initialize()

Creates the singleton and registers the multi factory.

sessionDidCreate

public void sessionDidCreate(com.webobjects.foundation.NSNotification n)

checks if the new Session has already a EOObjectStoreCoordinator assigned, if not it assigns a EOObjectStoreCoordinator to the session.

Parameters:

n - WOSession.SessionDidCreateNotification

sessionDidTimeout

public void sessionDidTimeout(com.webobjects.foundation.NSNotification n)

Removes the timed out session from the internal array. session.

Parameters:

n - WOSession.SessionDidTimeOutNotification

sessionID

protected String sessionID()

Returns:

the sessionID from the session stored in ERXThreadStorage.

currentRootObjectStore

public com.webobjects.eocontrol.EOObjectStore currentRootObjectStore()

returns the session related EOObjectStoreCoordinator. If session is null then it returns the nextObjectStore. This method is used to create new EOEditingContexts with the MultiOSCFactory

Returns:

an EOEditingContext

currentThreadObjectStore

protected com.webobjects.eocontrol.EOObjectStore currentThreadObjectStore()

Returns the object store for the current thread (or requests one and sets it if there isn't one).

Returns:

the object store for the current thread

nextObjectStore

public com.webobjects.eocontrol.EOObjectStore nextObjectStore()

Lazy initialises the objectStores and then returns the next one, this is based on round robin.

Returns:

the next EOObjectStore based on round robin

sharedEditingContextForObjectStore

public com.webobjects.eocontrol.EOSharedEditingContext sharedEditingContextForObjectStore(com.webobjects.eocontrol.EOObjectStore os)