Delivered-To: mailing list cvs@cocoon.apache.org Received: (qmail 56692 invoked by uid 500); 11 Jul 2003 19:48:46 -0000 Delivered-To: apmail-cocoon-site-cvs@apache.org Received: (qmail 56648 invoked from network); 11 Jul 2003 19:48:45 -0000 Received: from icarus.apache.org (208.185.179.13) by daedalus.apache.org with SMTP; 11 Jul 2003 19:48:45 -0000 Received: (qmail 98103 invoked by uid 1672); 11 Jul 2003 19:48:44 -0000 Date: 11 Jul 2003 19:48:44 -0000 Message-ID: <20030711194844.98102.qmail@icarus.apache.org> From: joerg@apache.org To: cocoon-site-cvs@apache.org Subject: cvs commit: cocoon-site/site/2.1/userdocs/readers axisrpc-reader.html axisrpc-reader.pdf database-reader.html database-reader.pdf directoryziparchiver-reader.html directoryziparchiver-reader.pdf image-reader.html image-reader.pdf jsp-reader.html jsp-reader.pdf readers.html readers.pdf resource-reader.html resource-reader.pdf byterangeresource-reader.html byterangeresource-reader.pdf X-Spam-Rating: daedalus.apache.org 1.6.2 0/1000/N joerg 2003/07/11 12:48:44 Modified: site/2.1/userdocs/readers axisrpc-reader.html axisrpc-reader.pdf database-reader.html database-reader.pdf directoryziparchiver-reader.html directoryziparchiver-reader.pdf image-reader.html image-reader.pdf jsp-reader.html jsp-reader.pdf readers.html readers.pdf resource-reader.html resource-reader.pdf Removed: site/2.1/userdocs/readers byterangeresource-reader.html byterangeresource-reader.pdf Log: updated information on readers Revision Changes Path 1.5 +456 -463 cocoon-site/site/2.1/userdocs/readers/axisrpc-reader.html Index: axisrpc-reader.html =================================================================== RCS file: /home/cvs/cocoon-site/site/2.1/userdocs/readers/axisrpc-reader.html,v retrieving revision 1.4 retrieving revision 1.5 diff -u -r1.4 -r1.5 --- axisrpc-reader.html 21 May 2003 15:23:48 -0000 1.4 +++ axisrpc-reader.html 11 Jul 2003 19:48:43 -0000 1.5 @@ -1,465 +1,458 @@ - - - - -Axis RPC Reader in Cocoon - - - - - - - - - - - -

- - - - - - - - - - - - - - - - - - -

- -

- - - - -

Home

- -

- - - - - + + +

- - - - - - - - - - - - -

- - - - - - - - - - -

- -

-Navigation -
- -Main -
- -User Documentation -
-
-Readers -
- -Overview -
-
-Default -
- -Resource Reader -
-
-Core -
-
-Optional -
- -Database Reader -
- -JSP Reader -
-
-Scratchpad -
- -AxisRPC Reader -
- -Byte Range Resource Reader -
- -Directory ZIP Archiver -
- -Image Reader -
-

- -

- - - - - - - - - - - - - - - + + + + + + + + + + + +

- - -

- - - - -

Axis RPC Reader in Cocoon

- PDF

-by Bernhard Huber -

-AxisRPCReader -
-Description -
-Usage -
- -Sitemap pipeline examples -
- -Sitemap component configuration example -
- -Configuration -
- -Setup -
- -Effect on Object Model and Sitemap Parameters -
-
-Bugs/Caveats -
-History -
-Copyright -
-See also -

- - -

AxisRPCReader

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + +Axis RPC Reader in Cocoon + + + + +

NAME	template
WHAT	The AxisRPCReader allows to serve SOAP requests from - your Cocoon application. -
TYPE	Reader, Sitemap Component
BLOCK	Scratchpad
CLASS	org.apache.cocoon.reading.AxisRPCReader

+ + + + + + +

+ + + + + + + + + + + + + + + + + + +

+ +

+ + + + +

Home

+ +

+ + + + + - -

+ + + + + + + + + + + + +

+ + + + + + + + + + +

+ +

+Navigation +
- +Main +
- +User Documentation +
+
+Readers +
- +Overview +
+
+Default +
- +Resource Reader +
+
+Core +
- +Image Reader +
+
+Optional +
- +AxisRPC Reader +
- +Database Reader +
- +JSP Reader +
+
+Scratchpad +
- +Directory ZIP Archiver +
+

+ +

+ + + + + + + + + + + + + + + - - -

+ + +

+ + + + +

Axis RPC Reader in Cocoon

+ PDF

+by Bernhard Huber +

+AxisRPCReader +
+Description +
+Usage +
- +Sitemap pipeline examples +
- +Sitemap component configuration example +
- +Configuration +
- +Setup +
- +Effect on Object Model and Sitemap Parameters +
+
+Bugs/Caveats +
+History +
+Copyright +
+See also +

+ + +

AxisRPCReader

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - -

NAME	template
WHAT	The AxisRPCReader allows to serve SOAP requests from + your Cocoon application. +
TYPE	Reader, Sitemap Component
BLOCK	Axis
CLASS	org.apache.cocoon.reading.AxisRPCReader
SINCE	Cocoon 2.1
CACHEABLE	no

- - -

Description

- A general description of AxisRPCReader -

- - -

Usage

- A usage scenario of AxisRPCReader -

- -

Sitemap pipeline examples

  -<map:match pattern="rpcrouter">
  -  <map:read type="soap-rpc" mime-type="text/xml"/>
  -</map:match>
  -

- -

Sitemap component configuration example

  -<map:readers...
  -  <map:reader name="soap-rpc"
  -    src="org.apache.cocoon.reading.AxisRPCReader"
  -    logger="sitemap.reader.soap-rpc" 
  -    >
  -    <!-- optional reader configuration -->
  -    ...
  -  </map:readers>
  -...
  -

