unico 2004/03/04 17:55:59
Modified: src/blocks/scratchpad/conf jcs-store.xconf
Added: src/blocks/scratchpad/java/org/apache/cocoon/components/store
JCSStore.java
src/blocks/scratchpad/WEB-INF cache.ccf
Removed: src/blocks/scratchpad/java/org/apache/cocoon/components/store
AbstractJCSStore.java JCSPersistentStore.java
src/blocks/scratchpad/WEB-INF/classes TestDiskCache.ccf
Log:
- load properties file from Source
- JCS is not restricted to be a persistent store (name change)
- uncomment patch configuration
Fixme: haven't figured out how to actually persist data
Revision Changes Path
1.3 +6 -7 cocoon-2.1/src/blocks/scratchpad/conf/jcs-store.xconf
Index: jcs-store.xconf
===================================================================
RCS file: /home/cvs/cocoon-2.1/src/blocks/scratchpad/conf/jcs-store.xconf,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- jcs-store.xconf 4 Mar 2004 23:04:04 -0000 1.2
+++ jcs-store.xconf 5 Mar 2004 01:55:59 -0000 1.3
@@ -1,14 +1,13 @@
<?xml version="1.0"?>
-<xconf xpath="/cocoon" unless="comment()[contains(., 'Experimental JCS Store
implementation')]">
+<xconf xpath="/cocoon" unless="[EMAIL
PROTECTED]'org.apache.cocoon.components.store.JCSStore']">
<!-- Experimental JCS Store implementation -->
- <!--
- <persistent-store
class="org.apache.cocoon.components.store.JCSPersistentStore"
+ <persistent-store class="org.apache.cocoon.components.store.JCSStore"
logger="core.store.persistent">
- <parameter name="region-name" value="indexedRegion1"/>
- <parameter name="group-name" value="indexedDiskCache"/>
- <parameter name="config-file" value="/TestDiskCache.ccf"/>
+ <parameter name="region-name" value="indexedRegion4"/>
+ <parameter name="group-name" value="indexedDiskCache2"/>
+ <parameter name="config-file" value="context://WEB-INF/cache.ccf"/>
</persistent-store>
- -->
+
</xconf>
1.1
cocoon-2.1/src/blocks/scratchpad/java/org/apache/cocoon/components/store/JCSStore.java
Index: JCSStore.java
===================================================================
/*
============================================================================
The Apache Software License, Version 1.1
============================================================================
Copyright (C) 2004 The Apache Software Foundation. All rights reserved.
Redistribution and use in source and binary forms, with or without modifica-
tion, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
3. The end-user documentation included with the redistribution, if any, must
include the following acknowledgment: "This product includes software
developed by the Apache Software Foundation (http://www.apache.org/)."
Alternately, this acknowledgment may appear in the software itself, if
and wherever such third-party acknowledgments normally appear.
4. The names "Apache Cocoon" and "Apache Software Foundation" must not be
used to endorse or promote products derived from this software without
prior written permission. For written permission, please contact
[EMAIL PROTECTED]
5. Products derived from this software may not be called "Apache", nor may
"Apache" appear in their name, without prior written permission of the
Apache Software Foundation.
THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
APACHE SOFTWARE FOUNDATION OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLU-
DING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
This software consists of voluntary contributions made by many individuals
on behalf of the Apache Software Foundation and was originally created by
Stefano Mazzocchi <[EMAIL PROTECTED]>. For more information on the Apache
Software Foundation, please see <http://www.apache.org/>.
*/
package org.apache.cocoon.components.store;
import java.io.IOException;
import java.io.Serializable;
import java.util.Enumeration;
import java.util.Properties;
import org.apache.avalon.framework.activity.Disposable;
import org.apache.avalon.framework.activity.Initializable;
import org.apache.avalon.framework.parameters.ParameterException;
import org.apache.avalon.framework.parameters.Parameterizable;
import org.apache.avalon.framework.parameters.Parameters;
import org.apache.avalon.framework.service.ServiceException;
import org.apache.avalon.framework.service.ServiceManager;
import org.apache.avalon.framework.service.Serviceable;
import org.apache.avalon.framework.thread.ThreadSafe;
import org.apache.excalibur.source.Source;
import org.apache.excalibur.source.SourceResolver;
import org.apache.excalibur.store.Store;
import org.apache.excalibur.store.impl.AbstractReadWriteStore;
import org.apache.jcs.access.GroupCacheAccess;
import org.apache.jcs.access.exception.CacheException;
import org.apache.jcs.engine.control.CompositeCache;
import org.apache.jcs.engine.control.CompositeCacheManager;
/**
* TODO - This store implementation should be moved to excalibur store
*
* The JCS Configuration file - for details see:
* http://jakarta.apache.org/turbine/jcs/BasicJCSConfiguration.html
*
* @author <a href="mailto:[EMAIL PROTECTED]">Corin Moss</a>
* @author <a href="mailto:[EMAIL PROTECTED]">Carsten Ziegeler</a>
*/
public class JCSStore extends AbstractReadWriteStore
implements Store, Serviceable, Parameterizable, Initializable,
Disposable, ThreadSafe {
/** The JCS configuration properties */
private Properties m_properties;
/** The Region as used by JCS*/
private String m_region;
/** The group name as used by JCS getGroupKeys*/
private String m_group;
/** JCS Cache manager */
private CompositeCacheManager m_cacheManager;
/** The Java Cache System object */
private JCSCacheAccess m_JCS;
/** Access to the SourceResolver */
private ServiceManager m_manager;
// ---------------------------------------------------- Lifecycle
public JCSStore() {
}
public void service(ServiceManager manager) throws ServiceException {
m_manager = manager;
}
/**
* Configure the Component.<br>
* A few options can be used
* <ul>
* <li>
* <code>config-file</code>: the name of the file which specifies
* the configuration parameters
* </li>
* <li>
* <code>region-name<code>: the region to be used as defined in the
config file
* </li>
* <li>
* <code>group-name</code>: the group to be used as defined in the
config file
* </li>
* </ul>
*
* @param params the configuration paramters
* @exception ParameterException
*/
public void parameterize(Parameters params) throws ParameterException {
// TODO - These are only values for testing:
String configFile = params.getParameter("config-file",
"context://WEB-INF/cache.ccf");
m_region = params.getParameter("region-name", "indexedRegion1");
m_group = params.getParameter("group-name", "indexedDiskCache");
if (this.getLogger().isDebugEnabled()) {
getLogger().debug("CEM Loading config: '" + configFile + "'");
getLogger().debug("CEM Loading region: '" + m_region + "'");
getLogger().debug("CEM Loading group: '" + m_group + "'");
}
Source source = null;
SourceResolver resolver = null;
try {
resolver = (SourceResolver) m_manager.lookup(SourceResolver.ROLE);
source = resolver.resolveURI(configFile);
if (!source.exists()) {
throw new ParameterException("No config file at configured
location: " + configFile);
}
m_properties = new Properties();
m_properties.load(source.getInputStream());
}
catch (IOException e) {
throw new ParameterException("Failed to load JCS properties
file",e);
}
catch (ServiceException e) {
throw new ParameterException("Missing service dependency:
SourceResolver",e);
}
finally {
if (resolver != null && source != null) {
resolver.release(source);
}
}
}
public void initialize() throws Exception {
m_cacheManager = CompositeCacheManager.getUnconfiguredInstance();
m_cacheManager.configure(m_properties);
m_JCS = new JCSCacheAccess(m_cacheManager.getCache(m_region));
}
public void dispose() {
// FIXME: how to actually persist the stored items?
m_JCS.save();
m_cacheManager.freeCache(m_region);
}
// ---------------------------------------------------- Store
implementation
/**
* Returns a Object from the store associated with the Key Object
*
* @param key the Key object
* @return the Object associated with Key Object
*/
protected Object doGet(Object key)
{
Object value = null;
value = m_JCS.get(key);
if (getLogger().isDebugEnabled())
{
if (value != null)
{
getLogger().debug("Found key: " + key);
}
else
{
getLogger().debug("NOT Found key: " + key);
}
}
return value;
}
/**
* Store the given object in the indexed data file.
*
* @param key the key object
* @param value the value object
* @exception IOException
*/
protected void doStore(Object key, Object value)
throws IOException
{
if (getLogger().isDebugEnabled())
{
getLogger().debug("store(): Store file with key: "
+ key.toString());
getLogger().debug("store(): Store file with value: "
+ value.toString());
}
//This test is not really pertinent here - we
//won't always be storing serializable objects (I don't think)
if (value instanceof Serializable)
{
try
{
m_JCS.put(key, value);
}
catch (CacheException ce)
{
getLogger().error("store(..): Exception", ce);
}
}
else
{
throw new IOException("Object not Serializable");
}
}
/**
* Frees some values of the data file.<br>
* TODO: implementation
*/
public void free()
{
// if we ever implement this, we should implement doFree()
}
/* (non-Javadoc)
* @see org.apache.excalibur.store.impl.AbstractReadWriteStore#doFree()
*/
protected void doFree() {
}
/**
* Clear the Store of all elements
*/
protected void doClear()
{
if (getLogger().isDebugEnabled())
{
getLogger().debug("clear(): Clearing the database ");
}
try
{
//No args - should remove all
//This is not well documented, although the source
//suggests that this will work
m_JCS.remove();
}
catch (CacheException ce)
{
getLogger().error("store(..): Exception", ce);
}
}
/**
* Removes a value from the data file with the given key.
*
* @param key the key object
*/
protected void doRemove(Object key)
{
if (getLogger().isDebugEnabled())
{
getLogger().debug("remove(..) Remove item");
}
try
{
m_JCS.remove(key);
}
//Need to revisit this exception - what happens
//if no match found for key - is an exception thrown?
catch (CacheException ce)
{
getLogger().error("remove(..): Exception", ce);
}
}
/**
* Test if the the index file contains the given key
*
* @param key the key object
* @return true if Key exists and false if not
*/
protected boolean doContainsKey(Object key)
{
//All we have available is a null check
if (m_JCS.get(key) != null) {
return true;
}
else {
return false;
}
}
/**
* Returns an Enumeration of all Keys in the cache.<br>
* this is a bit of a hack - I don't believe that the group
* needs to be passed in as a string in this way - we should
* be able to retreive it.
* FIX ME!!
*
* @return Enumeration Object with all existing keys
*/
protected Enumeration doGetKeys()
{
return new org.apache.commons.collections.iterators.IteratorEnumeration(
this.m_JCS.getGroupKeys(this.m_group).iterator()
);
}
protected int doGetSize()
{
return m_JCS.getSize();
}
private static class JCSCacheAccess extends GroupCacheAccess {
private JCSCacheAccess(CompositeCache cacheControl) {
super(cacheControl);
}
private int getSize() {
return super.cacheControl.getSize();
}
}
}
1.1 cocoon-2.1/src/blocks/scratchpad/WEB-INF/cache.ccf
Index: cache.ccf
===================================================================
# Cache configuration for the 'TestDiskCache' test. The memory cache has a
# a maximum of 100 objects, so objects should get pushed into the disk cache
jcs.default=indexedDiskCache
jcs.default.cacheattributes=org.apache.jcs.engine.CompositeCacheAttributes
jcs.default.cacheattributes.MaxObjects=10
jcs.default.cacheattributes.MemoryCacheName=org.apache.jcs.engine.memory.lru.LRUMemoryCache
# SYSTEM GROUP ID CACHE
jcs.system.groupIdCache=indexedDiskCache
jcs.system.groupIdCache.cacheattributes=org.apache.jcs.engine.CompositeCacheAttributes
jcs.system.groupIdCache.cacheattributes.MaxObjects=10
jcs.system.groupIdCache.cacheattributes.MemoryCacheName=org.apache.jcs.engine.memory.lru.LRUMemoryCache
##### CACHE REGIONS FOR TEST
jcs.region.indexedRegion1=indexedDiskCache
jcs.region.indexedRegion1.cacheattributes=org.apache.jcs.engine.CompositeCacheAttributes
jcs.region.indexedRegion1.cacheattributes.MaxObjects=1000
jcs.region.indexedRegion1.cacheattributes.MemoryCacheName=org.apache.jcs.engine.memory.lru.LRUMemoryCache
jcs.region.indexedRegion2=indexedDiskCache
jcs.region.indexedRegion2.cacheattributes=org.apache.jcs.engine.CompositeCacheAttributes
jcs.region.indexedRegion2.cacheattributes.MaxObjects=100
jcs.region.indexedRegion2.cacheattributes.MemoryCacheName=org.apache.jcs.engine.memory.lru.LRUMemoryCache
jcs.region.indexedRegion3=indexedDiskCache
jcs.region.indexedRegion3.cacheattributes=org.apache.jcs.engine.CompositeCacheAttributes
jcs.region.indexedRegion3.cacheattributes.MaxObjects=100
jcs.region.indexedRegion3.cacheattributes.MemoryCacheName=org.apache.jcs.engine.memory.lru.LRUMemoryCache
jcs.region.indexedRegion4=indexedDiskCache2
jcs.region.indexedRegion4.cacheattributes=org.apache.jcs.engine.CompositeCacheAttributes
jcs.region.indexedRegion4.cacheattributes.MaxObjects=100
jcs.region.indexedRegion4.cacheattributes.MemoryCacheName=org.apache.jcs.engine.memory.lru.LRUMemoryCache
##### AUXILIARY CACHES
# Indexed Disk Cache
jcs.auxiliary.indexedDiskCache=org.apache.jcs.auxiliary.disk.indexed.IndexedDiskCacheFactory
jcs.auxiliary.indexedDiskCache.attributes=org.apache.jcs.auxiliary.disk.indexed.IndexedDiskCacheAttributes
jcs.auxiliary.indexedDiskCache.attributes.DiskPath=/www/cocoon/webapps/cocoon/indexed-disk-cache
# Indexed Disk Cache
jcs.auxiliary.indexedDiskCache2=org.apache.jcs.auxiliary.disk.indexed.IndexedDiskCacheFactory
jcs.auxiliary.indexedDiskCache2.attributes=org.apache.jcs.auxiliary.disk.indexed.IndexedDiskCacheAttributes
jcs.auxiliary.indexedDiskCache2.attributes.DiskPath=build/test-sandbox/indexed-disk-cache2
