Component Name	Name in Sitemap	Block
CalendarGenerator	calendar	core
CSVGenerator	csv	core
CSVGeneratorBean		core
DefaultContentAggregator		core
DirectoryGenerator	directory	core
ExceptionGenerator		core
FileGenerator	file	core
FileGeneratorBean	file	core
FragmentExtractorGenerator		core
ImageDirectoryGenerator	imagedirectory	core
LinkStatusGenerator	linkstatus	core
MP3DirectoryGenerator	mp3directory	core
NotifyingGenerator		cor e
PauseGenerator		core
PauseGeneratorBean		core
RequestGenerator	request	core
ServletServiceGenerator	servletService	core
SessionAttributeGenerator	sessionattribute	core
StatusGenerator	status	core
StreamGenerator	stream	core
TraversableGenerator		core
XPathDirectoryGenerator	xpathdirectory	core
XPathTraversableGenerator		core
FormsGenerator		forms
SuggestionListGenerator		forms
HTMLGenerator	html	html
NekoHTMLGenerator	nekohtml	html
IMAPGenerator		mail
JXTemplateGenerator	jx	template

Component Name

Name in Sitemap

Block

calendar

core

CSVGenerator

csv

core

CSVGeneratorBean

core

DefaultContentAggregator

core

DirectoryGenerator

Component Name	Name in Sitemap	Block
BrowserUpdateTransformer		ajax
AugmentTransformer	augment	core
CIncludeTransformer	cinclude	core
EncodeURLTransformer	encodeurl	core
FilterTransformer	filter	core
FragmentExtractorTransformer		co re
I18nTransformer	i18n	core
IncludeTransformer	include	core
JPathTransformer	jpath	core
LinkGatherer		core
LinkTranslator		core
LogTransformer	log	core
Paginator		core
ReadDOMSessionTransformer	readDOM session	core
RoleFilterTransformer	role-filter	core
ServletServiceTransformer	servletService	core
SimpleFormInstanceExtractionTransformer	simple-form-instance	core
SimpleFormTransformer	simple-form	core
SourceWritingTransformer	sourcewriting	core
StripNameSpacesTransformer	stripnamespaces	core
TeeTransf ormer	tee	core
TraxTransformer	xslt	core
WriteDOMSessionTransformer	writeDOMsession	core
XIncludeTransformer	xinclude	core
XSLTTransformer	xslt	core
SQLTransformer		databases
FormsTemplateTransformer		forms
CleanupTransformer		html
HTMLTransformer		html
NekoHTMLTransformer		html
LinkRewriterTransformer		linkrewriter
VariableRewriterTransformer		linkrewriter
SendMailTransformer		mail
JXTemplateTransformer		template
TransformerAdapter		template

Component Name	Name in Sitemap	Block
SVGSerializer		batik
HTMLSerializer	html	core
LinkSerializer		core
ServletServiceSerializer	servletService	core
TextSerializer		core
XMLSerializer		core
ZipArchiveSerializer		core
FOPNGSerializer		fop
FOPSerializer		fop

Component Name	Name in Sitemap	Block
AjaxRequestMatcher		ajax
CachingRegexpMatcher		core
CachingWildcardMatcher		core
CookieMatcher		core
HeaderMatcher		core
LocaleMatcher		core
MountTableMatcher		core
ParameterMatcher		core
RegexpHeaderMatcher		core
RegexpHostMatcher		core
RegexpParameterMatcher		core
RegexpRequestAttributeMatcher		core
RegexpRequestParameterMatcher		core
RegexpSessionAttributeMatcher		core
RegexpURIMatcher		core
RequestAttributeMatcher		core
RequestParameterMatcher		core
SessionAttributeMatcher		core
WildcardHeaderMatcher		core
WildcardHostMatcher		core
WildcardMatcher		core
WildcardParameter Matcher		core
WildcardRequestAttributeMatcher		core
WildcardRequestParameterMatcher		core
WildcardSessionAttributeMatcher		core
WildcardURIMatcher		core

