org.apache.openjpa.kernel
Class AbstractBrokerFactory

java.lang.Object
  org.apache.openjpa.kernel.AbstractBrokerFactory

All Implemented Interfaces:

Serializable, BrokerFactory, Closeable

Direct Known Subclasses:

AbstractStoreBrokerFactory, JDBCBrokerFactory

public abstract class AbstractBrokerFactory
extends Object
implements BrokerFactory

Abstract implementation of the BrokerFactory that must be subclassed for a specific runtime.

Author:

Abe White

See Also:

Serialized Form

Constructor Summary

protected

AbstractBrokerFactory(OpenJPAConfiguration config) Constructor.

Method Summary

void	addLifecycleListener(Object listener, Class<?>[] classes) Register a listener for lifecycle-related events on the specified classes.
protected void	addListeners(Broker broker) Add factory-registered lifecycle listeners to the broker.
void	addTransactionListener(Object listener) Register a listener for transaction-related events on the specified classes.
void	assertOpen() Throw an exception if the factory is closed.
void	close() Close the factory.
protected void	configureBroker(BrokerImpl broker) Configures the given broker with the current factory option settings.
protected DelegatingStoreManager	createDelegatingStoreManager() Create a DelegatingStoreManager for use with a Broker created by this factory.
protected Broker	findBroker(String user, String pass, boolean managed) Find a pooled broker, or return null if none.
protected Broker	findTransactionalBroker(String user, String pass) Find a managed runtime broker associated with the current transaction, or returns null if none.
OpenJPAConfiguration	getConfiguration() Return the configuration for this factory.
protected Object	getFactoryInitializationBanner() Return an object to be written to the log when this broker factory initializes.
Collection<Broker>	getOpenBrokers() Returns a set of all the open brokers associated with this factory.
static AbstractBrokerFactory	getPooledFactoryForKey(Object key) Return the pooled factory matching the given key, or null if none.
Object	getPoolKey()
Map<String,Object>	getProperties() Subclasses should override this method to add a Platform property listing the runtime platform, such as: OpenJPA JDBC Edition: Oracle Database
Set<String>	getSupportedProperties() Return all of the supported properties as a set of keys.
Object	getUserObject(Object key) Get the value for the specified key from the map of user objects.
(package private) void	initializeBroker(boolean managed, int connRetainMode, Broker broker, boolean fromDeserialization)
boolean	isClosed() Returns true if this broker factory is closed.
void	loadPersistentTypes(ClassLoader envLoader) Load the configured persistent classes list.
void	lock() Synchronizes on an internal lock.
void	makeReadOnly() Freezes the configuration of this factory.
Broker	newBroker() Return a broker with default settings.
Broker	newBroker(boolean managed, int connRetainMode)
Broker	newBroker(String user, String pass)
Broker	newBroker(String user, String pass, boolean managed, int connRetainMode)
Broker	newBroker(String user, String pass, boolean managed, int connRetainMode, boolean findExisting) Return a broker using the given credentials and in the given transaction and connection retain mode, optionally finding existing broker in the global transaction.
Broker	newBroker(String user, String pass, boolean managed, int connRetainMode, boolean findExisting, String cf1Name, String cf2Name) Return a new broker using the supplied credentials transaction management mode connectionRetainMode connectionFactories
protected BrokerImpl	newBrokerImpl(String user, String pass) Return a broker configured with the proper settings.
protected abstract StoreManager	newStoreManager() Return a new StoreManager for this runtime.
protected static void	pool(Object key, AbstractBrokerFactory factory) Register factory in the pool under key.
Object	putUserObject(Object key, Object val) Put the specified key-value pair into the map of user objects.
protected Object	readResolve() Replaces the factory with this JVMs pooled version if it exists.
protected void	releaseBroker(BrokerImpl broker) Release broker from any internal data structures.
void	removeLifecycleListener(Object listener) Remove a listener for lifecycle-related events.
void	removeTransactionListener(Object listener) Remove a listener for transaction-related events.
(package private) void	setPoolKey(Object key) Set a key that can be used to obtain this broker factory from the pool at a later time.
protected void	setup() Setup transient state used by this factory based on the current configuration, which will subsequently be locked down.
(package private) boolean	syncWithManagedTransaction(BrokerImpl broker, boolean begin) Synchronize the given broker with a managed transaction, optionally starting one if none is in progress.
protected static Object	toPoolKey(Map<String,Object> map) Return an internal factory pool key for the given configuration.
void	unlock() Release the internal lock.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractBrokerFactory

protected AbstractBrokerFactory(OpenJPAConfiguration config)

Constructor. Configuration must be provided on construction.

Method Detail

toPoolKey

protected static Object toPoolKey(Map<String,Object> map)

Return an internal factory pool key for the given configuration.

Since:

1.1.0

pool

protected static void pool(Object key,
                           AbstractBrokerFactory factory)

Register factory in the pool under key.

Since:

1.1.0

getPooledFactoryForKey

public static AbstractBrokerFactory getPooledFactoryForKey(Object key)

Return the pooled factory matching the given key, or null if none. The key must be of the form created by getPoolKey().

getConfiguration

public OpenJPAConfiguration getConfiguration()

Return the configuration for this factory.

Specified by:

getConfiguration in interface BrokerFactory

newBroker

public Broker newBroker()

Description copied from interface: BrokerFactory

Return a broker with default settings.

Specified by:

newBroker in interface BrokerFactory

newBroker

public Broker newBroker(String user,
                        String pass)

newBroker

public Broker newBroker(boolean managed,
                        int connRetainMode)

newBroker

public Broker newBroker(String user,
                        String pass,
                        boolean managed,
                        int connRetainMode)

newBroker

public Broker newBroker(String user,
                        String pass,
                        boolean managed,
                        int connRetainMode,
                        boolean findExisting)

Description copied from interface: BrokerFactory

Return a broker using the given credentials and in the given transaction and connection retain mode, optionally finding existing broker in the global transaction.

Specified by:

newBroker in interface BrokerFactory

newBroker

public Broker newBroker(String user,
                        String pass,
                        boolean managed,
                        int connRetainMode,
                        boolean findExisting,
                        String cf1Name,
                        String cf2Name)

Description copied from interface: BrokerFactory

Return a new broker using the supplied

• credentials
• transaction management mode
• connectionRetainMode
• connectionFactories

Specified by:

newBroker in interface BrokerFactory

Parameters:

user - Username to use when obtaining a connection. Will be ignored if a connection factory is obtained from JNDI.

pass - Password to use when obtaining a connection. Will be ignored if a connection factory is obtained from JNDI.

managed - Whether managed transactions will be used by this Broker

connRetainMode - ConnectionRetainMode

findExisting - Whether the internal pool of brokers should be used.

cf1Name - JTA ConnectionFactory to use

cf2Name - Non-JTA ConnectionFactory to use.

Returns:

A Broker which matches the provided criteria.

initializeBroker

void initializeBroker(boolean managed,
                      int connRetainMode,
                      Broker broker,
                      boolean fromDeserialization)

addListeners

protected void addListeners(Broker broker)

Add factory-registered lifecycle listeners to the broker.

loadPersistentTypes

public void loadPersistentTypes(ClassLoader envLoader)

Load the configured persistent classes list. Performed automatically whenever a broker is created.

addLifecycleListener

public void addLifecycleListener(Object listener,
                                 Class<?>[] classes)

Description copied from interface: BrokerFactory

Register a listener for lifecycle-related events on the specified classes. If the classes are null, all events will be propagated to the listener. The listener will be passed on to all new brokers.

Specified by:

addLifecycleListener in interface BrokerFactory

removeLifecycleListener

public void removeLifecycleListener(Object listener)

Description copied from interface: BrokerFactory

Remove a listener for lifecycle-related events.

Specified by:

removeLifecycleListener in interface BrokerFactory

addTransactionListener

public void addTransactionListener(Object listener)

Description copied from interface: BrokerFactory

Register a listener for transaction-related events on the specified classes. It will be registered with all Brokers created from this instance moving forward.

Specified by:

addTransactionListener in interface BrokerFactory

removeTransactionListener

public void removeTransactionListener(Object listener)

Description copied from interface: BrokerFactory

Remove a listener for transaction-related events. It will no longer be registered with new Brokers created from this instance.

Specified by:

removeTransactionListener in interface BrokerFactory

isClosed

public boolean isClosed()

Returns true if this broker factory is closed.

Specified by:

isClosed in interface BrokerFactory

close

public void close()

Description copied from interface: BrokerFactory