- -

Configuration

- Explain the sitemap reader configuration, options when declaring template reader -

- -

Setup

- Explain the sitemap reader setup, ie options when using template reader -

- -

Effect on Object Model and Sitemap Parameters

- - -

Bugs/Caveats

- As a prerequisite for AxisRPCReader to work properly, the Avalon - component SoapServer has to be configured in - the cocoon.xconf file. -

- - -

History

- 12-25-02: initial creation by Bernhard Huber -

- - -

Copyright

- - -

Description

+ A general description of AxisRPCReader +

+ + +

Usage

+ A usage scenario of AxisRPCReader +

+ +

Sitemap pipeline examples

  +<map:match pattern="rpcrouter">
  +  <map:read type="soap-rpc" mime-type="text/xml"/>
  +</map:match>
  +

+ +

Sitemap component configuration example

  +<map:readers...
  +  <map:reader name="soap-rpc"
  +    src="org.apache.cocoon.reading.AxisRPCReader"
  +    logger="sitemap.reader.soap-rpc" 
  +    >
  +    <!-- optional reader configuration -->
  +    ...
  +  </map:readers>
  +...
  +

+ +

Configuration

+ Explain the sitemap reader configuration, options when declaring template reader +

+ +

Setup

+ Explain the sitemap reader setup, ie options when using template reader +

+ +

Effect on Object Model and Sitemap Parameters

+ + +

Bugs/Caveats

+ As a prerequisite for AxisRPCReader to work properly, the Avalon + component SoapServer has to be configured in + the cocoon.xconf file. +

+ + +

History

+ 12-25-02: initial creation by Bernhard Huber +

+ + +

Copyright

+ + +

DatabaseReader

- PDF

-by Bernhard Huber -

-DatabaseReader -
-Description -
-Usage -
- -Sitemap pipeline examples -
- -Sitemap component configuration example -
- -Configuration -
- -Setup -
- -Effect on Object Model and Sitemap Parameters -
-
-Bugs/Caveats -
-History -
-Copyright -
-See also -

- - -

DatabaseReader

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + +DatabaseReader + + + + +

NAME	databasereader
WHAT	The DatabaseReader component is used - to serve data from a database -
TYPE	Reader, Sitemap Component
BLOCK	Database
CLASS	org.apache.cocoon.reading.DatabaseReader

+ + + + + + +

+ + + + + + + + + + + + + + + + + + +

+ +

+ + + + +

Home

+ +

+ + + + + - -

+ + + + + + + + + + + + +

+ + + + + + + + + + +

+ +

+Navigation +
- +Main +
- +User Documentation +
+
+Readers +
- +Overview +
+
+Default +
- +Resource Reader +
+
+Core +
- +Image Reader +
+
+Optional +
- +AxisRPC Reader +
- +Database Reader +
- +JSP Reader +
+
+Scratchpad +
- +Directory ZIP Archiver +
+

+ +

+ + + + + + + + + + + + + + + - - -

+ + +

+ + + + +

DatabaseReader

+ PDF

+by Bernhard Huber +

+DatabaseReader +
+Description +
+Usage +
- +Sitemap pipeline examples +
- +Sitemap component configuration example +
- +Configuration +
- +Setup +
- +Effect on Object Model and Sitemap Parameters +
+
+Bugs/Caveats +
+History +
+Copyright +
+See also +

+ + +

DatabaseReader

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - -

NAME	databasereader
WHAT	The DatabaseReader component is used + to serve data from a database +
TYPE	Reader, Sitemap Component
BLOCK	Database
CLASS	org.apache.cocoon.reading.DatabaseReader
SINCE	Cocoon 2.1
CACHEABLE	yes

- - -

Description

- This Reader pulls a resource from a database. It is configured with - the Connection to use, parameters specify the table and column - to pull the image from, and source specifies the source key information. -

- - -

Usage

- -

Sitemap pipeline examples

- The following pipeline snippet uses a Database Reader - for serving PNG images from a database. -

  -<map:match pattern="images/*.png">
  -  <map:read type="databasereader" 
  -    src="{1}" 
  -    mime-type="image/png">
  -    <!-- option sitemap parameters -->
  -    <map:parameter name="table" value="images"/>
  -    <map:parameter name="image" value="image"/>
  -    <map:parameter name="key" value="name"/>
  -    <map:parameter name="where" value="publishing = 1"/>
  -    <map:parameter name="order-by" value="created"/>
  -    <map:parameter name="last-modified" value="last-modified"/>
  -  </map:read>
  -</map:match>
  -

- The snippet above make following assumption about the database -

A database table images holds the PNG image data.
The database table has image column storing the image data as BLOB. -
The database table has key column which must match the value of - of {1}. -
The database table has publishing column indicating by value 1 - that the image data is allowed to get published. -
The database table has created column, indicating the creation date of - the image data, and used if the key is not a primary key, serving - images in a LIFO fashion. -
The database table has last-modified column of type TIMESTAMP - indicating the last modification date of the image data. -

- -

Sitemap component configuration example

  -<map:readers...
  -  <map:reader name="databasereader" 
  -    src="org.apache.cocoon.reading.DatabaseReader"
  -    logger="sitemap.reader.databasereader" 
  -    pool-max="32" pool-min="1" pool-grow="4"/>
  -    <!-- optional reader configuration -->
  -    ...
  -  </map:readers>
  -...
  -

- -

Configuration

- In the Database Reader declaration section following configuration - options are available -

- - - - - - - - - - - - - - - - - - -

Configurationname	Type	Comment
use-connection	Data source name	The name of a database selector, configured in the - cocoon.xconf file. -
invalidate	never \| always	- This option configures the caching behaviour if lastModifed - has value of -1. -