Component Name	Name in Sitemap	Block
AjaxRequestSelector		ajax
BrowserSelector		core
CookieSelector		core
ExceptionSelector		core
HeaderSelector		core
HostSelector		core
ParameterSelector		core
RegexpHeaderSelector		core
RegexpRequestParameterSelector		core
RequestAttributeSelector		core
RequestMethodSelector		core
RequestParameterSelector		core
ResourceExistsSelector		core
SessionAttributeSelector		core
SimpleSelector		core
XPathExceptionSelector		core

Component Name	Name in Sitemap	Block
GetContinuationAction		ajax
LoggedInAction		auth
LoginAction		auth
LogoutAction		auth
ClearCacheAction		core
ClearPersistentStoreAction		core
CopySourceAction		core
FormValidatorAction		core
HelloAction		core
HttpCacheAction		core
HttpHeaderAction		core
InputModuleAction		core
LocaleAction		core
LogAction		core
PreemptiveLoaderAction		core
PropagatorAction		core
RequestParamAction		core
RequestParameterExistsAction		core
ResourceExistsAction		core
SessionInvalidatorAction		core
SessionIsValidAction		core
SessionPropagatorAction		core
SessionStateAction		core
SessionValidatorAction		core
SetCharacterEncodingAction		core
SetterAction		core
DatabaseAddAction		databases
DatabaseAddAction		databases
DatabaseAuthenticatorAction		databases
DatabaseCookieAuthenticatorAction		databases
DatabaseDeleteAction		databases
DatabaseDeleteAction		databases
DatabaseQu eryAction		databases
DatabaseSelectAction		databases
DatabaseSelectAction		databases
DatabaseUpdateAction		databases
DatabaseUpdateAction		databases
OraAddAction		databases
OraUpdateAction		databases
HandleFormSubmitAction		forms
InitForm1Action		forms
MakeFormAction		forms
MailAction		mail
Sendmail		mail
SendmailAction		mail

Component Name	Name in Sitemap	Block
CalendarGenerator	calendar	core
CSVGenerator	csv	core
CSVGeneratorBean		core
DefaultContentAggregator		core
DirectoryGenerator	directory	core
ExceptionGenerator		core
FileGenerator	file	core
FileGeneratorBean	file	core
FragmentExtractorGenerator		core
ImageDirectoryGenerator	imagedirectory	core
LinkStatusGenerator	linkstatus	core
MP3DirectoryGenerator	mp3directory	core
NotifyingGenerator		core
PauseGenerator		core
PauseGeneratorBean		core
RequestGenerator	request	core
ServletServiceGenerator	servletService	core
SessionAttributeGenerator	sessionattribute	core
StatusGenerator	status	core
StreamGenerator	stream	core
TraversableGenerator		core
XPathDirectoryGenerator	xpathdirectory	core
XPathTraversableGenerator		core
FormsGenerator		forms
SuggestionListGenerator		forms
HTMLGenerator	html	html
NekoHTMLGenerator	nekohtml	html
IMAPGenerator		mail
JXTemplateGenerator	jx	template

Component Name	Name in Sitemap	Block
BrowserUpdateTransformer		ajax
AugmentTransformer	augment	core
CIncludeTransformer	cinclude	core
EncodeURLTransformer	encodeurl	core
FilterTransformer	filter	core
Fragment ExtractorTransformer		core
I18nTransformer	i18n	core
IncludeTransformer	include	core
JPathTransformer	jpath	core
LinkGatherer		core
LinkTranslator		core
LogTransformer	log	core
Paginator		core
R eadDOMSessionTransformer	readDOMsession	core
RoleFilterTransformer	role-filter	core
ServletServiceTransformer	servletService	core
SimpleFormInstanceExtractionTransformer	simple-form-instance	core
SimpleFormTransformer	simple-form	core
SourceWritingTransformer	sourcewriting	core
StripNameSpacesTransformer	stripnamespaces	core
TeeTransformer	tee	core
TraxTransformer	xslt	core
WriteDOMSessionTransformer	writeDOMsession	core
XIncludeTransformer	xinclude	core
XSLTTransformer	xslt	core
SQLTransformer		databases
FormsTemplateTransformer		forms
CleanupTransformer		html
HTMLTransformer		html
NekoHTMLTransformer		html
LinkRewriterTransformer		linkrewriter
VariableRewriterTransformer		linkrewriter
SendMailTransformer		mail
JXTemplateTransformer		template
TransformerAdapter		template

