Apache » Cocoon »

Cocoon Maven Plugin 1.0.2 homepage

Cocoon Maven Plugin 1.0.2

cocoon:prepare

Full name:

org.apache.cocoon:cocoon-maven-plugin:1.0.2:prepare

Description:

Create a web application environment for a Cocoon block, including support for the reloading classloader.

Attributes:

  • Requires a Maven project to be executed.
  • Requires dependency resolution of artifacts in scope: runtime.
  • Invokes the execution of the lifecycle phase process-classes prior to executing itself.

Required Parameters

Name Type Since Description
project MavenProject - The project whose project files to create.
User property is: project.

Optional Parameters

Name Type Since Description
customLoggingConf String - Logging: Use a custom log4j (cocoon-22) / logback (ssf) xml configuration file.
customWebappDirectory File - Use a custom web application directory.
rclPropertiesFile File - The central property file that contains all information about where to find blocks.
reloadingClassLoaderEnabled boolean - Enable the reloading class loader. Default value is true.
reloadingSpringEnabled boolean - Enable reloading of the Spring application context. Note: The reload of the application context doesn't work properly if it contains beans which are based on proxies with interfaces which are loaded by the reloading class loader. As a workaround you can put all those interfaces into a separate module which is NOT loaded by the reloading class loader.
target File - The directory that contains the Cocoon web application.
useConsoleAppender boolean - Logging: Use console appender?
useSocketAppender boolean - Logging: Use socket appender?
webappProfile String - This goal prepares a minimal Cocoon web application using the default profile 'cocoon-22' that can be used to run a block. Alternatively a 'ssf' (servlet-service framework) profile is supported, which creates a web application that want to use the servlet-service framework only.

Parameter Details

customLoggingConf:

Logging: Use a custom log4j (cocoon-22) / logback (ssf) xml configuration file.
  • Type: java.lang.String
  • Required: No

customWebappDirectory:

Use a custom web application directory.
  • Type: java.io.File
  • Required: No

project:

The project whose project files to create.
  • Type: org.apache.maven.project.MavenProject
  • Required: Yes
  • User Property: project

rclPropertiesFile:

The central property file that contains all information about where to find blocks.
  • Type: java.io.File
  • Required: No
  • Expression: ./rcl.properties

reloadingClassLoaderEnabled:

Enable the reloading class loader. Default value is true.
  • Type: boolean
  • Required: No

reloadingSpringEnabled:

Enable reloading of the Spring application context. Note: The reload of the application context doesn't work properly if it contains beans which are based on proxies with interfaces which are loaded by the reloading class loader. As a workaround you can put all those interfaces into a separate module which is NOT loaded by the reloading class loader.
  • Type: boolean
  • Required: No

target:

The directory that contains the Cocoon web application.
  • Type: java.io.File
  • Required: No
  • Expression: ./target/rcl

useConsoleAppender:

Logging: Use console appender?
  • Type: boolean
  • Required: No

useSocketAppender:

Logging: Use socket appender?
  • Type: boolean
  • Required: No

webappProfile:

This goal prepares a minimal Cocoon web application using the default profile 'cocoon-22' that can be used to run a block. Alternatively a 'ssf' (servlet-service framework) profile is supported, which creates a web application that want to use the servlet-service framework only.
  • Type: java.lang.String
  • Required: No