- -

Setup

- The DatabaseReader accepts following setup parameters -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Parametername	Type	Comment
table	database table name	The database table name
image	database column name	The column name of the image data
key	database key column name	The key column name of the image data matching the src attribute of - the <map:read> sitemap usage. -
where	database where expression	Optional parameter specifying SQL where expression.
order-by	database order-by expression	Optional parameter specifying an SQL order-by expression. -
last-modified	timestamp column name	Optional parameter a TIMESTAMP column name, added - to the SELECT clause of the SQL query. -
content-type	database column name	Optional parameter a column name, if specified the column - value overrides the mime-type attribute of the - <map:read> sitemap usage. -

- The key value is derived from the src attribute - of the Database Reader usage.. -

- The Database Reader builds internally following SQL query: -

  -SELECT {image} [, last-modified] [, {order-by-column} ] from {table}
  -  WHERE {key} = {src} [ AND {where} ]
  -  [ORDER BY {order-by}]
  -

- -

Effect on Object Model and Sitemap Parameters

- -

- - -

Bugs/Caveats

- The Database Reader needs a datasource name, it is referenced - by the configuration element use-connection. The datasource name - has to be configured in the Cocoon database configuration cocoon.xconf. -

- If the parameter last-modified ends with " DESC" this - suffix is truncated as it is appended to the SQL clause, noted as {order-by-column} - in the SQL query snippet above. -

- - -

History

- 12-25-02: created initial version by Bernhard Huber -

- - -

Copyright

- - -

Description

+ This Reader pulls a resource from a database. It is configured with + the Connection to use, parameters specify the table and column + to pull the image from, and source specifies the source key information. +

+ + +

Usage

+ +

Sitemap pipeline examples

+ The following pipeline snippet uses a Database Reader + for serving PNG images from a database. +

  +<map:match pattern="images/*.png">
  +  <map:read type="databasereader" 
  +    src="{1}" 
  +    mime-type="image/png">
  +    <!-- option sitemap parameters -->
  +    <map:parameter name="table" value="images"/>
  +    <map:parameter name="image" value="image"/>
  +    <map:parameter name="key" value="name"/>
  +    <map:parameter name="where" value="publishing = 1"/>
  +    <map:parameter name="order-by" value="created"/>
  +    <map:parameter name="last-modified" value="last-modified"/>
  +  </map:read>
  +</map:match>
  +

+ The snippet above make following assumption about the database +

A database table images holds the PNG image data.
The database table has image column storing the image data as BLOB. +
The database table has key column which must match the value of + of {1}. +
The database table has publishing column indicating by value 1 + that the image data is allowed to get published. +
The database table has created column, indicating the creation date of + the image data, and used if the key is not a primary key, serving + images in a LIFO fashion. +
The database table has last-modified column of type TIMESTAMP + indicating the last modification date of the image data. +

+ +

Sitemap component configuration example

  +<map:readers...
  +  <map:reader name="databasereader" 
  +    src="org.apache.cocoon.reading.DatabaseReader"
  +    logger="sitemap.reader.databasereader" 
  +    pool-max="32" pool-min="1" pool-grow="4"/>
  +    <!-- optional reader configuration -->
  +    ...
  +  </map:readers>
  +...
  +

+ +

Configuration

+ In the Database Reader declaration section following configuration + options are available +

+ + + + + + + + + + + + + + + + + + +

Configurationname	Type	Comment
use-connection	Data source name	The name of a database selector, configured in the + cocoon.xconf file. +
invalidate	never \| always	+ This option configures the caching behaviour if lastModifed + has value of -1. +

+ +

Setup

+ The DatabaseReader accepts following setup parameters +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parametername	Type	Comment
table	database table name	The database table name
image	database column name	The column name of the image data
key	database key column name	The key column name of the image data matching the src attribute of + the <map:read> sitemap usage. +
where	database where expression	Optional parameter specifying SQL where expression.
order-by	database order-by expression	Optional parameter specifying an SQL order-by expression. +
last-modified	timestamp column name	Optional parameter a TIMESTAMP column name, added + to the SELECT clause of the SQL query. +
content-type	database column name	Optional parameter a column name, if specified the column + value overrides the mime-type attribute of the + <map:read> sitemap usage. +

+ The key value is derived from the src attribute + of the Database Reader usage.. +

+ The Database Reader builds internally following SQL query: +

  +SELECT {image} [, last-modified] [, {order-by-column} ] from {table}
  +  WHERE {key} = {src} [ AND {where} ]
  +  [ORDER BY {order-by}]
  +

+ +

Effect on Object Model and Sitemap Parameters

+ +

+ + +

Bugs/Caveats

+ The Database Reader needs a datasource name, it is referenced + by the configuration element use-connection. The datasource name + has to be configured in the Cocoon database configuration cocoon.xconf. +

+ If the parameter last-modified ends with " DESC" this + suffix is truncated as it is appended to the SQL clause, noted as {order-by-column} + in the SQL query snippet above. +

+ + +

History

+ 12-25-02: created initial version by Bernhard Huber +

+ + +

Copyright

+ + +

DirectoryZipArchiver

- PDF

-by Bernhard Huber -

-DirectoryZipArchiver -
-Description -
-Usage -
- -Sitemap pipeline examples -
- -Sitemap component configuration example -
- -Configuration -
- -Setup -
- -Effect on Object Model and Sitemap Parameters -
-
-Bugs/Caveats -
-History -
-Copyright -
-See also -

- - -

DirectoryZipArchiver

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + +DirectoryZipArchiver + + + + +

NAME	resource
WHAT	The DirectoryZipArchiver - The DirectoryZipArchiver component creates a compressed zip - archive of directory files on the fly. -
TYPE	Reader, Sitemap Component
BLOCK	Scratchpad
CLASS	org.apache.cocoon.reading.DirectoryZipArchiver