Component Name	Name in Sitemap	Block
SVGSerializer		batik
HTMLSerializer	html	core
LinkSerializer		core
ServletServiceSerializer	servletService	core
TextSerializer		core
XMLSerializer		core
ZipArchiveSerializer		core
FOPNGSerializer		fop
FOPSerializer		fop

Component Name	Name in Sitemap	Block
AjaxRequestMatcher		ajax
CachingRegexpMatcher		core
CachingWildcardMatcher		core
CookieMatcher		core
HeaderMatcher		core
LocaleMatcher		core
MountTableMatcher		core
ParameterMatcher		core
RegexpHeaderMatcher		core
RegexpHostMatcher		core
RegexpParameterMatcher		core
RegexpRequestAttributeMatcher		core
RegexpRequestParameterMatcher		core
RegexpSessionAttributeMatcher		core
RegexpURIMatcher		core
RequestAttributeMatcher		core
RequestParameterMatcher		core
SessionAttributeMatcher		core
WildcardHeaderMatcher		core
WildcardHostMatcher		core
WildcardMatcher		core
WildcardParameterMatcher		core
WildcardRequestAttributeMatcher		core
WildcardRequestParameterMatcher		core
WildcardSessionAttributeMatcher		core
WildcardURIMatcher		core

Component Name	Name in Sitemap	Block
AjaxRequestSelector		ajax
BrowserSelector		core
CookieSelector		core
ExceptionSelector		core
HeaderSelector		core
HostSelector		core
ParameterSelector		core
RegexpHeaderSelector		core
RegexpRequestParameterSelector		core
RequestAttributeSelector		core
RequestMethodSelector		core
RequestParameterSelector		core
ResourceExistsSelector		core
SessionAttributeSelector		core
SimpleSelector		core
XPathExceptionSelector		core

Component Name	Name in Sitemap< /th>	Block
GetContinuationAction		ajax
LoggedInAction		auth
LoginAction		auth
LogoutAction		auth
ClearCacheAction		core
ClearPersistentStoreAction		core
CopySourceAction		core
FormValidatorAction		core
HelloAction		core
HttpCacheAction		core
HttpHeaderAction		core
InputModuleAction		core
LocaleAction		core
LogAction		core
PreemptiveLoaderAction		core
PropagatorAction		core
RequestParamAction		core
RequestParameterExistsAction		core
ResourceExistsAction		core
SessionInvalidatorAction		core
SessionIsValidAction		core
SessionPropagatorAction		core
SessionStateAction		core
SessionValidatorAction		c ore
SetCharacterEncodingAction		core
SetterAction		core
DatabaseAddAction		databases
DatabaseAddAction		databases
DatabaseAuthenticatorAction		databases
DatabaseCookieAuthenticatorAction		databases
DatabaseDeleteAction		databases
DatabaseDeleteAction		databases
DatabaseQueryAction		databases
DatabaseSelectAction		databases
DatabaseSelectAction		databases
DatabaseUpdateAction		databases
DatabaseUpdateAction		databases
OraAddAction		databases
OraUpdateAction		databases
HandleFormSubmitAction		forms
InitForm1Action		forms
MakeFormAction		forms
MailAction		mail
Sendmail		mail
SendmailAction		mail

