blob: ff44f83baf268974a287a6f9cbadefe7c5cfc056 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>JSP Reader in Cocoon</title>
<link href="http://purl.org/DC/elements/1.0/" rel="schema.DC">
<meta content="Bernhard Huber" name="DC.Creator">
<meta content="This document describes the JSP Reader of Cocoon." name="DC.Description">
</head>
<body>
<h1>JSPReader</h1>
<table>
<tr>
<td colspan="1" rowspan="1">NAME</td><td colspan="1" rowspan="1">jsp</td>
</tr>
<tr>
<td colspan="1" rowspan="1">WHAT</td><td colspan="1" rowspan="1">The <span class="codefrag">JSPReader</span> component is used to serve JSP page output data
in a sitemap pipeline.
</td>
</tr>
<tr>
<td colspan="1" rowspan="1">TYPE</td><td colspan="1" rowspan="1">Reader, Sitemap Component</td>
</tr>
<tr>
<td colspan="1" rowspan="1">BLOCK</td><td colspan="1" rowspan="1">Jsp</td>
</tr>
<tr>
<td colspan="1" rowspan="1">CLASS</td><td colspan="1" rowspan="1">org.apache.cocoon.reading.JSPReader</td>
</tr>
<!--tr>
<td>DEPRECATED</td><td>Cocoon 2.0, 2.1</td>
</tr-->
<tr>
<td colspan="1" rowspan="1">SINCE</td><td colspan="1" rowspan="1">Cocoon 2.0</td>
</tr>
<tr>
<td colspan="1" rowspan="1">CACHEABLE</td><td colspan="1" rowspan="1">no</td>
</tr>
</table>
<h1>Description</h1>
<p>
The <span class="codefrag">JSPReader</span> forwards requests to a <em>JSP</em> engine, and
passing the <em>JSP</em> response immediatly as is.
</p>
<h1>Usage</h1>
<p>
The <span class="codefrag">JSPReader</span> is useful iff you want to serve the <em>JSP</em>
response without any further Cocoon processing steps.
</p>
<h2>Sitemap pipeline examples</h2>
<p>
The following sitemap snippet uses the <span class="codefrag">JSPReader</span> to feed
<span class="codefrag">htm</span> requests by <em>JSP</em> files.
</p>
<pre class="code">
...
&lt;map:match pattern="*.htm"&gt;
&lt;map:read type="jsp" src="{1}.jsp" mime-type="text/html" /&gt;
&lt;/map:match&gt;
...
</pre>
<h2>Sitemap component configuration example</h2>
<p></p>
<pre class="code">
&lt;map:readers...
&lt;map:reader name="jsp"
src="org.apache.cocoon.reading.JSPReader"
logger="sitemap.reader.jsp"
/&gt;
...
</pre>
<h2>Configuration</h2>
<p>
The <span class="codefrag">JSP Reader</span> has no configuration options.
</p>
<h2>Setup</h2>
<p>
The <span class="codefrag">JSP Reader</span> has no setup options.
</p>
<h2>Effect on Object Model and Sitemap Parameters</h2>
<p>
</p>
<h1>Bugs/Caveats</h1>
<p>
The <span class="codefrag">JSP Reader</span> depends on the accessibilty of a
<span class="codefrag">JSP</span> engine from within the Cocoon servlet.
A <em>JSP</em> must be properly configured for using the
<span class="codefrag">JSP Reader</span>.
</p>
<h1>History</h1>
<p>
12-25-02: created initial version by Bernhard Huber
</p>
<h1>See also</h1>
<p>
Feeding <em>JSP</em> and passing the content into further Cocoon processing
the <em>JSPGenerator</em> is appropriate for this task.
</p>
<p>
Moreover setting up a preprocessing <em>Servlet Filter</em> would be the most
general solution to feeding <em>JSP</em> content.
</p>
<!-- Links to related components pages -->
</body>
</html>