+ + + + + + +

+ + + + + + + + + + + + + + + + + + +

+ +

+ + + + +

Home

+ +

+ + + + + - -

+ + + + + + + + + + + + +

+ + + + + + + + + + +

+ +

+Navigation +
- +Main +
- +User Documentation +
+
+Readers +
- +Overview +
+
+Default +
- +Resource Reader +
+
+Core +
- +Image Reader +
+
+Optional +
- +AxisRPC Reader +
- +Database Reader +
- +JSP Reader +
+
+Scratchpad +
- +Directory ZIP Archiver +
+

+ +

+ + + + + + + + + + + + + + + - - -

+ + +

+ + + + +

DirectoryZipArchiver

+ PDF

+by Bernhard Huber +

+DirectoryZipArchiver +
+Description +
+Usage +
- +Sitemap pipeline examples +
- +Sitemap component configuration example +
- +Configuration +
- +Setup +
- +Effect on Object Model and Sitemap Parameters +
+
+Bugs/Caveats +
+History +
+Copyright +
+See also +

+ + +

DirectoryZipArchiver

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - -

NAME	resource
WHAT	The DirectoryZipArchiver + The DirectoryZipArchiver component creates a compressed zip + archive of directory files on the fly. +
TYPE	Reader, Sitemap Component
BLOCK	Scratchpad
CLASS	org.apache.cocoon.reading.DirectoryZipArchiver
SINCE	Cocoon 2.1
CACHEABLE	no

- - -

Description

- - -

Usage

- -

Sitemap pipeline examples

- -

Sitemap component configuration example

- -

Configuration

- -

Setup

- -

Effect on Object Model and Sitemap Parameters

- - -

Bugs/Caveats

- - -

History

- MM-DD-YY: comment -

- - -

Copyright

- - -

Description

+ + +

Usage

+ +

Sitemap pipeline examples

+ +

Sitemap component configuration example

+ +

Configuration

+ +

Setup

+ +

Effect on Object Model and Sitemap Parameters

+ + +

Bugs/Caveats

+ + +

History

+ MM-DD-YY: comment +

+ + +

Copyright

+ + +

ImageReader in Cocoon

- PDF

-by Bernhard Huber -

-ImageReader -
-Description -
-Usage -
- -Sitemap pipeline examples -
- -Sitemap component configuration example -
- -Configuration -
- -Sitemap Parameters -
- -Effect on Object Model and Sitemap Parameters -
-
-Bugs/Caveats -
-History -
-Copyright -
-See also -

- - -

ImageReader

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + +ImageReader in Cocoon + + + + +

NAME	image
WHAT	The ImageReader component is used - to serve binary image data in a sitemap pipeline. -
TYPE	Reader, Sitemap Component
BLOCK	Core
CLASS	org.apache.cocoon.reading.ImageReader

+ + + + + + +

+ + + + + + + + + + + + + + + + + + +

+ +

+ + + + +

Home

+ +

+ + + + + - -

+ + + + + + + + + + + + +

+ + + + + + + + + + +

+ +

+Navigation +
- +Main +
- +User Documentation +
+
+Readers +
- +Overview +
+
+Default +
- +Resource Reader +
+
+Core +
- +Image Reader +
+
+Optional +
- +AxisRPC Reader +
- +Database Reader +
- +JSP Reader +
+
+Scratchpad +
- +Directory ZIP Archiver +
+

+ +

+ + + + + + + + + + + + + + + - - -

+ + +

+ + + + +

ImageReader in Cocoon

+ PDF

+by Bernhard Huber, Upayavira +

+ImageReader +
+Description +
+Usage +
- +Sitemap pipeline examples +
- +Sitemap component configuration example +
- +Configuration +
- +Sitemap Parameters +
- +Effect on Object Model and Sitemap Parameters +
+
+Bugs/Caveats +
+History +
+Copyright +
+See also +

+ + +

ImageReader

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - -

NAME	image
WHAT	The ImageReader component is used + to serve binary image data in a sitemap pipeline. +
TYPE	Reader, Sitemap Component
BLOCK	Core
CLASS	org.apache.cocoon.reading.ImageReader
SINCE	Cocoon 2.1
CACHEABLE	yes

- - -

Description

- The ImageReader component is used to serve binary image data - in a sitemap pipeline. -

- - -

Usage

- -

Sitemap pipeline examples

- The ImageReader is used in a pipline as shown in the - pipeline snippet below: -

  -<map:match pattern="*.png">
  -  <map:read type="image" 
  -    src="resources/styles/{1}.css" 
  -    mime-type="image/jpeg">
  -    <!-- optional setup parameters -->
  -  </map:read>
  -</map:match>
  -

- It is important to specify the mime-type attribute, - as it is passed to the browser as the Content-Type - in the HTTP response. -

- -

Sitemap component configuration example

- A ImageReader is declared in the sitemap readers - section, as shown in the sitemap readers snippet below: -

  -<map:readers default="resource">
  -...
  -  <map:reader name="image" 
  -    src="org.apache.cocoon.reading.ImageReader"
  -    logger="sitemap.reader.image" 
  -    pool-max="32" pool-min="1" pool-grow="4"/>
  -    <!-- optional reader configuration -->
  -    ...
  -  </map:readers>
  -...
  -

- -

Configuration

- The ImageReader has no configuration options. -

- -

Sitemap Parameters

- The ImageReader accepts following sitemap - setup parameters -

- - - - - - - - - - - - - - - - - - - - - - - - -

Parameter Name	Type	Comment
expires	Time in milliseconds	- This parameter is optional. When specified it determines how long - in miliseconds the resources can be cached by any proxy or browser - between Cocoon2 and the requesting visitor. -
width	Image width in pixels	- This parameter is optional. When specified it determines the width - of the binary image. - If no height parameter is specified the ascpect ratio - of the image is kept. -
height	Image height in pixels	- This parameter is optional. When specified it determines the width - of the binary image. - If no width parameter is specified the ascpect ratio - of the image is kept. -