Deploying a Cocoon application

This tutorial is based on the -Your +Your first Cocoon application using Maven 2 which shows how to bootstrap a Cocoon project and Modularize Cocoon apps which shows how inter-block communication works. If you haven't followed the latter tutorial, you can go through this tutorial nonetheless but you have to skip everything -that refers to myBlock2.

In this tutorial, you will:

myBlock2

In this tutorial, you will:

Connect blocks to the webapp and run it
Create a parent Maven POM for the webapp and block

+
Create a parent Maven POM for the webapp and block
(a convenience which allows you to trigger cascading builds of both maven modules from a single command)
Change the block mount point so that it is mounted at the root level context (typical for a web application's "main block")

Creating a Cocoon web application

For this tutorial you will use the Cocoon web application archetype to create a Cocoon block suitable for generating a war file which can be deployed on a -servlet container such as Tomcat or Websphere etc. Change into the -getting-started-app folder and type the following command: -

mvn archetype:generate -DarchetypeCatalog=http://cocoon.apache.org
-

Choose the web application archetype:

Choose archetype:
+servlet container such as Tomcat or Websphere etc.  Change into the
+getting-started-app folder and type the following command: -mvn archetype:generate -DarchetypeCatalog=http://cocoon.apache.org
+
Choose the web application archetype:Choose archetype:
 1: remote -> cocoon-22-archetype-block-plain (Creates an empty Cocoon block; useful
- if you want to add another block to a Cocoon application)
+ if you want to add another block to a Cocoon application)
 2: remote -> cocoon-22-archetype-block (Creates a Cocoon block containing some small
- samples)
+ samples)
 3: remote -> cocoon-22-archetype-webapp (Creates a web application configured to
  host Cocoon blocks. Just add the block dependencies)
-Choose a number:  (1/2/3): 3
-
Then respond to the other questions as follows:Define value for groupId: : com.mycompany
-Define value for artifactId: : myCocoonWebApp
-Define value for version:  1.0-SNAPSHOT: : 1.0.0
-Define value for package: : com.mycompany.myCocoonWebApp 
-
Looking at the filesystem, you should find following directory structure:
getting-started-app
- +-myBlock1
+Choose a number:  (1/2/3): 3
+
Then respond to the other questions as follows:Define value for groupId: : com.mycompany
+Define value for artifactId: : myCocoonWebApp
+Define value for version:  1.0-SNAPSHOT: : 1.0.0
+Define value for package: : com.mycompany.myCocoonWebApp 
+
Looking at the filesystem, you should find following directory structure:
getting-started-app
+ +-myBlock1
  |  +-pom.xml
  |  +-src
  |     +-[...]
- +-myBlock2
+ +-myBlock2
  |  +-pom.xml
  |  +-src
  |     +-[...]
- +-myCocoonWebapp    
+ +-myCocoonWebapp    
     +-pom.xml
     +-src
        +-[...]
-
Using a block within the web application
In order to use blocks as dependencies you need to install them into
+

`Using a block within the web application`

In order to use blocks as dependencies you need to install them into Maven's local repository. First go to myBlock1/ directory and execute -following command:

mvn install
-

Then go to myBlock2/ and execute the same command. This way both +following command:

mvn install
+

Then go to myBlock2/ and execute the same command. This way both blocks will get installed into local repository where Maven stores all artifacts that can be used as dependencies.

So far the web application myCocoonWebapp doesn't have any information about the existense of the block myBlock1 and myBlock2. Change this by opening getting-started-app/myCocoonWebapp/pom.xml and add the block as -dependency:

<project>
-  [...]
-    <dependencies>
-      <dependency>
-        <groupId>com.mycompany</groupId>
-        <artifactId>myBlock1</artifactId>
-        <version>1.0-SNAPSHOT</version>
-      </dependency>
-      <dependency>
-        <groupId>com.mycompany</groupId>
-        <artifactId>myBlock2</artifactId>
-        <version>1.0-SNAPSHOT</version>
-      </dependency>
-    </dependencies>
-  [...]
-</project>