Close the factory.

Specified by:

close in interface BrokerFactory

Specified by:

close in interface Closeable

getProperties

public Map<String,Object> getProperties()

Subclasses should override this method to add a Platform property listing the runtime platform, such as: OpenJPA JDBC Edition: Oracle Database

Specified by:

getProperties in interface BrokerFactory

getSupportedProperties

public Set<String> getSupportedProperties()

Description copied from interface: BrokerFactory

Return all of the supported properties as a set of keys. If a property has multiple keys, all keys will be returned.

Specified by:

getSupportedProperties in interface BrokerFactory

getUserObject

public Object getUserObject(Object key)

Description copied from interface: BrokerFactory

Get the value for the specified key from the map of user objects.

Specified by:

getUserObject in interface BrokerFactory

putUserObject

public Object putUserObject(Object key,
                            Object val)

Description copied from interface: BrokerFactory

Put the specified key-value pair into the map of user objects.

Specified by:

putUserObject in interface BrokerFactory

lock

public void lock()

Description copied from interface: BrokerFactory

Synchronizes on an internal lock.

Specified by:

lock in interface BrokerFactory

unlock

public void unlock()

Description copied from interface: BrokerFactory

Release the internal lock.

Specified by:

unlock in interface BrokerFactory

readResolve

protected Object readResolve()
                      throws ObjectStreamException

Replaces the factory with this JVMs pooled version if it exists. Also freezes the factory.

Throws:

ObjectStreamException

newStoreManager

protected abstract StoreManager newStoreManager()

Return a new StoreManager for this runtime. Note that the instance returned here may be wrapped before being passed to the newBroker() method.

findBroker

protected Broker findBroker(String user,
                            String pass,
                            boolean managed)

Find a pooled broker, or return null if none. If using managed transactions, looks for a transactional broker; otherwise returns null by default. This method will be called before newStoreManager() so that factory subclasses implementing pooling can return a matching manager before a new StoreManager is created.

newBrokerImpl

protected BrokerImpl newBrokerImpl(String user,
                                   String pass)

Return a broker configured with the proper settings. By default, this method constructs a new BrokerImpl of the class set for this factory.

setup

protected void setup()

Setup transient state used by this factory based on the current configuration, which will subsequently be locked down. This method will be called before the first broker is requested, and will be re-called each time the factory is deserialized into a JVM that has no configuration for this data store.

findTransactionalBroker

protected Broker findTransactionalBroker(String user,
                                         String pass)

Find a managed runtime broker associated with the current transaction, or returns null if none.

configureBroker

protected void configureBroker(BrokerImpl broker)

Configures the given broker with the current factory option settings.

makeReadOnly

public void makeReadOnly()

Freezes the configuration of this factory.

getFactoryInitializationBanner

protected Object getFactoryInitializationBanner()

Return an object to be written to the log when this broker factory initializes. This happens after the configuration is fully loaded.

assertOpen

public void assertOpen()

Throw an exception if the factory is closed. The exact message and content of the exception varies whether TRACE is enabled or not.

Specified by:

assertOpen in interface BrokerFactory

syncWithManagedTransaction

boolean syncWithManagedTransaction(BrokerImpl broker,
                                   boolean begin)

Synchronize the given broker with a managed transaction, optionally starting one if none is in progress.

Returns:

true if synched with transaction, false otherwise

getOpenBrokers

public Collection<Broker> getOpenBrokers()

Returns a set of all the open brokers associated with this factory. The returned set is unmodifiable, and may contain null references.

releaseBroker

protected void releaseBroker(BrokerImpl broker)

Release broker from any internal data structures. This is invoked by broker after the broker is fully closed.

Since:

1.1.0

getPoolKey

public Object getPoolKey()

Returns:

a key that can be used to obtain this broker factory from the pool at a later time.

Since:

1.1.0

setPoolKey

void setPoolKey(Object key)

Set a key that can be used to obtain this broker factory from the pool at a later time.

Since:

1.1.0

createDelegatingStoreManager

protected DelegatingStoreManager createDelegatingStoreManager()

Create a DelegatingStoreManager for use with a Broker created by this factory. If a DataCache has been enabled a DataCacheStoreManager will be returned.

If no DataCache is in use an ROPStoreManager will be returned.

Returns:

A delegating store manager suitable for the current configuration.