org.apache.ojb.broker.util.configuration.impl
Class OjbConfiguration

java.lang.Object
  extended byorg.apache.ojb.broker.util.configuration.impl.ConfigurationAbstractImpl
      extended byorg.apache.ojb.broker.util.configuration.impl.OjbConfiguration
All Implemented Interfaces:
Configuration, LockingConfiguration, LoggingConfiguration, MetadataConfiguration, OdmgConfiguration, PBPoolConfiguration, PersistenceBrokerConfiguration

public class OjbConfiguration
extends ConfigurationAbstractImpl
implements LoggingConfiguration, OdmgConfiguration, LockingConfiguration, PersistenceBrokerConfiguration, PBPoolConfiguration, MetadataConfiguration

This class contains the runtime configuration of the OJB system. This Configuration is read in only once at application startup. Changes to the OJB.properties file during execution are not reflected back into the application!

Version:
$Id: OjbConfiguration.java,v 1.31 2004/01/17 16:57:34 thma Exp $
Author:
Thomas Mahler

Field Summary
 
Fields inherited from class org.apache.ojb.broker.util.configuration.impl.ConfigurationAbstractImpl
filename, properties
 
Constructor Summary
OjbConfiguration()
           
 
Method Summary
 java.lang.String[] getCacheFilters()
          Returns an array of the declared CacheFilter, or null if none found.
 java.lang.Class getCollectionProxyClass()
          Answer the class to be used for CollectionProxy
 java.lang.Class getConnectionFactoryClass()
           
 java.lang.Class getLockManagerClass()
           
 java.lang.Class getLockMapClass()
           
 java.lang.Class getLoggerClass()
           
 java.lang.String getLoggerConfigFile()
           
 java.lang.String getLogLevel(java.lang.String loggerName)
           
 int getMaxActive()
           
 int getMaxIdle()
           
 long getMaxWaitMillis()
           
 long getMinEvictableIdleTimeMillis()
           
 java.lang.Class getObjectCacheClass()
           
 java.lang.Class getOqlCollectionClass()
          This class is used to hold results of OQL queries.
 java.lang.Class getPersistenceBrokerClass()
           
 java.lang.Class getPersistentFieldClass()
           
 java.lang.String getRepositoryFilename()
           
 int getSqlInLimit()
          Returns the SQLInLimit.
 long getTimeBetweenEvictionRunsMilli()
           
 byte getWhenExhaustedAction()
           
protected  void load()
          loads the configuration from file "OBJ.properties".
 boolean lockAssociationAsWrites()
          If true acquiring a write-lock on a given object x implies write locks on all objects associated to x.
 void setCacheFilters(java.lang.String[] filters)
          Useful when writing test cases
 void setPersistentFieldClass(java.lang.Class persistentFieldClass)
          Sets the persistentFieldClass.
 void setUseImplicitLocking(boolean implicitLocking)
           
 boolean useImplicitLocking()
          defines if implicit lock acquisition is to be used.
 boolean useSerializedRepository()
          If true OJB use a serialized version of the repository configuration file for repetition read.
 
Methods inherited from class org.apache.ojb.broker.util.configuration.impl.ConfigurationAbstractImpl
getBoolean, getByte, getClass, getClass, getClass, getInteger, getLong, getString, getStrings, getStrings, setFilename, setLogger
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.apache.ojb.broker.util.configuration.Configuration
getBoolean, getClass, getClass, getClass, getInteger, getString, getStrings, getStrings, setLogger
 

Constructor Detail

OjbConfiguration

public OjbConfiguration()
Method Detail

useSerializedRepository

public boolean useSerializedRepository()
Description copied from interface: MetadataConfiguration
If true OJB use a serialized version of the repository configuration file for repetition read.

Specified by:
useSerializedRepository in interface MetadataConfiguration

lockAssociationAsWrites

public boolean lockAssociationAsWrites()
Description copied from interface: OdmgConfiguration
If true acquiring a write-lock on a given object x implies write locks on all objects associated to x. If false implicit read-locks are acquired.

Specified by:
lockAssociationAsWrites in interface OdmgConfiguration

getRepositoryFilename

public java.lang.String getRepositoryFilename()
Specified by:
getRepositoryFilename in interface PersistenceBrokerConfiguration

getLoggerConfigFile

public java.lang.String getLoggerConfigFile()
Specified by:
getLoggerConfigFile in interface LoggingConfiguration

getLogLevel

public java.lang.String getLogLevel(java.lang.String loggerName)
Specified by:
getLogLevel in interface LoggingConfiguration