That's it. Now it's time to run the web application. Move into -getting-started-app/myCocoonWebapp and call

mvn package jetty:run

from there. -Open your favorite web browser and call

http://localhost:8888/myBlock1/

That's it!

`Creating a parent pom`

For your convenience you can create a parent pom for the three Maven modules. -Create a file getting-started-app/pom.xml with following content:

<project xmlns="http://maven.apache.org/POM/4.0.0" 
+dependency:
<project>
+  [...]
+    <dependencies>
+      <dependency>
+        <groupId>com.mycompany</groupId>
+        <artifactId>myBlock1</artifactId>
+        <version>1.0-SNAPSHOT</version>
+      </dependency>
+      <dependency>
+        <groupId>com.mycompany</groupId>
+        <artifactId>myBlock2</artifactId>
+        <version>1.0-SNAPSHOT</version>
+      </dependency>
+    </dependencies>
+  [...]
+</project>
That's it. Now it's time to run the web application. Move into
+getting-started-app/myCocoonWebapp and call
mvn package jetty:run
from there.

+Open your favorite web browser and call
http://localhost:8888/myBlock1/
That's it!
Creating a parent pom
For your convenience you can create a parent pom for the three Maven modules.
+Create a file getting-started-app/pom.xml with following content:
<project xmlns="http://maven.apache.org/POM/4.0.0" 
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
 
@@ -233,49 +241,53 @@ Create a file getting-started-app/po
   <name>Cocoon Getting Stared application [parent]</name>
   
   <modules>
-    <module>myCocoonWebapp</module>
-    <module>myBlock1</module>
-    <module>myBlock2</module>
-  </modules>
+    <module>myCocoonWebapp</module>
+    <module>myBlock1</module>
+    <module>myBlock2</module>
+  </modules>
 </project>
-
Having a parent pom file, you can trigger a reactor build from root, e.g. you
+

Having a parent pom file, you can trigger a reactor build from root, e.g. you can call mvn install from root which will compile, package and install the webapp and the block. Maven also takes care that the modules are build, according to the dependency graph, in the correct order.

If you want to inherit information (e.g. plugin configurations, properties, etc.) from the new parent pom to its child modules, you have to add the parent element to getting-started-app/myCocoonWebapp/pom.xml , getting-started-app/myBlock1/pom.xml and -getting-started-app/myBlock2/pom.xml:

<project xmlns="http://maven.apache.org/POM/4.0.0" 
+getting-started-app/myBlock2/pom.xml:
<project xmlns="http://maven.apache.org/POM/4.0.0" 
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
 
   [...]
-  <parent>
+  <parent>
     <groupId>com.mycompany</groupId>
     <artifactId>getting-started-app</artifactId>
     <version>1-SNAPSHOT</version>
-  </parent>
+  </parent>
   [...]
 
-</project>
Mounting your block at the root level
You can mount your block at the root level in the application URI space, so
+</project>

Mounting your block at the root level

You can mount your block at the root level in the application URI space, so that instead of using (for example) the URI http://localhost:8888/myBlock1/foo/bar to request a page, you would request it at http://localhost:8888/foo/bar.

To do this, edit myBlock1/src/main/resources/META-INF/cocoon/spring/blockServlet.xml , -and change the element

All Sitemap Components

Generators

Transformers

Serializers

Matchers

Selectors

Actions

All Sitemap Components

Generators

Transformers

Serializers

Matchers

Selectors

Actions

Deploying a Cocoon application

Creating a Cocoon web application

Creating a Cocoon web application

`Using a block within the web application`

`Using a block within the web application`

`Creating a parent pom`

Creating a parent pom

Mounting your block at the root level

`Mounting your block at the root level`