- The following pipeline snippet - uses the ImageReader for serving images - having an expiration time of 1 day (ie. 24 * 60 * 60 * 1000 ms = 86400000 ms), - and scaling images to width 300 pixels. -

  -<map:match pattern="*.jpg">
  -  <map:reader type="image" 
  -    <map:parameter name="expires" value="86400000"/>
  -    <map:parameter name="width" value="300"/>
  -  </map:reader>
  -...
  -

- -

Effect on Object Model and Sitemap Parameters

- The ImageReader does not change object model and sitemap parameters. - It only access parameter values for reading. -

- - -

Bugs/Caveats

- The ImageReader is able to transform - JPEG images only. - Nevertheless it can serve any image data in a non transforming mode. -

- The ImageReader does NOT support HTTP ranges, thus - it sets Accept-Ranges to none. -

- The java Bug Id 4502892 (which is found in *all* JVM implementations from - 1.2.x and 1.3.x on all OS!), ImageReader must buffer - the JPEG generation to avoid that connection resetting by the peer - (user pressing the stop button, for example) crashes the entire JVM. -

- - -

History

- 12-25-02: Initial document creation by Bernhard Huber -
- 01-06-03: Renamed the expire-time -> expires parameter, - Fixed the statement about the byte range support, Torsten Curdt -

- - -

Copyright

- - -

Description

+ The ImageReader component is used to serve binary image data + in a sitemap pipeline. +

+ + +

Usage

+ +

Sitemap pipeline examples

+ The ImageReader is used in a pipline as shown in the + pipeline snippet below: +

  +<map:match pattern="*.png">
  +  <map:read type="image" 
  +    src="resources/styles/{1}.css" 
  +    mime-type="image/jpeg">
  +    <!-- optional setup parameters -->
  +  </map:read>
  +</map:match>
  +

+ It is important to specify the mime-type attribute, + as it is passed to the browser as the Content-Type + in the HTTP response. +

+ +

Sitemap component configuration example

+ A ImageReader is declared in the sitemap readers + section, as shown in the sitemap readers snippet below: +

  +<map:readers default="resource">
  +...
  +  <map:reader name="image" 
  +    src="org.apache.cocoon.reading.ImageReader"
  +    logger="sitemap.reader.image" 
  +    pool-max="32" pool-min="1" pool-grow="4"/>
  +    <!-- optional reader configuration -->
  +    ...
  +  </map:readers>
  +...
  +

+ +

Configuration

+ The ImageReader has no configuration options. +

+ +

Sitemap Parameters

+ The ImageReader accepts following sitemap + setup parameters +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter Name	Type	Comment
expires	Time in milliseconds	+ This parameter is optional. When specified it determines how long + in miliseconds the resources can be cached by any proxy or browser + between Cocoon2 and the requesting visitor. +
width	Image width in pixels	+ This parameter is optional. When specified it determines the width + of the binary image. + If no height parameter is specified the aspect ratio + of the image is kept. +
height	Image height in pixels	+ This parameter is optional. When specified it determines the width + of the binary image. + If no width parameter is specified the aspect ratio + of the image is kept. +
allow-enlarging	Allow or prevent the enlarging of images	+ This parameter is optional. The width and height parameters allow an image + to be resized. By default, if the image is smaller than the specified + width and height, the image will be enlarged. In some circumstances, this + behaviour is undesirable, and can be switched off by setting this parameter + to no. With this parameter set to no, images will + be reduced in size, but not enlarged. The default for this parameter is + yes. +

+ The following pipeline snippet + uses the ImageReader for serving images + having an expiration time of 1 day (ie. 24 * 60 * 60 * 1000 ms = 86400000 ms), + and scaling images to width 300 pixels. +

  +<map:match pattern="*.jpg">
  +  <map:reader type="image" 
  +    <map:parameter name="expires" value="86400000"/>
  +    <map:parameter name="width" value="300"/>
  +  </map:reader>
  +...
  +

+ +

Effect on Object Model and Sitemap Parameters

+ The ImageReader does not change object model and sitemap parameters. + It only access parameter values for reading. +

+ + +

Bugs/Caveats

+ The ImageReader is able to transform + JPEG images only. + Nevertheless it can serve any image data in a non transforming mode. +

+ The ImageReader does NOT support HTTP ranges, thus + it sets Accept-Ranges to none. +

+ The java Bug Id 4502892 (which is found in *all* JVM implementations from + 1.2.x and 1.3.x on all OS!), ImageReader must buffer + the JPEG generation to avoid that connection resetting by the peer + (user pressing the stop button, for example) crashes the entire JVM. +

+ + +

History

+ 12-25-02: Initial document creation by Bernhard Huber +
+ 01-06-03: Renamed the expire-time -> expires parameter, + Fixed the statement about the byte range support, Torsten Curdt +
+ 03-07-03: Added allow-enlarging parameter, Upayavira +

+ + +

Copyright

+ + +

JSP Reader in Cocoon

- PDF

-by Bernhard Huber -

-JSPReader -
-Description -
-Usage -
- -Sitemap pipeline examples -
- -Sitemap component configuration example -
- -Configuration -
- -Setup -
- -Effect on Object Model and Sitemap Parameters -
-
-Bugs/Caveats -
-History -
-Copyright -
-See also -

- - -

JSPReader

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + +JSP Reader in Cocoon + + + + +

NAME	jsp
WHAT	The JSPReader component is used to serve JSP page output data - in a sitemap pipeline. -
TYPE	Reader, Sitemap Component
BLOCK	Jsp
CLASS	org.apache.cocoon.reading.JSPReader

