unico 2003/10/28 07:01:01
Modified:
src/blocks/repository/java/org/apache/cocoon/components/source/impl
AbstractConfigurableSourceDescriptor.java
AbstractConfigurableSourceInspector.java
. gump.xml
Added:
src/blocks/repository/java/org/apache/cocoon/components/source/impl
SimpleJdbcSourceDescriptor.java
Log:
simple source descriptor using jdbc to store source properties
this addition also adds two dependencies to the repository block:
on databases block and eventcache block
Revision Changes Path
1.3 +1 -1
cocoon-2.1/src/blocks/repository/java/org/apache/cocoon/components/source/impl/AbstractConfigurableSourceDescriptor.java
Index: AbstractConfigurableSourceDescriptor.java
===================================================================
RCS file:
/home/cvs/cocoon-2.1/src/blocks/repository/java/org/apache/cocoon/components/source/impl/AbstractConfigurableSourceDescriptor.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- AbstractConfigurableSourceDescriptor.java 27 Oct 2003 17:36:18 -0000
1.2
+++ AbstractConfigurableSourceDescriptor.java 28 Oct 2003 15:01:00 -0000
1.3
@@ -92,5 +92,5 @@
protected abstract void doSetSourceProperty(Source source,
SourceProperty property)
throws SourceException;
-
+
}
1.3 +3 -0
cocoon-2.1/src/blocks/repository/java/org/apache/cocoon/components/source/impl/AbstractConfigurableSourceInspector.java
Index: AbstractConfigurableSourceInspector.java
===================================================================
RCS file:
/home/cvs/cocoon-2.1/src/blocks/repository/java/org/apache/cocoon/components/source/impl/AbstractConfigurableSourceInspector.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- AbstractConfigurableSourceInspector.java 27 Oct 2003 17:36:18 -0000
1.2
+++ AbstractConfigurableSourceInspector.java 28 Oct 2003 15:01:00 -0000
1.3
@@ -130,4 +130,7 @@
protected abstract SourceProperty doGetSourceProperty(Source source,
String ns, String name)
throws SourceException;
+ protected final Set getPropertyTypes() {
+ return m_properties;
+ }
}
1.1
cocoon-2.1/src/blocks/repository/java/org/apache/cocoon/components/source/impl/SimpleJdbcSourceDescriptor.java
Index: SimpleJdbcSourceDescriptor.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
[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.source.impl;
import java.sql.Connection;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import org.apache.avalon.excalibur.datasource.DataSourceComponent;
import org.apache.avalon.framework.activity.Disposable;
import org.apache.avalon.framework.activity.Initializable;
import org.apache.avalon.framework.component.ComponentException;
import org.apache.avalon.framework.component.ComponentManager;
import org.apache.avalon.framework.component.ComponentSelector;
import org.apache.avalon.framework.component.Composable;
import org.apache.avalon.framework.configuration.Configurable;
import org.apache.avalon.framework.configuration.Configuration;
import org.apache.avalon.framework.configuration.ConfigurationException;
import org.apache.avalon.framework.thread.ThreadSafe;
import org.apache.cocoon.caching.Cache;
import org.apache.cocoon.caching.EventAware;
import org.apache.cocoon.caching.validity.EventValidity;
import org.apache.cocoon.caching.validity.NameValueEvent;
import org.apache.cocoon.components.source.SourceDescriptor;
import org.apache.cocoon.components.source.helpers.SourceProperty;
import org.apache.excalibur.source.Source;
import org.apache.excalibur.source.SourceException;
import org.apache.excalibur.source.SourceResolver;
import org.apache.excalibur.source.SourceValidity;
/**
* Simple SourceDescriptor implementation that can stores
* properties over JDBC.
*
* <p>
* The descriptor is to be configured with the name of a datasource that
* contains a table with the following scheme:
* <p>
* <code>
* CREATE TABLE SOURCEPROPS(<br>
* SOURCE VARCHAR NOT NULL,<br>
* NAMESPACE VARCHAR NOT NULL,<br>
* NAME VARCHAR NOT NULL,<br>
* VALUE VARCHAR NOT NULL,<br>
* CONSTRAINT SYS_CT_11 UNIQUE(SOURCE,NAMESPACE,NAME))<br>
* </code>
* </p>
* </p>
* <p>
* The implementation will attempt to connect to the EventAware cache in
* order to notify it during changes. If it can't find the EventAware cache
* sources that are described by this SourceDescriptor will NOT be cacheable.
* </p>
*
* @author <a href="mailto:[EMAIL PROTECTED]">Unico Hommes</a>
*/
public class SimpleJdbcSourceDescriptor
extends AbstractConfigurableSourceDescriptor
implements SourceDescriptor, Composable, Configurable, Initializable,
Disposable, ThreadSafe {
private static final String STMT_SELECT_SINGLE =
"SELECT value FROM sourceprops WHERE source=? AND namespace=? AND
name=?;";
private static final String STMT_SELECT_ALL =
"SELECT namespace, name, value FROM sourceprops WHERE source=?;";
private static final String STMT_INSERT =
"INSERT INTO sourceprops (source,namespace,name,value) VALUES
(?,?,?,?);";
private static final String STMT_DELETE =
"DELETE FROM sourceprops WHERE source=? AND namespace=? AND name=?;";
private ComponentManager m_manager;
private SourceResolver m_resolver;
private EventAware m_cache;
private DataSourceComponent m_datasource;
private String m_datasourceName;
private String m_eventName;
// ---------------------------------------------------- Lifecycle
public SimpleJdbcSourceDescriptor() {
}
public void compose(ComponentManager manager) throws ComponentException {
m_manager = manager;
m_resolver = (SourceResolver) manager.lookup(SourceResolver.ROLE);
Cache cache = (Cache) manager.lookup(Cache.ROLE + "/EventAware");
if (cache instanceof EventAware) {
m_cache = (EventAware) cache;
} else {
getLogger().warn("EventAware cache was not found: sources won't
be cacheable.");
}
}
/**
* Configuration options:
*
* <ul>
* <li>element <code>property</code> (multiple,required)
* - define a property that this store should handle.</li>
* <li>element <code>datasource</code> (single,required)
* - the name of the excalibur datasource to use.</li>
* </ul>
*/
public void configure(final Configuration configuration) throws
ConfigurationException {
super.configure(configuration);
m_datasourceName =
configuration.getChild("datasource",true).getValue("cocoondb");
if (m_cache != null) {
m_eventName = "simple-jdbc:";
Iterator types = getPropertyTypes().iterator();
while (types.hasNext()) {
m_eventName += "/" + types.next();
}
}
}
public void initialize() throws Exception {
ComponentSelector datasources = (ComponentSelector) m_manager.lookup(
DataSourceComponent.ROLE + "Selector");
m_datasource = (DataSourceComponent) datasources.select("cocoondb");
}
public void dispose() {
}
// ---------------------------------------------------- SourceInspection
public SourceProperty[] getSourceProperties(Source source)
throws SourceException {
Connection connection = null;
PreparedStatement stmt = null;
try {
connection = m_datasource.getConnection();
stmt = connection.prepareStatement(STMT_SELECT_ALL);
stmt.setString(1,source.getURI());
ResultSet result = stmt.executeQuery();
List properties = new ArrayList();
while (result.next()) {
SourceProperty property = new SourceProperty(
result.getString(1),result.getString(2),result.getString(3));
if
(handlesProperty(property.getNamespace(),property.getName())) {
properties.add(property);
}
}
result.close();
stmt.close();
return (SourceProperty[]) properties.toArray(
new SourceProperty[properties.size()]);
}
catch (SQLException e) {
throw new SourceException("Error retrieving properties from
database",e);
}
finally {
if (connection != null) {
try {
connection.close();
}
catch (SQLException e) {}
}
}
}
public SourceProperty doGetSourceProperty(
Source source,
String namespace,
String name)
throws SourceException {
Connection connection = null;
PreparedStatement stmt = null;
try {
connection = m_datasource.getConnection();
stmt = connection.prepareStatement(STMT_SELECT_SINGLE);
stmt.setString(1,source.getURI());
stmt.setString(2,namespace);
stmt.setString(3,name);
ResultSet result = stmt.executeQuery();
SourceProperty property = null;
if (result.next()) {
property = new SourceProperty(
namespace,
name,
result.getString(1));
}
result.close();
stmt.close();
return property;
}
catch (SQLException e) {
throw new SourceException("Error retrieving property from
database",e);
}
finally {
if (connection != null) {
try {
connection.close();
}
catch (SQLException e) {}
}
}
}
public void doSetSourceProperty(Source source, SourceProperty property)
throws SourceException {
Connection connection = null;
PreparedStatement stmt = null;
try {
connection = m_datasource.getConnection();
stmt = connection.prepareStatement(STMT_DELETE);
stmt.setString(1,source.getURI());
stmt.setString(2,property.getNamespace());
stmt.setString(3,property.getName());
int count = stmt.executeUpdate();
stmt.close();
stmt = connection.prepareStatement(STMT_INSERT);
stmt.setString(1,source.getURI());
stmt.setString(2,property.getNamespace());
stmt.setString(3,property.getName());
stmt.setString(4,property.getValueAsString());
count += stmt.executeUpdate();
stmt.close();
connection.commit();
if (m_cache != null && count > 0) {
m_cache.processEvent(new
NameValueEvent(m_eventName,source.getURI()));
}
}
catch (SQLException e) {
throw new SourceException("Error setting property",e);
}
finally {
if (connection != null) {
try {
connection.close();
} catch (SQLException e) {
}
}
}
}
public void doRemoveSourceProperty(
Source source,
String namespace,
String name)
throws SourceException {
Connection connection = null;
PreparedStatement stmt = null;
try {
connection = m_datasource.getConnection();
stmt = connection.prepareStatement(STMT_DELETE);
stmt.setString(1,source.getURI());
stmt.setString(2,namespace);
stmt.setString(3,name);
int count = stmt.executeUpdate();
stmt.close();
connection.commit();
if (m_cache != null && count > 0) {
m_cache.processEvent(new
NameValueEvent(m_eventName,source.getURI()));
}
}
catch (SQLException e) {
throw new SourceException("Error removing propery",e);
}
finally {
if (connection != null) {
try {
connection.close();
} catch (SQLException e) {
}
}
}
}
public SourceValidity getValidity(Source source) {
if (m_cache != null) {
return new EventValidity(new
NameValueEvent(m_eventName,source.getURI()));
}
return null;
}
}
1.95 +3 -1 cocoon-2.1/gump.xml
Index: gump.xml
===================================================================
RCS file: /home/cvs/cocoon-2.1/gump.xml,v
retrieving revision 1.94
retrieving revision 1.95
diff -u -r1.94 -r1.95
--- gump.xml 22 Oct 2003 21:11:19 -0000 1.94
+++ gump.xml 28 Oct 2003 15:01:00 -0000 1.95
@@ -1075,6 +1075,8 @@
</ant>
<depend project="cocoon" inherit="all"/>
+ <depend project="cocoon-block-databases" />
+ <depend project="cocoon-block-eventcache" />
<work nested="tools/anttasks"/>
<home nested="build/cocoon-@@DATE@@"/>