getMaxActive

public int getMaxActive()
Specified by:
getMaxActive in interface PBPoolConfiguration

getMaxIdle

public int getMaxIdle()
Specified by:
getMaxIdle in interface PBPoolConfiguration

getMaxWaitMillis

public long getMaxWaitMillis()
Specified by:
getMaxWaitMillis in interface PBPoolConfiguration

getTimeBetweenEvictionRunsMilli

public long getTimeBetweenEvictionRunsMilli()
Specified by:
getTimeBetweenEvictionRunsMilli in interface PBPoolConfiguration

getMinEvictableIdleTimeMillis

public long getMinEvictableIdleTimeMillis()
Specified by:
getMinEvictableIdleTimeMillis in interface PBPoolConfiguration

getWhenExhaustedAction

public byte getWhenExhaustedAction()
Specified by:
getWhenExhaustedAction in interface PBPoolConfiguration

getObjectCacheClass

public java.lang.Class getObjectCacheClass()
Specified by:
getObjectCacheClass in interface PersistenceBrokerConfiguration

getCacheFilters

public java.lang.String[] getCacheFilters()
Description copied from interface: PersistenceBrokerConfiguration
Returns an array of the declared CacheFilter, or null if none found.

Specified by:
getCacheFilters in interface PersistenceBrokerConfiguration

setCacheFilters

public void setCacheFilters(java.lang.String[] filters)
Useful when writing test cases


getConnectionFactoryClass

public java.lang.Class getConnectionFactoryClass()
Specified by:
getConnectionFactoryClass in interface PersistenceBrokerConfiguration

getLockManagerClass

public java.lang.Class getLockManagerClass()
Specified by:
getLockManagerClass in interface LockingConfiguration

getOqlCollectionClass

public java.lang.Class getOqlCollectionClass()
Description copied from interface: OdmgConfiguration
This class is used to hold results of OQL queries. By default a DListImpl is used.

Specified by:
getOqlCollectionClass in interface OdmgConfiguration

getLockMapClass

public java.lang.Class getLockMapClass()
Specified by:
getLockMapClass in interface LockingConfiguration

getLoggerClass

public java.lang.Class getLoggerClass()
Specified by:
getLoggerClass in interface LoggingConfiguration

getPersistentFieldClass

public java.lang.Class getPersistentFieldClass()
Specified by:
getPersistentFieldClass in interface PersistenceBrokerConfiguration

getPersistenceBrokerClass

public java.lang.Class getPersistenceBrokerClass()
Specified by:
getPersistenceBrokerClass in interface PersistenceBrokerConfiguration

load

protected void load()
loads the configuration from file "OBJ.properties". If the system property "OJB.properties" is set, then the configuration in that file is loaded.

Overrides:
load in class ConfigurationAbstractImpl
See Also:
ConfigurationAbstractImpl.setFilename(java.lang.String)

getSqlInLimit

public int getSqlInLimit()
Returns the SQLInLimit.

Specified by:
getSqlInLimit in interface PersistenceBrokerConfiguration
Returns:
int

setPersistentFieldClass

public void setPersistentFieldClass(java.lang.Class persistentFieldClass)
Sets the persistentFieldClass.

Parameters:
persistentFieldClass - The persistentFieldClass to set

useImplicitLocking

public boolean useImplicitLocking()
Description copied from interface: OdmgConfiguration
defines if implicit lock acquisition is to be used. If set to true OJB implicitely locks objects to ODMG transactions after performing OQL queries. If implicit locking is used locking objects is recursive, that is associated objects are also locked. If ImplicitLocking is set to false, no locks are obtained in OQL queries and there is also no recursive locking.

Specified by:
useImplicitLocking in interface OdmgConfiguration
See Also:
OdmgConfiguration.useImplicitLocking()

setUseImplicitLocking

public void setUseImplicitLocking(boolean implicitLocking)

getCollectionProxyClass

public java.lang.Class getCollectionProxyClass()
Description copied from interface: PersistenceBrokerConfiguration
Answer the class to be used for CollectionProxy

Specified by:
getCollectionProxyClass in interface PersistenceBrokerConfiguration
Returns:
Class
See Also:
PersistenceBrokerConfiguration.getCollectionProxyClass()


Authors: Thomas Mahler and others. (C) 2000 - 2003 Apache Software Foundation
All rights reserved. Published under the Apache License.
http://db.apache.org/ojb
Version: 1.0.rc5, 2003-12-14