asmuts 2004/07/07 17:49:19
Added: src/java/org/apache/jcs/auxiliary/disk/bdbje
BDBJECacheManager.java BDBJECacheFactory.java
BDBJECacheAttributes.java BDBJECache.java
BDBJE.java
Log:
move from experimental to main source directory
Revision Changes Path
1.1
jakarta-turbine-jcs/src/java/org/apache/jcs/auxiliary/disk/bdbje/BDBJECacheManager.java
Index: BDBJECacheManager.java
===================================================================
package org.apache.jcs.auxiliary.disk.bdbje;
/*
* Copyright 2001-2004 The Apache Software Foundation.
*
* Licensed under the Apache License, Version 2.0 (the "License")
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import java.util.Hashtable;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.apache.jcs.auxiliary.AuxiliaryCache;
import org.apache.jcs.auxiliary.AuxiliaryCacheManager;
/**
* This uses one berkely db for all regions.
*
*/
public class BDBJECacheManager
implements AuxiliaryCacheManager
{
private final static Log log = LogFactory.getLog( BDBJECacheManager.class );
private static int clients;
private static BDBJECacheManager instance;
private Hashtable caches = new Hashtable();
private BDBJECacheAttributes defaultCacheAttributes;
/* right now use one berkely db for all regions */
//private BDBJE je;
/**
* Constructor for the IndexedDiskCacheManager object
*
* @param defaultCacheAttributes Default attributes for caches managed by
* the instance.
*/
private BDBJECacheManager( BDBJECacheAttributes defaultCacheAttributes )
{
this.defaultCacheAttributes = defaultCacheAttributes;
//je = new BDBJE( defaultCacheAttributes );
if ( log.isDebugEnabled() )
{
log.debug( "Created JE" );
}
}
/**
* Gets the singleton instance of the manager
*
* @param defaultCacheAttributes If the instance has not yet been created,
* it will be initialized with this set of
* default attributes.
* @return The instance value
*/
public static BDBJECacheManager getInstance( BDBJECacheAttributes
defaultCacheAttributes )
{
if ( instance == null )
{
synchronized ( BDBJECacheManager.class )
{
if ( instance == null )
{
instance = new BDBJECacheManager( defaultCacheAttributes );
}
}
}
clients++;
return instance;
}
/**
* Gets an IndexedDiskCache for the supplied name using the default
* attributes.
*
* @see #getCache( IndexedDiskCacheAttributes }
*
* @param cacheName Name that will be used when creating attributes.
* @return A cache.
*/
public AuxiliaryCache getCache( String cacheName )
{
BDBJECacheAttributes cacheAttributes =
( BDBJECacheAttributes ) defaultCacheAttributes.copy();
cacheAttributes.setCacheName( cacheName );
return getCache( cacheAttributes );
}
/**
* Get an IndexedDiskCache for the supplied attributes. Will provide an
* existing cache for the name attribute if one has been created, or will
* create a new cache.
*
* @param cacheAttributes Attributes the cache should have.
* @return A cache, either from the existing set or newly created.
*
*/
public AuxiliaryCache getCache( BDBJECacheAttributes cacheAttributes )
{
AuxiliaryCache cache = null;
String cacheName = cacheAttributes.getCacheName();
log.debug( "Getting cache named: " + cacheName );
synchronized ( caches )
{
// Try to load the cache from the set that have already been
// created. This only looks at the name attribute.
cache = ( AuxiliaryCache ) caches.get( cacheName );
// If it was not found, create a new one using the supplied
// attributes
if ( cache == null )
{
cache = new BDBJECache( cacheAttributes );
caches.put( cacheName, cache );
}
}
if ( log.isDebugEnabled() )
{
log.debug( "returning cache = '" + cache + "'" );
}
return cache;
}
/**
* Gets the cacheType attribute of the DiskCacheManager object
*
* @return The cacheType value
*/
public int getCacheType()
{
return DISK_CACHE;
}
}
1.1
jakarta-turbine-jcs/src/java/org/apache/jcs/auxiliary/disk/bdbje/BDBJECacheFactory.java
Index: BDBJECacheFactory.java
===================================================================
package org.apache.jcs.auxiliary.disk.bdbje;
/*
* Copyright 2001-2004 The Apache Software Foundation.
*
* Licensed under the Apache License, Version 2.0 (the "License")
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.apache.jcs.auxiliary.AuxiliaryCache;
import org.apache.jcs.auxiliary.AuxiliaryCacheAttributes;
import org.apache.jcs.auxiliary.AuxiliaryCacheFactory;
import org.apache.jcs.engine.control.CompositeCache;
/**
* This factory creates Berkeley DB JE disk cache auxiliaries.
*/
public class BDBJECacheFactory
implements AuxiliaryCacheFactory
{
private final static Log log =
LogFactory.getLog( BDBJECacheFactory.class );
private String name;
/* (non-Javadoc)
* @see
org.apache.jcs.auxiliary.AuxiliaryCacheFactory#createCache(org.apache.jcs.auxiliary.AuxiliaryCacheAttributes,
org.apache.jcs.engine.control.CompositeCache)
*/
public AuxiliaryCache createCache(
AuxiliaryCacheAttributes attr,
CompositeCache cache )
{
BDBJECacheAttributes jeattr = ( BDBJECacheAttributes ) attr;
BDBJECacheManager jecm = BDBJECacheManager.getInstance( jeattr );
return jecm.getCache( jeattr );
}
/* (non-Javadoc)
* @see org.apache.jcs.auxiliary.AuxiliaryCacheFactory#setName(java.lang.String)
*/
public void setName( String s )
{
this.name = s;
}
/* (non-Javadoc)
* @see org.apache.jcs.auxiliary.AuxiliaryCacheFactory#getName()
*/
public String getName()
{
return this.name;
}
}
1.1
jakarta-turbine-jcs/src/java/org/apache/jcs/auxiliary/disk/bdbje/BDBJECacheAttributes.java
Index: BDBJECacheAttributes.java
===================================================================
package org.apache.jcs.auxiliary.disk.bdbje;
/*
* Copyright 2001-2004 The Apache Software Foundation.
*
* Licensed under the Apache License, Version 2.0 (the "License")
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import org.apache.jcs.auxiliary.AuxiliaryCacheAttributes;
/**
* Attributes for Berkeley DB JE disk cache auxiliary.
*/
public class BDBJECacheAttributes
implements AuxiliaryCacheAttributes
{
private String cacheName;
private String name;
private String diskPath;
/* (non-Javadoc)
* @see
org.apache.jcs.auxiliary.AuxiliaryCacheAttributes#setCacheName(java.lang.String)
*/
public void setCacheName( String s )
{
cacheName = s;
}
/* (non-Javadoc)
* @see org.apache.jcs.auxiliary.AuxiliaryCacheAttributes#getCacheName()
*/
public String getCacheName()
{
return cacheName;
}
/* (non-Javadoc)
* @see org.apache.jcs.auxiliary.AuxiliaryCacheAttributes#setName(java.lang.String)
*/
public void setName( String s )
{
name = s;
}
/* (non-Javadoc)
* @see org.apache.jcs.auxiliary.AuxiliaryCacheAttributes#getName()
*/
public String getName()
{
return name;
}
/* (non-Javadoc)
* @see org.apache.jcs.auxiliary.AuxiliaryCacheAttributes#copy()
*/
public AuxiliaryCacheAttributes copy()
{
try
{
return ( AuxiliaryCacheAttributes )this.clone();
}
catch ( Exception e )
{
}
return this;
}
/**
* Sets the diskPath attribute of CacheAttributes object
*
* @param path The new diskPath value
*/
public void setDiskPath( String path )
{
this.diskPath = path.trim();
}
/**
* Gets the diskPath attribute of the CacheAttributes object
*
* @return The diskPath value
*/
public String getDiskPath()
{
return this.diskPath;
}
}
1.1
jakarta-turbine-jcs/src/java/org/apache/jcs/auxiliary/disk/bdbje/BDBJECache.java
Index: BDBJECache.java
===================================================================
package org.apache.jcs.auxiliary.disk.bdbje;
/*
* Copyright 2001-2004 The Apache Software Foundation.
*
* Licensed under the Apache License, Version 2.0 (the "License")
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import java.io.Serializable;
import java.util.Set;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.apache.jcs.auxiliary.disk.AbstractDiskCache;
import org.apache.jcs.engine.behavior.ICacheElement;
/**
* One BDBJECache per regions. For now they share one underlying Berekeley DB.
*/
public class BDBJECache
extends AbstractDiskCache
{
private final static Log log =
LogFactory.getLog( BDBJECache.class );
/* right now we are using one berkely db for all regions */
private BDBJE je;
public BDBJECache( BDBJECacheAttributes attr )
{
super( attr.getCacheName() );
this.je = new BDBJE( attr );
if ( log.isDebugEnabled() )
{
log.debug( "constructed BDBJECache" );
}
// Initialization finished successfully, so set alive to true.
alive = true;
}
/* (non-Javadoc)
* @see org.apache.jcs.auxiliary.AuxiliaryCache#getGroupKeys(java.lang.String)
*/
public Set getGroupKeys( String groupName )
{
// TODO Auto-generated method stub
return null;
}
/* (non-Javadoc)
* @see org.apache.jcs.engine.behavior.ICache#getSize()
*/
public int getSize()
{
// TODO Auto-generated method stub
return 0;
}
/* (non-Javadoc)
* @see org.apache.jcs.auxiliary.disk.AbstractDiskCache#doGet(java.io.Serializable)
*/
protected ICacheElement doGet( Serializable key )
{
if ( log.isDebugEnabled() )
{
log.debug( "doGet, key '" + key + "'" );
}
ICacheElement retVal = null;
try
{
retVal = je.get( key );
}
catch ( Exception e )
{
log.error( e );
}
return retVal;
}
/* (non-Javadoc)
* @see
org.apache.jcs.auxiliary.disk.AbstractDiskCache#doUpdate(org.apache.jcs.engine.behavior.ICacheElement)
*/
protected void doUpdate( ICacheElement element )
{
if ( log.isDebugEnabled() )
{
log.debug( "doUpdate, key '" + element.getKey() + "'" );
}
try
{
je.update( element );
}
catch ( Exception e )
{
log.error( e );
}
}
/* (non-Javadoc)
* @see
org.apache.jcs.auxiliary.disk.AbstractDiskCache#doRemove(java.io.Serializable)
*/
protected boolean doRemove( Serializable key )
{
if ( log.isDebugEnabled() )
{
log.debug( "doRemove, key '" + key + "'" );
}
try
{
je.remove( key );
}
catch ( Exception e )
{
log.error( e );
return false;
}
return true;
}
/* (non-Javadoc)
* @see org.apache.jcs.auxiliary.disk.AbstractDiskCache#doRemoveAll()
*/
protected void doRemoveAll()
{
if ( log.isDebugEnabled() )
{
log.debug( "doRemoveAll" );
}
try
{
je.removeAll();
}
catch ( Exception e )
{
log.error( e );
}
}
/* (non-Javadoc)
* @see org.apache.jcs.auxiliary.disk.AbstractDiskCache#doDispose()
*/
protected void doDispose()
{
je.dispose();
}
}
1.1
jakarta-turbine-jcs/src/java/org/apache/jcs/auxiliary/disk/bdbje/BDBJE.java
Index: BDBJE.java
===================================================================
package org.apache.jcs.auxiliary.disk.bdbje;
/*
* Copyright 2001-2004 The Apache Software Foundation.
*
* Licensed under the Apache License, Version 2.0 (the "License")
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import java.io.File;
import java.io.IOException;
import java.io.Serializable;
import java.util.List;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.apache.jcs.engine.behavior.ICacheElement;
import com.sleepycat.bind.EntryBinding;
import com.sleepycat.bind.serial.SerialBinding;
import com.sleepycat.bind.serial.StoredClassCatalog;
import com.sleepycat.je.Database;
import com.sleepycat.je.DatabaseConfig;
import com.sleepycat.je.DatabaseEntry;
import com.sleepycat.je.DatabaseStats;
import com.sleepycat.je.DatabaseException;
import com.sleepycat.je.Environment;
import com.sleepycat.je.EnvironmentConfig;
import com.sleepycat.je.EnvironmentStats;
import com.sleepycat.je.LockMode;
import com.sleepycat.je.OperationStatus;
import com.sleepycat.je.StatsConfig;
import com.sleepycat.je.Transaction;
/**
* All regions share an environment. In an environment they each have
* a database.
*/
public class BDBJE
{
private final static Log log = LogFactory.getLog( BDBJE.class );
private File envDir;
private Environment coreEnv;
private Database coreDb;
private Database catalogDb;
private StoredClassCatalog catalog;
private BDBJECacheAttributes attributes;
/**
*
*/
public BDBJE( BDBJECacheAttributes attr )
{
attributes = attr;
// create the directory if it doesn't exist. JE won't do it.
envDir = new File(attributes.getDiskPath());
if ( !envDir.exists() ) {
envDir.mkdir();
}
init();
}
private void init()
{
try
{
/* Create a new, transactional database environment */
EnvironmentConfig envConfig = new EnvironmentConfig();
envConfig.setTransactional( true );
// create the env if it doesn't exist, else do nothing
envConfig.setAllowCreate( true );
coreEnv = new Environment( envDir, envConfig );
/* Make a database within that environment */
Transaction txn = coreEnv.beginTransaction( null, null );
DatabaseConfig dbConfig = new DatabaseConfig();
dbConfig.setTransactional( true );
dbConfig.setAllowCreate( true );
dbConfig.setSortedDuplicates( false );
// create a database for this region. Aovids the overhead of
// a secondary database for grouping.
coreDb =
coreEnv.openDatabase( txn, attributes.getCacheName(), dbConfig );
if ( log.isInfoEnabled() )
{
log.info(
"created db for region = '"
+ attributes.getCacheName()
+ "'" );
}
/*
* A class catalog database is needed for storing class descriptions
* for the serial binding used below. This avoids storing class
* descriptions redundantly in each record.
*/
DatabaseConfig catalogConfig = new DatabaseConfig();
catalogConfig.setTransactional( true );
catalogConfig.setAllowCreate( true );
catalogDb = coreEnv.openDatabase( txn, "catalogDb", catalogConfig );
catalog = new StoredClassCatalog( catalogDb );
txn.commit();
}
catch ( Exception e )
{
log.error( "Problem init", e );
}
if ( log.isDebugEnabled() )
{
log.debug( "Intitialized BDBJE" );
}
} // end intit
/** Getts an item from the cache. */
public ICacheElement get( Serializable key ) throws IOException
{
if ( log.isDebugEnabled() )
{
log.debug( "get key= '" + key + "'" );
}
ICacheElement ice = null;
try
{
/* DatabaseEntry represents the key and data of each record */
DatabaseEntry searchKey = new DatabaseEntry();
EntryBinding keyBinding =
new SerialBinding( catalog, key.getClass() );
/*
* Create a serial binding for MyData data objects. Serial bindings
* can be used to store any Serializable object.
*/
EntryBinding dataBinding =
new SerialBinding( catalog, ICacheElement.class );
keyBinding.objectToEntry( key, searchKey );
// foundKey and foundData are populated from the primary entry that
DatabaseEntry foundKey = new DatabaseEntry();
DatabaseEntry foundData = new DatabaseEntry();
OperationStatus retVal =
coreDb.get( null, searchKey, foundData, LockMode.DEFAULT );
if ( retVal == OperationStatus.SUCCESS )
{
ice = ( ICacheElement ) dataBinding.entryToObject( foundData );
if ( log.isDebugEnabled() )
{
log.debug( "key=" + key + " ice=" + ice );
}
}
}
catch ( Exception e )
{
log.error( "Problem updating", e );
}
return ice;
}
/** Puts a cache item to the cache. */
public void update( ICacheElement item ) throws IOException
{
try
{
Transaction txn = coreEnv.beginTransaction( null, null );
/*
* Create a serial binding for MyData data objects. Serial bindings
* can be used to store any Serializable object.
*/
EntryBinding dataBinding =
new SerialBinding( catalog, ICacheElement.class );
EntryBinding keyBinding =
new SerialBinding( catalog, item.getKey().getClass() );
/* DatabaseEntry represents the key and data of each record */
DatabaseEntry dataEntry = new DatabaseEntry();
DatabaseEntry keyEntry = new DatabaseEntry();
dataBinding.objectToEntry( item, dataEntry );
keyBinding.objectToEntry( item.getKey(), keyEntry );
OperationStatus status = coreDb.put( txn, keyEntry, dataEntry );
if ( log.isDebugEnabled() )
{
log.debug(
"Put key '"
+ item.getKey()
+ "' on disk \n status = '"
+ status
+ "'" );
}
/*
* Note that put will throw a DatabaseException when
* error conditions are found such as deadlock.
* However, the status return conveys a variety of
* information. For example, the put might succeed,
* or it might not succeed if the record exists
* and duplicates were not
*/
if ( status != OperationStatus.SUCCESS )
{
throw new DatabaseException(
"Data insertion got status " + status );
}
txn.commit();
}
catch ( Exception e )
{
log.error( e );
}
}
/** Removes the given key from the specified cache. */
public void remove( Serializable key ) throws IOException
{
try
{
DatabaseEntry searchKey = new DatabaseEntry();
EntryBinding keyBinding =
new SerialBinding( catalog, key.getClass() );
keyBinding.objectToEntry( key, searchKey );
coreDb.delete( null, searchKey );
if ( log.isDebugEnabled() )
{
log.debug( "removed, key = '" + key + "'" );
}
}
catch ( Exception e )
{
log.error( "Problem removing key = '" + key + "'", e );
}
}
/** Remove all keys from the sepcified cache. */
public void removeAll() throws IOException
{
/*
Transaction txn = null;
Cursor cursor = null;
try {
DatabaseEntry keyEntry = new DatabaseEntry();
DatabaseEntry dataEntry = new DatabaseEntry();
txn = coreEnv.beginTransaction(null, null);
cursor = coreDb.openCursor(txn, null);
int cnt = 0;
while (cursor.getNext(keyEntry, dataEntry, LockMode.DEFAULT)
== OperationStatus.SUCCESS) {
if (log.isDebugEnabled()) {
log.debug("removed, cnt = " + cnt++);
}
cursor.delete();
}
} catch (Exception e) {
log.error(e);
} finally {
try {
cursor.close();
txn.commit();
} catch (Exception e) {
log.error(e);
}
}
*/
Transaction txn = null;
try
{
txn = coreEnv.beginTransaction( null, null );
coreDb.truncate( txn, false );
}
catch ( Exception e )
{
log.error( e );
}
finally
{
try
{
txn.commit();
}
catch ( Exception e )
{
log.error( e );
}
}
}
/*
* Closes the database and the environment. Client should do some
* client checks.
*/
protected void dispose()
{
if ( log.isWarnEnabled() )
{
log.debug( "Disposig of je" );
}
if ( log.isInfoEnabled() )
{
log.info( this.toString() );
}
if ( coreEnv != null )
{
try
{
coreEnv.sync();
//Close the secondary before closing the primaries
coreDb.close();
catalogDb.close();
// Finally, close the environment.
coreEnv.close();
}
catch ( DatabaseException dbe )
{
log.error( "Error closing coreEnv: " + dbe.toString() );
}
}
}
/*
* Returns info about the JE
* @see java.lang.Object#toString()
*/
public String toString()
{
StringBuffer buf = new StringBuffer();
try
{
buf.append( "\n This database name: " + coreDb.getDatabaseName() );
buf.append( "\n This database stats: " + getDBStats() );
buf.append( "\n -------------------------------------" );
buf.append( "\n Environment Data:"; );
EnvironmentStats stats = coreEnv.getStats( new StatsConfig() );
buf.append( "\n NCacheMiss: " + stats.getNCacheMiss() );
buf.append( "\n CacheTotalBytes: " + stats.getCacheTotalBytes() );
buf.append( "\n NCleanerRuns: " + stats.getNCleanerRuns() );
buf.append( "\n -------------------------------------" );
buf.append( "\n Other Databases in this Environment:" );
List myDbNames = coreEnv.getDatabaseNames();
for ( int i = 0; i < myDbNames.size(); i++ )
{
buf.append( "\n Database Name: " + ( String ) myDbNames.get( i ) );
}
}
catch ( DatabaseException dbe )
{
log.error( "Error getting toString()" + dbe.toString() );
}
return buf.toString();
}
/**
* Gets the stats for this db.
* @return
*/
public String getDBStats()
{
StringBuffer buf = new StringBuffer();
try
{
DatabaseStats stats = coreDb.getStats( new StatsConfig() );
buf.append( "\n BinCount: " + stats.getBinCount() );
buf.append( "\n DeletedLNCount: " + stats.getDeletedLNCount() );
buf.append( "\n DupCountLNCount: " + stats.getDupCountLNCount() );
buf.append( "\n InCount: " + stats.getInCount() );
buf.append( "\n LnCount: " + stats.getLnCount() );
buf.append( "\n MaxDepth: " + stats.getMaxDepth() );
}
catch ( DatabaseException dbe )
{
log.error( "Error getting stats" + dbe.toString() );
}
return buf.toString();
}
}
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