+ + + + + + +

+ + + + + + + + + + + + + + + + + + +

+ +

+ + + + +

Home

+ +

+ + + + + - -

+ + + + + + + + + + + + +

+ + + + + + + + + + +

+ +

+Navigation +
- +Main +
- +User Documentation +
+
+Readers +
- +Overview +
+
+Default +
- +Resource Reader +
+
+Core +
- +Image Reader +
+
+Optional +
- +AxisRPC Reader +
- +Database Reader +
- +JSP Reader +
+
+Scratchpad +
- +Directory ZIP Archiver +
+

+ +

+ + + + + + + + + + + + + + + - - -

+ + +

+ + + + +

JSP Reader in Cocoon

+ PDF

+by Bernhard Huber +

+JSPReader +
+Description +
+Usage +
- +Sitemap pipeline examples +
- +Sitemap component configuration example +
- +Configuration +
- +Setup +
- +Effect on Object Model and Sitemap Parameters +
+
+Bugs/Caveats +
+History +
+Copyright +
+See also +

+ + +

JSPReader

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - -

NAME	jsp
WHAT	The JSPReader component is used to serve JSP page output data + in a sitemap pipeline. +
TYPE	Reader, Sitemap Component
BLOCK	Jsp
CLASS	org.apache.cocoon.reading.JSPReader
SINCE	Cocoon 2.0
CACHEABLE	yes

- - -

Description

- The JSPReader forwards requests to a JSP engine, and - passing the JSP response immediatly as is. -

- - -

Usage

- The JSPReader is useful iff you want to serve the JSP - response without any further Cocoon processing steps. -

- -

Sitemap pipeline examples

- The following sitemap snippet uses the JSPReader to feed - htm requests by JSP files. -

  -...
  -<map:match pattern="*.htm">
  -  <map:read type="jsp" src="{1}.jsp" mime-type="text/html" />
  -</map:match>
  -...
  -

- -

Sitemap component configuration example

  -<map:readers...
  -  <map:reader name="jsp" 
  -    src="org.apache.cocoon.reading.JSPReader"
  -    logger="sitemap.reader.jsp" 
  -  />
  -...
  -

- -

Configuration

- The JSP Reader has no configuration options. -

- -

Setup

- The JSP Reader has no setup options. -

- -

Effect on Object Model and Sitemap Parameters

- - -

Bugs/Caveats

- The JSP Reader depends on the accessibilty of a - JSP engine from within the Cocoon servlet. - A JSP must be properly configured for using the - JSP Reader. -

- - -

History

- 12-25-02: created initial version by Bernhard Huber -

- - -

Copyright

- - -

Description

+ The JSPReader forwards requests to a JSP engine, and + passing the JSP response immediatly as is. +

+ + +

Usage

+ The JSPReader is useful iff you want to serve the JSP + response without any further Cocoon processing steps. +

+ +

Sitemap pipeline examples

+ The following sitemap snippet uses the JSPReader to feed + htm requests by JSP files. +

  +...
  +<map:match pattern="*.htm">
  +  <map:read type="jsp" src="{1}.jsp" mime-type="text/html" />
  +</map:match>
  +...
  +

+ +

Sitemap component configuration example

  +<map:readers...
  +  <map:reader name="jsp" 
  +    src="org.apache.cocoon.reading.JSPReader"
  +    logger="sitemap.reader.jsp" 
  +  />
  +...
  +

+ +

Configuration

+ The JSP Reader has no configuration options. +

+ +

Setup

+ The JSP Reader has no setup options. +

+ +

Effect on Object Model and Sitemap Parameters

+ + +

Bugs/Caveats

+ The JSP Reader depends on the accessibilty of a + JSP engine from within the Cocoon servlet. + A JSP must be properly configured for using the + JSP Reader. +

+ + +

History

+ 12-25-02: created initial version by Bernhard Huber +

+ + +

Copyright

+ + +

Readers in Cocoon

- PDF

-by Carsten Ziegeler, Bernhard Huber -

-Goal -
-Overview -
-The Readers in Apache Cocoon -

- - - -

Goal

- This document lists all of the available readers of Apache Cocoon and - describes their purpose. -

- - -

Overview

- A reader is the starting, and end point of an xml pipeline. - It collapses the features of a generator, transformer, and serializer. - Readers are useful for delivering binary content like images; more - general readers deliver content as-is. -

- In the sitemap file, each reader has a unique name which is mapped - to a java class. - One reader name must be declared as the default reader. - Each reader may have additional configuration information specified in - child elements. -

- For conceptual information on readers see the user's guide document - The Sitemap. -

- - -

The Readers in Apache Cocoon

-Resource Reader (The default reader)
-Database Reader -
-JSP Reader -

- -

- - - - - - - - - - - - -


Copyright © - 1999-2003 The Apache Software Foundation. All rights reserved.

- - - + + + + +Readers in Cocoon + + + + + + + + + + + +

+ + + + + + + + + + + + + + + + + + +

+ +

+ + + + +

Home

+ +

+ + + + + + +

+ + + + + + + + + + + + +

+ + + + + + + + + + +

+ +

+Navigation +
- +Main +
- +User Documentation +
+
+Readers +
- +Overview +
+
+Default +
- +Resource Reader +
+
+Core +
- +Image Reader +
+
+Optional +
- +AxisRPC Reader +
- +Database Reader +
- +JSP Reader +
+
+Scratchpad +
- +Directory ZIP Archiver +
+

+ +

+ + + + + + + + + + + + + + + + + +

+ + +

+ + + + +

Readers in Cocoon

+ PDF

+by Carsten Ziegeler, Bernhard Huber +

+Goal +
+Overview +
+The Readers in Apache Cocoon +

+ + + +

Goal

+ This document lists all of the available readers of Apache Cocoon and + describes their purpose. +

