org.apache.ojb.broker.core
Class PersistenceBrokerFactoryBaseImpl

java.lang.Object
  extended byorg.apache.ojb.broker.core.PersistenceBrokerFactoryBaseImpl
All Implemented Interfaces:
org.apache.ojb.broker.util.configuration.Configurable, PersistenceBrokerFactoryIF
Direct Known Subclasses:
PersistenceBrokerFactoryDefaultImpl

public class PersistenceBrokerFactoryBaseImpl
extends java.lang.Object
implements PersistenceBrokerFactoryIF

This is an base implementation of the PersistenceBrokerFactoryIF interface. Each request (PersistenceBrokerFactoryIF.createPersistenceBroker(org.apache.ojb.broker.PBKey) or PersistenceBrokerFactoryIF.defaultPersistenceBroker() call) creates a new PersistenceBroker instance. No pooling of broker instances is used.

Version:
$Id: PersistenceBrokerFactoryBaseImpl.java,v 1.3 2004/04/04 23:53:33 brianm Exp $
Author:
Thomas Mahler, Armin Waibel
See Also:
PersistenceBrokerFactoryDefaultImpl

Constructor Summary
PersistenceBrokerFactoryBaseImpl()
           
 
Method Summary
 int activePersistenceBroker()
          Not implemented!
 void configure(org.apache.ojb.broker.util.configuration.Configuration config)
           
 PersistenceBroker createPersistenceBroker(PBKey pbKey)
          Always return a new created PersistenceBroker instance
 PersistenceBroker createPersistenceBroker(java.lang.String jcdAlias, java.lang.String user, java.lang.String password)
          Return a ready for action PersistenceBroker instance.
 PersistenceBroker defaultPersistenceBroker()
          Return a default broker instance, specified in configuration or set using setDefaultKey(org.apache.ojb.broker.PBKey).
 PBKey getDefaultKey()
          Get the default PBKey.
 void releaseAllInstances()
          release all broker instances pooled by the factory.
 void setDefaultKey(PBKey key)
          Set the PBKey used for convinience PersistenceBroker lookup method defaultPersistenceBroker().
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PersistenceBrokerFactoryBaseImpl

public PersistenceBrokerFactoryBaseImpl()
Method Detail

setDefaultKey

public void setDefaultKey(PBKey key)
Description copied from interface: PersistenceBrokerFactoryIF
Set the PBKey used for convinience PersistenceBroker lookup method PersistenceBrokerFactoryIF.defaultPersistenceBroker().
Note: It's only allowed to set the default PBKey once. All further calls will cause an exception. If a default JdbcConnectionDescriptor was declared in configuration file, OJB will set the declared PBKey as default.
This method is convenience for MetadataManager.setDefaultPBKey(org.apache.ojb.broker.PBKey).

Specified by:
setDefaultKey in interface PersistenceBrokerFactoryIF
See Also:
PersistenceBrokerFactoryIF.setDefaultKey(org.apache.ojb.broker.PBKey)

getDefaultKey

public PBKey getDefaultKey()
Description copied from interface: PersistenceBrokerFactoryIF
Get the default PBKey. This method is convenience for MetadataManager.getDefaultPBKey().

Specified by:
getDefaultKey in interface PersistenceBrokerFactoryIF
See Also:
PersistenceBrokerFactoryIF.getDefaultKey()

createPersistenceBroker

public PersistenceBroker createPersistenceBroker(PBKey pbKey)
                                          throws PBFactoryException
Always return a new created PersistenceBroker instance

Specified by:
createPersistenceBroker in interface PersistenceBrokerFactoryIF
Parameters:
pbKey -
Returns:
Throws:
PBFactoryException

createPersistenceBroker

public PersistenceBroker createPersistenceBroker(java.lang.String jcdAlias,
                                                 java.lang.String user,
                                                 java.lang.String password)
                                          throws PBFactoryException
Description copied from interface: PersistenceBrokerFactoryIF
Return a ready for action PersistenceBroker instance.

Specified by:
createPersistenceBroker in interface PersistenceBrokerFactoryIF
Parameters:
jcdAlias - An jcdAlias name specified in a jdbc-connection-descriptor
user - user name specified in a jdbc-connection-descriptor
password - valid password specified in a jdbc-connection-descriptor
Throws:
PBFactoryException
See Also:
PersistenceBrokerFactoryIF.createPersistenceBroker( String jcdAlias, String user, String password)

defaultPersistenceBroker

public PersistenceBroker defaultPersistenceBroker()
                                           throws PBFactoryException
Description copied from interface: PersistenceBrokerFactoryIF
Return a default broker instance, specified in configuration or set using PersistenceBrokerFactoryIF.setDefaultKey(org.apache.ojb.broker.PBKey).

Specified by:
defaultPersistenceBroker in interface PersistenceBrokerFactoryIF
Throws:
PBFactoryException
See Also:
PersistenceBrokerFactoryIF.createPersistenceBroker(PBKey key)

configure

public void configure(org.apache.ojb.broker.util.configuration.Configuration config)
               throws org.apache.ojb.broker.util.configuration.ConfigurationException
Specified by:
configure in interface org.apache.ojb.broker.util.configuration.Configurable
Throws:
org.apache.ojb.broker.util.configuration.ConfigurationException

releaseAllInstances

public void releaseAllInstances()
Description copied from interface: PersistenceBrokerFactoryIF
release all broker instances pooled by the factory. each broker instance is closed before release.

Specified by:
releaseAllInstances in interface PersistenceBrokerFactoryIF
See Also:
PersistenceBrokerFactoryIF.releaseAllInstances()

activePersistenceBroker

public int activePersistenceBroker()
Not implemented!

Specified by:
activePersistenceBroker in interface PersistenceBrokerFactoryIF
Returns:
always 0


(C) 2002 - 2004 Apache Software Foundation
All rights reserved. Published under the Apache License 2.0.
http://db.apache.org/ojb
Version: 1.0.3, 2005-04-2