You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@cocoon.apache.org by st...@apache.org on 2003/02/20 21:27:17 UTC
cvs commit: xml-cocoon2/src/deprecated/java/org/apache/cocoon/components/store JispFilesystemStore.java JispStringKey.java
stefano 2003/02/20 12:27:17
Added: src/deprecated/java/org/apache/cocoon/components/store
JispFilesystemStore.java JispStringKey.java
Log:
moved to deprecated since we should be using excalibur's
Revision Changes Path
1.1 xml-cocoon2/src/deprecated/java/org/apache/cocoon/components/store/JispFilesystemStore.java
Index: JispFilesystemStore.java
===================================================================
/*
============================================================================
The Apache Software License, Version 1.1
============================================================================
Copyright (C) 1999-2003 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
apache@apache.org.
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 <st...@apache.org>. For more information on the Apache
Software Foundation, please see <http://www.apache.org/>.
*/
package org.apache.cocoon.components.store;
import com.coyotegulch.jisp.BTreeIndex;
import com.coyotegulch.jisp.BTreeObjectIterator;
import com.coyotegulch.jisp.IndexedObjectDatabase;
import com.coyotegulch.jisp.KeyNotFound;
import com.coyotegulch.jisp.KeyObject;
import org.apache.avalon.framework.activity.Initializable;
import org.apache.avalon.framework.context.Context;
import org.apache.avalon.framework.context.ContextException;
import org.apache.avalon.framework.context.Contextualizable;
import org.apache.avalon.framework.logger.AbstractLogEnabled;
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.thread.ThreadSafe;
import org.apache.cocoon.Constants;
import org.apache.cocoon.util.IOUtils;
import java.io.File;
import java.io.IOException;
import java.io.Serializable;
import java.util.Enumeration;
/**
* This store is based on the Jisp library
* (http://www.coyotegulch.com/jisp/index.html). This store uses B-Tree indexes
* to access variable-length serialized data stored in files.
*
* @author <a href="mailto:g-froehlich@gmx.de">Gerhard Froehlich</a>
* @author <a href="mailto:vgritsenko@apache.org">Vadim Gritsenko</a>
* @version CVS $Id: JispFilesystemStore.java,v 1.1 2003/02/20 20:27:16 stefano Exp $
*/
public final class JispFilesystemStore extends AbstractLogEnabled
implements org.apache.excalibur.store.Store,
Contextualizable,
ThreadSafe,
Initializable,
Parameterizable {
protected File m_workDir;
protected File m_cacheDir;
/**
* The directory repository
*/
protected File m_directoryFile;
protected volatile String m_directoryPath;
/**
* The database
*/
private File m_databaseFile;
private File m_indexFile;
private int m_Order;
private IndexedObjectDatabase m_Database;
private BTreeIndex m_Index;
/**
* Sets the repository's location
*
* @param directory the new directory value
* @exception IOException
*/
public void setDirectory(final String directory)
throws IOException {
this.setDirectory(new File(directory));
}
/**
* Sets the repository's location
*
* @param directory the new directory value
* @exception IOException
*/
public void setDirectory(final File directory)
throws IOException {
this.m_directoryFile = directory;
/* Save directory path prefix */
this.m_directoryPath = IOUtils.getFullFilename(this.m_directoryFile);
this.m_directoryPath += File.separator;
if (!this.m_directoryFile.exists()) {
/* Create it new */
if (!this.m_directoryFile.mkdir()) {
throw new IOException("Error creating store directory '" +
this.m_directoryPath + "'");
}
}
/* Is given file actually a directory? */
if (!this.m_directoryFile.isDirectory()) {
throw new IOException("'" + this.m_directoryPath + "' is not a directory");
}
/* Is directory readable and writable? */
if (!(this.m_directoryFile.canRead() && this.m_directoryFile.canWrite())) {
throw new IOException("Directory '" + this.m_directoryPath +
"' is not readable/writable");
}
}
/**
* Contextualize the Component
*
* @param context the Context of the Application
* @exception ContextException
*/
public void contextualize(final Context context) throws ContextException {
this.m_workDir = (File)context.get(Constants.CONTEXT_WORK_DIR);
this.m_cacheDir = (File)context.get(Constants.CONTEXT_CACHE_DIR);
}
/**
* Configure the Component.<br>
* A few options can be used
* <UL>
* <LI> datafile = the name of the data file (Default: cocoon.dat)
* </LI>
* <LI> m_indexFile = the name of the index file (Default: cocoon.idx)
* </LI>
* <LI> order = The page size of the B-Tree</LI>
* </UL>
*
* @param params the configuration paramters
* @exception ParameterException
*/
public void parameterize(Parameters params) throws ParameterException {
try {
if (params.getParameterAsBoolean("use-cache-directory", false)) {
if (getLogger().isDebugEnabled()) {
getLogger().debug("Using cache directory: " + m_cacheDir);
}
setDirectory(m_cacheDir);
} else if (params.getParameterAsBoolean("use-work-directory", false)) {
if (getLogger().isDebugEnabled()) {
getLogger().debug("Using work directory: " + m_workDir);
}
setDirectory(m_workDir);
} else if (params.getParameter("directory", null) != null) {
String dir = params.getParameter("directory");
dir = IOUtils.getContextFilePath(m_workDir.getPath(), dir);
if (getLogger().isDebugEnabled()) {
getLogger().debug("Using directory: " + dir);
}
setDirectory(new File(dir));
} else {
try {
// Default
setDirectory(m_workDir);
} catch (IOException e) {
// Ignored
}
}
} catch (IOException e) {
throw new ParameterException("Unable to set directory", e);
}
String databaseName = params.getParameter("datafile", "cocoon.dat");
String indexName = params.getParameter("m_indexFile", "cocoon.idx");
m_Order = params.getParameterAsInteger("order", 301);
if (getLogger().isDebugEnabled()) {
getLogger().debug("Database file name = " + databaseName);
getLogger().debug("Index file name = " + indexName);
getLogger().debug("Order=" + m_Order);
}
m_databaseFile = new File(m_directoryFile, databaseName);
m_indexFile = new File(m_directoryFile, indexName);
}
/**
* Initialize the Component
*/
public void initialize() {
if (getLogger().isDebugEnabled()) {
getLogger().debug("initialize() JispFilesystemStore");
}
try {
if (m_databaseFile.exists()) {
if (getLogger().isDebugEnabled()) {
getLogger().debug("initialize(): Datafile exists");
}
m_Database = new IndexedObjectDatabase(m_databaseFile.toString(), false);
m_Index = new BTreeIndex(m_indexFile.toString());
m_Database.attachIndex(m_Index);
} else {
if (getLogger().isDebugEnabled()) {
getLogger().debug("initialize(): Datafile does not exist");
}
m_Database = new IndexedObjectDatabase(m_databaseFile.toString(), false);
m_Index = new BTreeIndex(m_indexFile.toString(),
m_Order, new JispStringKey(), false);
m_Database.attachIndex(m_Index);
}
} catch (KeyNotFound ignore) {
} catch (Exception e) {
getLogger().error("initialize(..) Exception", e);
}
}
/**
* Returns the repository's full pathname
*
* @return the directory as String
*/
public String getDirectoryPath() {
return this.m_directoryPath;
}
/**
* Returns a Object from the store associated with the Key Object
*
* @param key the Key object
* @return the Object associated with Key Object
*/
public synchronized Object get(Object key) {
Object value = null;
try {
value = m_Database.read(wrapKeyObject(key), m_Index);
if (getLogger().isDebugEnabled()) {
if (value != null) {
if (getLogger().isDebugEnabled()) {
getLogger().debug("Found key: " + key);
}
} else {
if (getLogger().isDebugEnabled()) {
getLogger().debug("NOT Found key: " + key);
}
}
}
} catch (Exception e) {
getLogger().error("get(..): Exception", e);
}
return value;
}
/**
* Store the given object in the indexed data file.
*
* @param key the key object
* @param value the value object
* @exception IOException
*/
public synchronized void store(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());
}
if (value instanceof Serializable) {
try {
KeyObject[] keyArray = new KeyObject[1];
keyArray[0] = wrapKeyObject(key);
m_Database.write(keyArray, (Serializable) value);
} catch (Exception e) {
getLogger().error("store(..): Exception", e);
}
} else {
throw new IOException("Object not Serializable");
}
}
/**
* Holds the given object in the indexed data file.
*
* @param key the key object
* @param value the value object
* @exception IOException
*/
public synchronized void hold(Object key, Object value)
throws IOException {
this.store(key, value);
}
/**
* Frees some values of the data file.<br>
* TODO: implementation
*/
public synchronized void free() {
//TODO: implementation
}
/**
* Clear the Store of all elements
*/
public synchronized void clear() {
BTreeObjectEnumeration enum = new BTreeObjectEnumeration(m_Database.createIterator(m_Index),this);
if (getLogger().isDebugEnabled()) {
getLogger().debug("clear(): Clearing the database ");
}
while(enum.hasMoreElements()) {
Object tmp = enum.nextElement();
if (getLogger().isDebugEnabled()) {
getLogger().debug("clear(): Removing key: " + tmp.toString());
}
this.remove(tmp);
}
}
/**
* Removes a value from the data file with the given key.
*
* @param key the key object
*/
public synchronized void remove(Object key) {
if (getLogger().isDebugEnabled()) {
getLogger().debug("remove(..) Remove item");
}
try {
KeyObject[] keyArray = new KeyObject[1];
keyArray[0] = wrapKeyObject(key);
m_Database.remove(keyArray);
} catch (KeyNotFound ignore) {
} catch (Exception e) {
getLogger().error("remove(..): Exception", e);
}
}
/**
* Test if the the index file contains the given key
*
* @param key the key object
* @return true if Key exists and false if not
*/
public synchronized boolean containsKey(Object key) {
long res = -1;
try {
res = m_Index.findKey(wrapKeyObject(key));
if (getLogger().isDebugEnabled()) {
getLogger().debug("containsKey(..): res=" + res);
}
} catch (KeyNotFound ignore) {
} catch (Exception e) {
getLogger().error("containsKey(..): Exception", e);
}
if (res > 0) {
return true;
} else {
return false;
}
}
/**
* Returns a Enumeration of all Keys in the indexed file.<br>
*
* @return Enumeration Object with all existing keys
*/
public Enumeration keys() {
BTreeObjectEnumeration enum = new BTreeObjectEnumeration(m_Database.createIterator(m_Index),this);
return enum;
}
public int size() {
int cnt = 0;
BTreeObjectEnumeration enum = new BTreeObjectEnumeration(m_Database.createIterator(m_Index),this);
while(enum.hasMoreElements()) {
cnt++;
}
return cnt;
}
/**
* This method wraps around the key Object a Jisp KeyObject.
*
* @param key the key object
* @return the wrapped key object
*/
private KeyObject wrapKeyObject(Object key) {
// TODO: Implementation of Integer and Long keys
return new JispStringKey(String.valueOf(key));
}
class BTreeObjectEnumeration implements Enumeration {
private BTreeObjectIterator m_Iterator;
private JispFilesystemStore m_Store;
public BTreeObjectEnumeration(BTreeObjectIterator iterator, JispFilesystemStore store) {
m_Iterator = iterator;
m_Store = store;
}
public boolean hasMoreElements() {
boolean hasMore = false;
Object tmp = null;
try {
tmp = m_Iterator.getKey();
if(m_Iterator.moveNext()) {
hasMore = true;
}
/* resets iterator to the old state **/
m_Iterator.moveTo((KeyObject)tmp);
} catch (IOException ioe) {
m_Store.getLogger().error("store(..): Exception", ioe);
} catch (ClassNotFoundException cnfe) {
m_Store.getLogger().error("store(..): Exception", cnfe);
}
return hasMore;
}
public Object nextElement() {
Object tmp = null;
try {
tmp = m_Iterator.getKey();
m_Iterator.moveNext();
} catch (IOException ioe) {
m_Store.getLogger().error("store(..): Exception", ioe);
} catch (ClassNotFoundException cnfe) {
m_Store.getLogger().error("store(..): Exception", cnfe);
}
// make a string out of it (JispStringKey is not usefull here)
return tmp.toString();
}
}
}
1.1 xml-cocoon2/src/deprecated/java/org/apache/cocoon/components/store/JispStringKey.java
Index: JispStringKey.java
===================================================================
/*
============================================================================
The Apache Software License, Version 1.1
============================================================================
Copyright (C) 1999-2003 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
apache@apache.org.
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 <st...@apache.org>. For more information on the Apache
Software Foundation, please see <http://www.apache.org/>.
*/
package org.apache.cocoon.components.store;
import com.coyotegulch.jisp.KeyObject;
import java.io.IOException;
import java.io.ObjectInput;
import java.io.ObjectOutput;
/**
* Wrapper class for String Keys to be compatible with the
* Jisp KeyObject.
*
* @author <a href="mailto:g-froehlich@gmx.de">Gerhard Froehlich</a>
* @version CVS $Id: JispStringKey.java,v 1.1 2003/02/20 20:27:16 stefano Exp $
*/
final class JispStringKey extends KeyObject {
final static long serialVersionUID = -6894793231339165076L;
private String mKey;
/**
* Constructor for the JispStringKey object
*/
public JispStringKey() {
mKey = new String("");
}
/**
* Constructor for the JispStringKey object
*
* @param keyValue the Value of the Key as String
*/
public JispStringKey(String keyValue) {
mKey = keyValue;
}
/**
* Compares two String Keys
*
* @param key the KeyObject to be compared
* @return 0 if equal, 1 if greater, -1 if less
*/
public int compareTo(KeyObject key) {
if (key instanceof JispStringKey) {
int comp = mKey.trim().compareTo(((JispStringKey) key).mKey.trim());
if (comp == 0) {
return KEY_EQUAL;
} else {
if (comp < 0) {
return KEY_LESS;
} else {
return KEY_MORE;
}
}
} else {
return KEY_ERROR;
}
}
/**
* Composes a null Kewy
*
* @return a null Key
*/
public KeyObject makeNullKey() {
return new JispStringKey();
}
/**
* The object implements the writeExternal method to save its contents
* by calling the methods of DataOutput for its primitive values or
* calling the writeObject method of ObjectOutput for objects, strings,
* and arrays.
*
* @param out the stream to write the object to
* @exception IOException
*/
public void writeExternal(ObjectOutput out)
throws IOException {
String outKey;
outKey = new String(mKey);
out.writeUTF(outKey);
}
/**
* The object implements the readExternal method to restore its contents
* by calling the methods of DataInput for primitive types and readObject
* for objects, strings and arrays. The readExternal method must read the
* values in the same sequence and with the same types as were written by writeExternal.
*
* @param in the stream to read data from in order to restore the object
* @exception IOException
* @exception ClassNotFoundException
*/
public void readExternal(ObjectInput in)
throws IOException, ClassNotFoundException {
mKey = in.readUTF();
}
/**
* Overrides the toString() method
*
* @return the Key as String
*/
public String toString() {
return mKey;
}
}
----------------------------------------------------------------------
In case of troubles, e-mail: webmaster@xml.apache.org
To unsubscribe, e-mail: cocoon-cvs-unsubscribe@xml.apache.org
For additional commands, e-mail: cocoon-cvs-help@xml.apache.org
Re: cvs commit: xml-cocoon2/src/deprecated/java/org/apache/cocoon/components/store
JispFilesystemStore.java JispStringKey.java
Posted by Vadim Gritsenko <va...@verizon.net>.
stefano@apache.org wrote:
> public void contextualize(final Context context) throws ContextException {
> this.m_workDir = (File)context.get(Constants.CONTEXT_WORK_DIR);
> this.m_cacheDir = (File)context.get(Constants.CONTEXT_CACHE_DIR);
> }
>
IIRC, because of this dependency on Cocoon's context, the decision was
taken to leave this store implementation inside Cocoon but implement
Avalon's store (as it does - implements
org.apache.excalibur.store.Store). Has been any changes since then; had
somebody implemented this store in Avalon?
Vadim
---------------------------------------------------------------------
To unsubscribe, e-mail: cocoon-dev-unsubscribe@xml.apache.org
For additional commands, email: cocoon-dev-help@xml.apache.org
Re: cvs commit: xml-cocoon2/src/deprecated/java/org/apache/cocoon/components/store
JispFilesystemStore.java JispStringKey.java
Posted by Vadim Gritsenko <va...@verizon.net>.
stefano@apache.org wrote:
> public void contextualize(final Context context) throws ContextException {
> this.m_workDir = (File)context.get(Constants.CONTEXT_WORK_DIR);
> this.m_cacheDir = (File)context.get(Constants.CONTEXT_CACHE_DIR);
> }
>
IIRC, because of this dependency on Cocoon's context, the decision was
taken to leave this store implementation inside Cocoon but implement
Avalon's store (as it does - implements
org.apache.excalibur.store.Store). Has been any changes since then; had
somebody implemented this store in Avalon?
Vadim
----------------------------------------------------------------------
In case of troubles, e-mail: webmaster@xml.apache.org
To unsubscribe, e-mail: cocoon-cvs-unsubscribe@xml.apache.org
For additional commands, e-mail: cocoon-cvs-help@xml.apache.org