+ + +

Overview

+ A reader is the starting, and end point of an xml pipeline. + It collapses the features of a generator, transformer, and serializer. + Readers are useful for delivering binary content like images; more + general readers deliver content as-is. +

+ In the sitemap file, each reader has a unique name which is mapped + to a java class. + One reader name must be declared as the default reader. + Each reader may have additional configuration information specified in + child elements. +

+ For conceptual information on readers see the user's guide document + The Sitemap. +

+ + +

The Readers in Apache Cocoon

+AxisRPC Reader (Optional: Axis block)
+Database Reader (Optional: Database block)
+Directory ZIP Archiver (Scratchpad)
+Image Reader +
+JSP Reader (Optional: JSP block)
+Resource Reader (The default reader)

+ +

+ + + + + + + + + + + + +


Copyright © + 1999-2003 The Apache Software Foundation. All rights reserved.

+ + + 1.2 +84 -140 cocoon-site/site/2.1/userdocs/readers/readers.pdf <> 1.5 +534 -538 cocoon-site/site/2.1/userdocs/readers/resource-reader.html Index: resource-reader.html =================================================================== RCS file: /home/cvs/cocoon-site/site/2.1/userdocs/readers/resource-reader.html,v retrieving revision 1.4 retrieving revision 1.5 diff -u -r1.4 -r1.5 --- resource-reader.html 21 May 2003 15:23:49 -0000 1.4 +++ resource-reader.html 11 Jul 2003 19:48:44 -0000 1.5 @@ -1,540 +1,536 @@ - - - - -ResourceReader in Cocoon - - - - - - - - - - - -

- - - - - - - - - - - - - - - - - - -

- -

- - - - -

Home

- -

- - - - - + + +

- - - - - - - - - - - - -

- - - - - - - - - - -

- -

-Navigation -
- -Main -
- -User Documentation -
-
-Readers -
- -Overview -
-
-Default -
- -Resource Reader -
-
-Core -
-
-Optional -
- -Database Reader -
- -JSP Reader -
-
-Scratchpad -
- -AxisRPC Reader -
- -Byte Range Resource Reader -
- -Directory ZIP Archiver -
- -Image Reader -
-

- -

- - - - - - - - - - - - - - - + + + + + + + + + + + +

- - -

- - - - -

ResourceReader in Cocoon

- PDF

-by Bernhard Huber -

-ResourceReader -
-Description -
-Usage -
- -Sitemap pipeline examples -
- -Sitemap component configuration example -
- -Configuration -
- -Setup -
- -Effect on Object Model and Sitemap Parameters -
-
-Bugs/Caveats -
-History -
-Copyright -
-See also -

- - -

ResourceReader

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + +ResourceReader in Cocoon + + + + +

NAME	resource
WHAT	The ResourceReader component is used - to serve binary data in a sitemap pipeline. -
TYPE	Reader, Sitemap Component
BLOCK	Core
CLASS	org.apache.cocoon.reading.ResourceReader

+ + + + + + +

+ + + + + + + + + + + + + + + + + + +

+ +

+ + + + +

Home

+ +

+ + + + + - -

+ + + + + + + + + + + + +

+ + + + + + + + + + +

+ +

+Navigation +
- +Main +
- +User Documentation +
+
+Readers +
- +Overview +
+
+Default +
- +Resource Reader +
+
+Core +
- +Image Reader +
+
+Optional +
- +AxisRPC Reader +
- +Database Reader +
- +JSP Reader +
+
+Scratchpad +
- +Directory ZIP Archiver +
+

+ +

+ + + + + + + + + + + + + + + - - -

+ + +

+ + + + +

ResourceReader in Cocoon

+ PDF

+by Bernhard Huber +

+ResourceReader +
+Description +
+Usage +
- +Sitemap pipeline examples +
- +Sitemap component configuration example +
- +Configuration +
- +Setup +
- +Effect on Object Model and Sitemap Parameters +
+
+Bugs/Caveats +
+History +
+Copyright +
+See also +

+ + +

ResourceReader

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - -

NAME	resource
WHAT	The ResourceReader component is used + to serve binary data in a sitemap pipeline. +
TYPE	Reader, Sitemap Component
BLOCK	Core
CLASS	org.apache.cocoon.reading.ResourceReader
SINCE	Cocoon 2.0
CACHEABLE	yes

- - -

Description

- The ResourceReader component is used to serve binary data - in a sitemap pipeline. -

- - -

Usage

- -

Sitemap pipeline examples

- The ResourceReader is used in a pipline as shown in the - pipeline snippet below: -

  -<map:match pattern="*.css">
  -  <map:read type="resource" 
  -    src="resources/styles/{1}.css" 
  -    mime-type="text/css">
  -    <!-- option sitemap parameters -->
  -    ...
  -  </map:read>
  -</map:match>
  -

- It is important to specify the mime-type attribute, - as it is passed to the browser as the Content-Type - in the HTTP response. -

- -

Sitemap component configuration example

- A ResourceReader is declared in the sitemap readers - section, as shown in the sitemap readers snippet below: -

  -<map:readers default="resource">
  -  <map:reader name="resource" 
  -    src="org.apache.cocoon.reading.ResourceReader" 
  -    logger="sitemap.reader.resource" 
  -    pool-max="32" pool-min="1" pool-grow="4"/>
  -    <!-- optional reader configuration -->
  -    ...
  -  </map:readers>
  -...
  -

- -

Configuration

- The ImageReader has no configuration options. -

- -

Setup

