Skip to main content

Using Jetty 6 to run a Cocoon block

This article explains how to set up maven jetty plugin 6 for rapid development of Cocoon applications (this part is based on the official tutorial about cocoon maven plugin). The article also describes an interesting pitfall reported here by Robby Pelssers.

Modify project pom file
In order to enable Jetty support you need to add the following plugins into your project pom file:
<!-- Prepares block resources and classes for Jetty plugin -->
<plugin>
  <groupId>org.apache.cocoon</groupId>
  <artifactId>cocoon-maven-plugin</artifactId>
  <version>1.0.0</version>
  <executions>
    <execution>
      <phase>compile</phase>
      <goals>
        <goal>prepare</goal>
      </goals>
      <configuration>
        <useConsoleAppender>true</useConsoleAppender>
      </configuration>
    </execution>
  </executions>
</plugin>

<!-- Runs current cocoon block as a webapp using ReloadingClassLoader -->
<plugin>
  <groupId>org.mortbay.jetty</groupId>
  <artifactId>maven-jetty-plugin</artifactId>
  <version>6.1.21</version>
  <configuration>
    <webAppSourceDirectory>${project.build.directory}/rcl/webapp</webAppSourceDirectory>
    <contextPath>/</contextPath>
    <systemProperties>
      <systemProperty>
        <name>org.apache.cocoon.mode</name>
        <value>dev</value>
      </systemProperty>
    </systemProperties>
  </configuration>
</plugin>
See the details in this cocoon tutorial. The only difference is that I updated plugins versions. It was not really necessary but I did it in attempt to solve the issue mentioned below. I wouldn't advise you to update maven-jetty-plugin to versions 6.1.22-6.1.26 as they cut stack traces in case of troubles that makes it much more difficult to understand issues. Moreover, version update may require adding a new dependency to your project, so don't do it if there is no real need (or add this dependency to the webapp block with provided scope to exclude it from the final build):
<dependency>
  <groupId>org.apache.cocoon</groupId>
  <artifactId>cocoon-block-deployment</artifactId>
  <version>1.2.1</version>
  <scope>runtime</scope>
</dependency>

Set up rcl.properties file
The idea and syntax are well described in this cocoon tutorial. It only lacks examples. Let's say we have two blocks: search and shared where search depends on shared. If we want to test search block being able to change resources in shared block, you should add shared classes to your rcl.properties:
org.lagivan.prototype.search.service%classes-dir=./target/classes

org.lagivan.prototype.shared.service%classes-dir=../shared/target/classes
%exclude-lib=org.lagivan.prototype:shared

Run jetty plugin
Running jetty from maven is really easy:
mvn jetty:run
The details can be found on the plugin documentation page.

Issue with ContextLoaderListener
Here I'm sharing my investigation results on the issue with the following stack trace:
2012-05-10 16:56:18.978::WARN:  Failed startup of context [email protected]{/,C:\workspace\search\target\rcl\webapp}
java.lang.RuntimeException: Cannot invoke listener [email protected]
 at org.apache.cocoon.tools.rcl.wrapper.servlet.ReloadingListener.invoke(ReloadingListener.java:190)
 at org.apache.cocoon.tools.rcl.wrapper.servlet.ReloadingListener.contextInitialized(ReloadingListener.java:213)
 at org.mortbay.jetty.handler.ContextHandler.startContext(ContextHandler.java:548)
Please check the following advices:
  • Check any "Caused by:" exceptions in the stack trace. It may be quite enough if the issue is simple. If you don't see any caused-by exceptions, it may be caused by the problem mentioned above - try another maven-jetty-plugin version (e.g. 6.1.21).
  • Now if you have a BeanCreationException like this:
Caused by: org.springframework.beans.factory.BeanCreationException: 
Error creating bean with name 'datasheetFileSearcher' defined in URL 
[jar:file:/C:/Users/lagivan/.m2/repository/org/lagivan/prototype/datasheet/1.0-SNAPSHOT/datasheet-1.0-SNAPSHOT.jar!/META-INF/cocoon/spring/datasheet-application-context.xml]: 
Error setting property values; 
nested exception is org.springframework.beans.PropertyBatchUpdateException; 
nested PropertyAccessExceptions (1) are:
PropertyAccessException 1: org.springframework.beans.TypeMismatchException: 
Failed to convert property value of type [org.lagivan.prototype.SpiderImpl] to required type [org.lagivan.prototype.Spider] for property 'spider'; 
nested exception is java.lang.IllegalArgumentException: 
Cannot convert value of type [org.lagivan.prototype.SpiderImpl] to required type [org.lagivan.prototype.Spider] for property 'spider': 
no matching editors or conversion strategy found
  • It means you've got the same issue as me and here is my explanation. Let's say as in the previous part we have three blocks search, datasheet, shared where search depends on both datasheet and shared blocks and datasheet also depends on shared. Then if you want to debug shared block and add its classes to rcl.properties file, you also have to add datasheet block classes as well. Otherwise there will be two copies of the each class from shared block being loaded: one - by some standard class loader from shared.jar and another - by ReloadingClassLoader from your classes directory. Thus, the correct solution is to add classes of all dependent cocoon blocks:
org.lagivan.prototype.search.service%classes-dir=./target/classes

org.lagivan.prototype.datasheet.service%classes-dir=../datasheet/target/classes
%exclude-lib=org.lagivan.prototype:datasheet

org.lagivan.prototype.shared.service%classes-dir=../shared/target/classes
%exclude-lib=org.lagivan.prototype:shared
  • If you're still not lucky and facing another issue, debug sources mentioned in your stack trace. In order to do this I had to add maven plugins and some cocoon libraries as dependencies of the failing block.

Comments

Popular posts from this blog

DynamicReports and Spring MVC integration

This is a tutorial on how to exploit DynamicReports reporting library in an existing Spring MVC based web application. It's a continuation to the previous post where DynamicReports has been chosen as the most appropriate solution to implement an export feature in a web application (for my specific use case). The complete code won't be provided here but only the essential code snippets together with usage remarks. Also I've widely used this tutorial that describes a similar problem for an alternative reporting library.
So let's turn to the implementation description and start with a short plan of this how-to:
Adding project dependencies.Implementing the Controller part of the MVC pattern.Modifying the View part of the MVC pattern.Modifying web.xml.Adding project dependencies
I used to apply Maven Project Builder throughout my Java applications, thus the dependencies will be provided in the Maven format.

Maven project pom.xml file:
net.sourceforge.dynamicreportsdynamicrepo…

Choosing Java reporting tool - part 2

I've provided a general overview of possible solutions to get a reporting/exporting functionality in the previous post. This is the second overview of alternatives based on JasperReports reporting engine.

Since the previous part I've done the following:
Implemented a simple report using both DynamicJasper and DynamicReports to compare them from technical side.Investigated JasperServer features and tried to implement a simple report for JasperServer instance (it appeared we already have a ready licensed installation of JasperServer that makes it unreasonable to install a fresh one).
First, the comparison results of Java libraries (DynamicJasper and DynamicReports):
Both libraries suffer from poor-quality or missing Java docs but they look a bit better in DynamicJasper.Taking into account the point 1, a developer has to use online documentation and to review the code. Here the code looks definitely nicer and more readable for DynamicReports. With respect t…

Do It Yourself Java Profiling

This article is a free translation of the Russian one that is a transcript of the Russian video lecture done by Roman Elizarov at the Application Developer Days 2011 conference.
The lecturer talked about profiling of Java applications without any standalone tools. Instead, it's suggested to use internal JVM features (i.e. threaddumps, java agents, bytecode manipulation) to implement profiling quickly and efficiently. Moreover, it can be applied on Production environments with minimal overhead. This concept is called DIY or "Do It Yourself". Below the lecture's text and slides begin.
Today I'm giving a lecture "Do It Yourself Java Profiling". It's based on the real life experience that was gained during more than 10 years of developing high-loaded finance applications that work with huge amounts of data, millions currency rate changes per second and thousands of online users. As a result, we have to deal with profiling. Application profiling is an i…