You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@turbine.apache.org by ep...@apache.org on 2003/11/19 12:19:37 UTC
cvs commit: jakarta-turbine-fulcrum/dvsl/impl/src/java/org/apache/fulcrum/dvsl DefaultDvslService.java
epugh 2003/11/19 03:19:37
Added: dvsl/api/src/java/org/apache/fulcrum/dvsl DvslService.java
dvsl/impl/src/test/org/apache/fulcrum/dvsl
DvslBasicTest.java
dvsl/api .cvsignore project.xml
dvsl/impl/conf block.xml config.xml
dvsl/xdocs changes.xml
dvsl/impl maven.xml .cvsignore project.xml
dvsl/impl/src/java/org/apache/fulcrum/dvsl
DefaultDvslService.java
Removed: dvsl project.properties .cvsignore LICENSE.txt
project.xml
dvsl/src/test TestComponentConfig.xml TestRoleConfig.xml
dvsl/src/test/org/apache/fulcrum/dvsl DvslBasicTest.java
dvsl/src/java/org/apache/fulcrum/dvsl
DefaultDvslService.java DvslService.java
Log:
Merlinize the DVSL component.
Revision Changes Path
1.1 jakarta-turbine-fulcrum/dvsl/api/src/java/org/apache/fulcrum/dvsl/DvslService.java
Index: DvslService.java
===================================================================
package org.apache.fulcrum.dvsl;
/* ====================================================================
* The Apache Software License, Version 1.1
*
* Copyright (c) 2001 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, 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" and "Apache Software Foundation" and
* "Apache Turbine" 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",
* "Apache Turbine", 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 (INCLUDING, 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. For more
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*/
import java.io.Reader;
import java.io.Writer;
import java.util.Properties;
/**
* The Fulcrum DVSL Service is used to transform XML with a DVSL stylesheet.
* The service makes use of the DVSL engine available from the
* Jakarta Velocity project.
*
* @author <a href="mailto:geirm@apache.org">Geir Magnusson Jr.</a>
* @author <a href="mailto:mcconnell@apache.org">Stephen McConnell</a>
*/
public interface DvslService
{
/** Avalon role - used to id the component within the manager */
String ROLE = DvslService.class.getName();
/**
* Registers a stylesheet by name
*/
public void register( String styleName, Reader stylesheet, Properties toolbox)
throws Exception;
/**
* Unregisters a stylesheet by name
*/
public void unregister( String styleName )
throws Exception;
/**
* Uses an stylesheet to transform xml input from a reader and writes the
* output to a writer.
*
* @param stylename Name of a pre-registered stylesheet
* @param in The reader that passes the xml to be transformed
* @param out The writer for the transformed output
*/
public void transform ( String styleName, Reader in, Writer out)
throws Exception;
}
1.1 jakarta-turbine-fulcrum/dvsl/impl/src/test/org/apache/fulcrum/dvsl/DvslBasicTest.java
Index: DvslBasicTest.java
===================================================================
package org.apache.fulcrum.dvsl;
/* ====================================================================
* The Apache Software License, Version 1.1
*
* Copyright (c) 2001-2002 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, 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" and "Apache Software Foundation" and
* "Apache Turbine" 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",
* "Apache Turbine", 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 (INCLUDING, 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. For more
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*/
import java.io.StringReader;
import java.io.StringWriter;
import org.apache.avalon.merlin.unit.AbstractMerlinTestCase;
/**
* @author <a href="mailto:mcconnell@apache.org">Stephen McConnell</a>
*/
public class DvslBasicTest extends AbstractMerlinTestCase
{
private String dvsl = "#match(\"element\")Hello from element! $node.value()#end";
private String input = "<?xml version=\"1.0\"?><document><element>Foo</element></document>";
private DvslService dvslService = null;
public DvslBasicTest(String name)
{
super(
MAVEN_TARGET_CLASSES_DIR,
MERLIN_DEFAULT_CONFIG_FILE,
MERLIN_INFO_OFF,
MERLIN_DEBUG_OFF,
name );
}
public void setUp() throws Exception
{
super.setUp();
try
{
dvslService = (DvslService) this.resolve( "dvsl" );
}
catch (Throwable e)
{
getLogger().error( "Setup failure.", e );
fail(e.getMessage());
}
}
public void testSelection() throws Exception
{
/*
* register the stylesheet
*/
dvslService.register("style", new StringReader(dvsl), null);
/*
* render the document
*/
StringWriter sw = new StringWriter();
dvslService.transform("style", new StringReader(input), sw);
assertEquals("Hello from element! Foo",sw.toString());
getLogger().info( "OK" );
}
}
1.1 jakarta-turbine-fulcrum/dvsl/api/.cvsignore
Index: .cvsignore
===================================================================
target
maven.log
*.log
1.1 jakarta-turbine-fulcrum/dvsl/api/project.xml
Index: project.xml
===================================================================
<?xml version="1.0"?>
<project>
<extend>${basedir}/../../merlin-project.xml</extend>
<id>fulcrum-dvsl-api</id>
<name>Fulcrum DVSL API</name>
<currentVersion>1.0-alpha-4</currentVersion>
<package>org.apache.fulcrum.dvsl</package>
</project>
1.1 jakarta-turbine-fulcrum/dvsl/impl/conf/block.xml
Index: block.xml
===================================================================
<container name="test">
<classloader>
<classpath>
<repository>
<resource id="fulcrum:fulcrum-dvsl-api" version="1.0-alpha-3"/>
</repository>
</classpath>
</classloader>
<component name="dvsl"
class="org.apache.fulcrum.dvsl.DefaultDvslService"/>
</container>
1.1 jakarta-turbine-fulcrum/dvsl/impl/conf/config.xml
Index: config.xml
===================================================================
<targets>
<target path="/test/dvsl">
<categories priority="INFO"/>
</target>
</targets>
1.1 jakarta-turbine-fulcrum/dvsl/xdocs/changes.xml
Index: changes.xml
===================================================================
<?xml version="1.0"?>
<document>
<properties>
<title>Fulcrum DVSL</title>
<author email="epugh@upstate.com">Eric Pugh</author>
</properties>
<body>
<release version="1.0-alpha-4" date="">
<action dev="epugh" type="update">
Merlinized component
</action>
</release>
</body>
</document>
1.1 jakarta-turbine-fulcrum/dvsl/impl/maven.xml
Index: maven.xml
===================================================================
<project default="jar:jar" xmlns:maven="jelly:maven" xmlns:j="jelly:core" xmlns:util="jelly:util">
<preGoal name="java:compile">
<attainGoal name="avalon:meta"/>
</preGoal>
</project>
1.1 jakarta-turbine-fulcrum/dvsl/impl/.cvsignore
Index: .cvsignore
===================================================================
target
*.log
.classpath
.project
jcoverage.ser
1.1 jakarta-turbine-fulcrum/dvsl/impl/project.xml
Index: project.xml
===================================================================
<?xml version="1.0"?>
<project>
<id>fulcrum-crypto-impl</id>
<extend>${basedir}/../../merlin-project.xml</extend>
<name>Fulcrum DVSL Implementation</name>
<currentVersion>1.0-alpha-4</currentVersion>
<package>org.apache.fulcrum.dvsl</package>
<dependencies>
<dependency>
<groupId>fulcrum</groupId>
<artifactId>fulcrum-dvsl-api</artifactId>
<version>1.0-alpha-4</version>
</dependency>
<dependency>
<groupId>avalon-framework</groupId>
<artifactId>avalon-framework-api</artifactId>
<version>4.1.5</version>
</dependency>
<dependency>
<id>velocity-dvsl</id>
<version>0.45</version>
</dependency>
<dependency>
<id>dom4j</id>
<version>1.4</version>
</dependency>
<dependency>
<groupId>velocity</groupId>
<artifactId>velocity</artifactId>
<version>1.4-dev</version>
</dependency>
<dependency>
<id>commons-collections</id>
<version>2.1</version>
<url>http://jakarta.apache.org/commons/collections.html</url>
</dependency>
<dependency>
<id>logkit</id>
<version>1.0.1</version>
<url>http://avalon.apache.org/logkit/</url>
</dependency>
<!-- testing -->
<dependency>
<groupId>merlin</groupId>
<artifactId>merlin-unit</artifactId>
<version>3.2.2-dev</version>
</dependency>
</dependencies>
</project>
1.1 jakarta-turbine-fulcrum/dvsl/impl/src/java/org/apache/fulcrum/dvsl/DefaultDvslService.java
Index: DefaultDvslService.java
===================================================================
package org.apache.fulcrum.dvsl;
/* ====================================================================
* The Apache Software License, Version 1.1
*
* Copyright (c) 2001 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, 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" and "Apache Software Foundation" and
* "Apache Turbine" 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",
* "Apache Turbine", 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 (INCLUDING, 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. For more
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*/
import java.io.Reader;
import java.io.Writer;
import java.util.HashMap;
import java.util.Map;
import java.util.Properties;
import org.apache.tools.dvsl.DVSL;
import org.apache.avalon.framework.activity.Initializable;
import org.apache.avalon.framework.logger.AbstractLogEnabled;
/**
* Implementation of the Fulcrum Dvsl Service. It transforms xml with a given
* dvsl file.
*
* @author <a href="mailto:geirm@apache.org">Geir Magnusson Jr.</a>
* @author <a href="mailto:mcconnell@apache.org">Stephen McConnell</a>
* @avalon.component name="dvsl" lifestyle="singleton"
* @avalon.service type="org.apache.fulcrum.dvsl.DvslService"
*/
public class DefaultDvslService
extends AbstractLogEnabled
implements DvslService, Initializable
{
protected Map servicePool = new HashMap();
/**
* register a stylesheet
*/
public void register( String styleName, Reader stylesheet, Properties toolbox )
throws Exception
{
DVSL dvsl = new DVSL();
if ( stylesheet != null)
{
dvsl.setStylesheet( stylesheet );
}
else
{
throw new Exception("Null stylesheet Reader");
}
if( toolbox != null)
{
dvsl.setToolbox( toolbox );
}
servicePool.put( styleName, dvsl );
}
/**
* unregister a stylesheet and release resources
*/
public void unregister( String styleName )
{
servicePool.remove( styleName );
}
/**
* Execute an DVSLT
*/
public void transform ( String styleName, Reader in, Writer out)
throws Exception
{
DVSL dvsl = (DVSL) servicePool.get( styleName );
dvsl.transform( in, out );
}
// ---------------- Avalon Lifecycle Methods ---------------------
/**
* Avalon component lifecycle method
*/
public void initialize()
{
}
}
---------------------------------------------------------------------
To unsubscribe, e-mail: turbine-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: turbine-dev-help@jakarta.apache.org