- The ResourceReader accepts following sitemap - setup parameters -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Parametername	Type	Comment
expires	Time in milliseconds	- This parameter is optional. When specified it determines how long - in miliseconds the resources can be cached by any proxy or browser - between Cocoon2 and the requesting visitor. -
quick-modified-test	boolean	- This parameter is optional. This boolean parameter controls the - last modified test. If set to true (default is false), only the - last modified of the current source is tested, but not if the - same source is used as last time. -
byte-ranges	boolean	- This parameter is optional. This boolean parameter enables or disables - support for the byte ranges. - By default this parameter is set to true. -
buffer-size	integer	- This parameter is optional. It specifies the buffer/block size when - reading from a resource. - By default this parameter is set to 8192. -

- The following ResourceReader declaration snippet - configures the default reader for having an expiration of - 1 day (ie. 24 * 60 * 60 * 1000 ms = 86400000 ms) -

  -<map:readers default="resource">
  -  <map:reader name="resource" 
  -    src="org.apache.cocoon.reading.ResourceReader" 
  -    logger="sitemap.reader.resource" 
  -    pool-max="32" pool-min="1" pool-grow="4"/>
  -    <!-- optional reader configuration -->
  -    <map:parameter name="expires" value="86400000"/>
  -  </map:readers>
  -...
  -

- -

Effect on Object Model and Sitemap Parameters

- The ResourceReader does not change object model and sitemap parameters. - It only access values for reading. -

- - -

Bugs/Caveats

- - -

History

- 12-25-02: Initial document creation by Bernhard Huber -
- 01-06-03: Added new parameters and byte range support, Torsten Curdt -

- - -

Copyright

- - -

Description

+ The ResourceReader component is used to serve binary data + in a sitemap pipeline. +

+ + +

Usage

+ +

Sitemap pipeline examples

+ The ResourceReader is used in a pipline as shown in the + pipeline snippet below: +

  +<map:match pattern="*.css">
  +  <map:read type="resource" 
  +    src="resources/styles/{1}.css" 
  +    mime-type="text/css">
  +    <!-- option sitemap parameters -->
  +    ...
  +  </map:read>
  +</map:match>
  +

+ It is important to specify the mime-type attribute, + as it is passed to the browser as the Content-Type + in the HTTP response. +

+ +

Sitemap component configuration example

+ A ResourceReader is declared in the sitemap readers + section, as shown in the sitemap readers snippet below: +

  +<map:readers default="resource">
  +  <map:reader name="resource" 
  +    src="org.apache.cocoon.reading.ResourceReader" 
  +    logger="sitemap.reader.resource" 
  +    pool-max="32" pool-min="1" pool-grow="4"/>
  +    <!-- optional reader configuration -->
  +    ...
  +  </map:readers>
  +...
  +

+ +

Configuration

+ The ImageReader has no configuration options. +

+ +

Setup

+ The ResourceReader accepts following sitemap + setup parameters +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parametername	Type	Comment
expires	Time in milliseconds	+ This parameter is optional. When specified it determines how long + in miliseconds the resources can be cached by any proxy or browser + between Cocoon2 and the requesting visitor. +
quick-modified-test	boolean	+ This parameter is optional. This boolean parameter controls the + last modified test. If set to true (default is false), only the + last modified of the current source is tested, but not if the + same source is used as last time. +
byte-ranges	boolean	+ This parameter is optional. This boolean parameter enables or disables + support for the byte ranges. + By default this parameter is set to true. +
buffer-size	integer	+ This parameter is optional. It specifies the buffer/block size when + reading from a resource. + By default this parameter is set to 8192. +

+ The following ResourceReader declaration snippet + configures the default reader for having an expiration of + 1 day (ie. 24 * 60 * 60 * 1000 ms = 86400000 ms) +

  +<map:readers default="resource">
  +  <map:reader name="resource" 
  +    src="org.apache.cocoon.reading.ResourceReader" 
  +    logger="sitemap.reader.resource" 
  +    pool-max="32" pool-min="1" pool-grow="4"/>
  +    <!-- optional reader configuration -->
  +    <map:parameter name="expires" value="86400000"/>
  +  </map:readers>
  +...
  +

+ +

Effect on Object Model and Sitemap Parameters

+ The ResourceReader does not change object model and sitemap parameters. + It only access values for reading. +

+ + +

Bugs/Caveats

+ + +

History

+ 12-25-02: Initial document creation by Bernhard Huber +
+ 01-06-03: Added new parameters and byte range support, Torsten Curdt +

+ + +

Copyright

+ + +

Axis RPC Reader in Cocoon

AxisRPCReader

Axis RPC Reader in Cocoon

AxisRPCReader

Description

Usage

Sitemap pipeline examples

Sitemap component configuration example

Configuration

Setup

Effect on Object Model and Sitemap Parameters

Bugs/Caveats

History

Copyright

See also

Description

Usage

Sitemap pipeline examples

Sitemap component configuration example

Configuration

Setup

Effect on Object Model and Sitemap Parameters

Bugs/Caveats

History

Copyright

See also

DatabaseReader

DatabaseReader

DatabaseReader

DatabaseReader

Description

Usage

Sitemap pipeline examples

Sitemap component configuration example

Configuration

Setup

Effect on Object Model and Sitemap Parameters

Bugs/Caveats

History

Copyright

See also

Description

Usage

Sitemap pipeline examples

Sitemap component configuration example

Configuration

Setup

Effect on Object Model and Sitemap Parameters

Bugs/Caveats

History

Copyright

See also

DirectoryZipArchiver

DirectoryZipArchiver

DirectoryZipArchiver

DirectoryZipArchiver

Description

Usage

Sitemap pipeline examples

Sitemap component configuration example

Configuration

Setup

Effect on Object Model and Sitemap Parameters

Bugs/Caveats

History

Copyright

See also

Description

Usage

Sitemap pipeline examples

Sitemap component configuration example

Configuration

Setup

Effect on Object Model and Sitemap Parameters

Bugs/Caveats

History

Copyright

See also

ImageReader in Cocoon

ImageReader