You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@cocoon.apache.org by vg...@apache.org on 2001/07/22 22:16:06 UTC
cvs commit: xml-cocoon2/xdocs request.xml
vgritsenko 01/07/22 13:16:06
Modified: xdocs request.xml
Log:
xsp-request doc patch from Ignacio J. Ortega [nacho@siapi.es]
Revision Changes Path
1.5 +57 -57 xml-cocoon2/xdocs/request.xml
Index: request.xml
===================================================================
RCS file: /home/cvs/xml-cocoon2/xdocs/request.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- request.xml 2001/07/19 14:20:23 1.4
+++ request.xml 2001/07/22 20:16:06 1.5
@@ -26,7 +26,7 @@
such as the request method (GET, POST, etc.), what protocol is in use (http, https),
cookie information, preferred locale, and so forth. The Request logicsheet is
probably used mostly, however, for obtaining field values from a submitted HTML form.
-See request:get-parameter below for more information on this topic.</p>
+See xsp-request:get-parameter below for more information on this topic.</p>
</s1>
@@ -36,14 +36,14 @@
It may be helpful to be familiar with <link href="xsp.html">XSP</link> before
working with this (or any) logicsheet.</p>
-<p>To use the Request logicsheet, you must first declare the <em>request</em>
-namespace, mapping it to the uri <em>http://www.apache.org/1999/XSP/Request</em>.
+<p>To use the Request logicsheet, you must first declare the <em>xsp-request</em>
+namespace, mapping it to the uri <em>http://apache.org/xsp/request/2.0</em>.
This is typically done like this:</p>
<source><![CDATA[
<xsp:page
xmlns:xsp="http://apache.org/xsp"
- xmlns:request="http://apache.org/xsp/request/2.0"
+ xmlns:xsp-request="http://apache.org/xsp/request/2.0"
>
...
</xsp:page>
@@ -69,12 +69,12 @@
<xsp:page
xmlns:xsp="http://apache.org/xsp"
- xmlns:request="http://apache.org/xsp/request/2.0"
+ xmlns:xsp-request="http://apache.org/xsp/request/2.0"
>
<html>
- <b>Request method:</b> <request:get-method/>
+ <b>Request method:</b> <xsp-request:get-method/>
<br/>
- <b>Fruit requested:</b> <request:get-parameter name="fruit"/>
+ <b>Fruit requested:</b> <xsp-request:get-parameter name="fruit"/>
</html>
</xsp:page>
]]></source>
@@ -103,10 +103,10 @@
<![CDATA[
<xsp:page
xmlns:xsp="http://apache.org/xsp"
- xmlns:request="http://apache.org/xsp/request/2.0"
+ xmlns:xsp-request="http://apache.org/xsp/request/2.0"
>
<page>
- <fruit><request:get-parameter name="fruit"/></fruit>
+ <fruit><xsp-request:get-parameter name="fruit"/></fruit>
</page>
</xsp:page>
]]></source>
@@ -129,7 +129,7 @@
<source><![CDATA[
<xsp:logic>
- String fruit = <request:get-parameter name="fruit"/>;
+ String fruit = <xsp-request:get-parameter name="fruit"/>;
if (fruit != null) {
fruit = fruit.toUpperCase();
}
@@ -150,11 +150,11 @@
<p>The following fragments are equivalent:</p>
<source><![CDATA[
-<request:get-parameter name="fruit"/>
+<xsp-request:get-parameter name="fruit"/>
]]></source>
<source><![CDATA[
-<request:get-parameter><name>fruit</name></request:get-parameter>
+<xsp-request:get-parameter><name>fruit</name></xsp-request:get-parameter>
]]></source>
<p>All Request elements which get data from the request can output the data
@@ -169,17 +169,17 @@
the following code fragment:</p>
<source><![CDATA[
-<request:get-parameter as="xml" name="fruit"/>
+<xsp-request:get-parameter as="xml" name="fruit"/>
]]></source>
<p>results in output similar to:</p>
<source><![CDATA[
-<request:parameter name="fruit">apple</request:parameter>
+<xsp-request:parameter name="fruit">apple</xsp-request:parameter>
]]></source>
<p>This is especially useful with elements that return multiple pieces of
-information, such as <code>request:get-parameter-values</code>. Without using
+information, such as <code>xsp-request:get-parameter-values</code>. Without using
<code>as="node"</code>, the returned values are written out end to end
without separation. If node output is requested, however, each value
is written out in a separate node, which may then be referenced separately.</p>
@@ -207,22 +207,22 @@
</tr>
<tr>
-<td>request:get-attribute</td>
+<td>xsp-request:get-attribute</td>
<td>name</td>
<td>yes</td>
<td>Gets a named attribute set by the servlet container or by a previous
-request:set-attribute operation.</td>
+xsp-request:set-attribute operation.</td>
</tr>
<tr>
-<td>request:get-attribute-names</td>
+<td>xsp-request:get-attribute-names</td>
<td></td>
<td>yes</td>
<td>Gets the names of all available request attributes.</td>
</tr>
<tr>
-<td>request:get-auth-type</td>
+<td>xsp-request:get-auth-type</td>
<td></td>
<td>yes</td>
<td>Gets the name of the authentication scheme used to protect this request
@@ -230,42 +230,42 @@
</tr>
<tr>
-<td>request:get-character-encoding</td>
+<td>xsp-request:get-character-encoding</td>
<td></td>
<td>yes</td>
<td>Gets the name of the character encoding used in the body of this request.</td>
</tr>
<tr>
-<td>request:get-content-length</td>
+<td>xsp-request:get-content-length</td>
<td></td>
<td>yes</td>
<td>Gets the length, in bytes, of the request body, or -1 if the length is unknown.</td>
</tr>
<tr>
-<td>request:get-content-type</td>
+<td>xsp-request:get-content-type</td>
<td></td>
<td>yes</td>
<td>Gets the MIME type of the body of the request.</td>
</tr>
<tr>
-<td>request:get-context-path</td>
+<td>xsp-request:get-context-path</td>
<td></td>
<td>yes</td>
<td>Gets the portion of the request URI that indicates the context of the request.</td>
</tr>
<tr>
-<td>request:get-cookies</td>
+<td>xsp-request:get-cookies</td>
<td></td>
<td>yes</td>
<td>Gets all cookie objects supplied by the client with this request.</td>
</tr>
<tr>
-<td>request:get-date-header</td>
+<td>xsp-request:get-date-header</td>
<td>name, format <em>(optional)</em></td>
<td>yes</td>
<td>Gets the value of the named request header that represents a date. Use this
@@ -279,28 +279,28 @@
</tr>
<tr>
-<td>request:get-header</td>
+<td>xsp-request:get-header</td>
<td>name</td>
<td>yes</td>
<td>Gets the string value of the named request header.</td>
</tr>
<tr>
-<td>request:get-headers</td>
+<td>xsp-request:get-headers</td>
<td>name</td>
<td>yes</td>
<td>Gets all values of the named request header.</td>
</tr>
<tr>
-<td>request:get-header-names</td>
+<td>xsp-request:get-header-names</td>
<td></td>
<td>yes</td>
<td>Gets the names of all available request headers.</td>
</tr>
<tr>
-<td>request:get-int-header</td>
+<td>xsp-request:get-int-header</td>
<td>name</td>
<td>yes</td>
<td>Gets the value of the named request header which represents an integer,
@@ -309,7 +309,7 @@
</tr>
<tr>
-<td>request:get-locale</td>
+<td>xsp-request:get-locale</td>
<td></td>
<td>yes</td>
<td>Gets the preferred locale for the client browser, or the default
@@ -317,52 +317,52 @@
</tr>
<tr>
-<td>request:get-locales</td>
+<td>xsp-request:get-locales</td>
<td></td>
<td>yes</td>
<td>Gets the locales accepted by the client in order of preference.</td>
</tr>
<tr>
-<td>request:get-method</td>
+<td>xsp-request:get-method</td>
<td></td>
<td>yes</td>
<td>Gets the name of the method associated with this request, e.g., GET, POST, or PUT.</td>
</tr>
<tr>
-<td>request:get-parameter</td>
+<td>xsp-request:get-parameter</td>
<td>name</td>
<td>yes</td>
<td>Gets the value of the named request parameter. This is a value from
the request string (e.g., ?fruit=apple) or from POSTed form data. If the parameter
has more than one value, (e.g, ?fruit=apple&fruit=orange), then this gets the first
-value. See request:get-parameter-values.</td>
+value. See xsp-request:get-parameter-values.</td>
</tr>
<tr>
-<td>request:get-parameter-names</td>
+<td>xsp-request:get-parameter-names</td>
<td></td>
<td>yes</td>
<td>Gets the names of all the request parameters.</td>
</tr>
<tr>
-<td>request:get-parameter-values</td>
+<td>xsp-request:get-parameter-values</td>
<td>name</td>
<td>yes</td>
<td>Gets all values for the named request parameter.</td>
</tr>
<tr>
-<td>request:get-path-info</td>
+<td>xsp-request:get-path-info</td>
<td></td>
<td>yes</td>
<td>Gets any additional path information supplied by the client with this request.</td>
</tr>
<tr>
-<td>request:get-path-translated</td>
+<td>xsp-request:get-path-translated</td>
<td></td>
<td>yes</td>
<td>Gets any additional path information after the servlet name but before the query string,
@@ -370,28 +370,28 @@
</tr>
<tr>
-<td>request:get-protocol</td>
+<td>xsp-request:get-protocol</td>
<td></td>
<td>yes</td>
<td>Gets the name and version of the protocol the request uses, for example, HTTP/1.1.</td>
</tr>
<tr>
-<td>request:get-query-string</td>
+<td>xsp-request:get-query-string</td>
<td></td>
<td>yes</td>
<td>Gets the query string for this request (e.g., "?fruit=apple&bread=rye").</td>
</tr>
<tr>
-<td>request:get-remote-addr</td>
+<td>xsp-request:get-remote-addr</td>
<td></td>
<td>yes</td>
<td>Gets the IP address of the requesting client.</td>
</tr>
<tr>
-<td>request:get-remote-host</td>
+<td>xsp-request:get-remote-host</td>
<td></td>
<td>yes</td>
<td>Gets the fully-qualified name of the requesting client, or the IP address
@@ -399,7 +399,7 @@
</tr>
<tr>
-<td>request:get-remote-user</td>
+<td>xsp-request:get-remote-user</td>
<td></td>
<td>yes</td>
<td>Gets the login name of the user making the request, if a user has been
@@ -407,14 +407,14 @@
</tr>
<tr>
-<td>request:get-requested-session-id</td>
+<td>xsp-request:get-requested-session-id</td>
<td></td>
<td>yes</td>
<td>Gets the session id contained in the request.</td>
</tr>
<tr>
-<td>request:get-request-uri</td>
+<td>xsp-request:get-request-uri</td>
<td></td>
<td>yes</td>
<td>Gets the part of the request URL from the protocol name up to the
@@ -422,35 +422,35 @@
</tr>
<tr>
-<td>request:get-scheme</td>
+<td>xsp-request:get-scheme</td>
<td></td>
<td>yes</td>
<td>Gets the name of the scheme used in this request, e.g., http or https.</td>
</tr>
<tr>
-<td>request:get-server-name</td>
+<td>xsp-request:get-server-name</td>
<td></td>
<td>yes</td>
<td>Gets the name of the server that received the request.</td>
</tr>
<tr>
-<td>request:get-server-port</td>
+<td>xsp-request:get-server-port</td>
<td></td>
<td>yes</td>
<td>Gets the port on which the request was received, e.g., 80 or 443.</td>
</tr>
<tr>
-<td>request:get-servlet-path</td>
+<td>xsp-request:get-servlet-path</td>
<td></td>
<td>yes</td>
<td>Gets the part of the request URL that calls the servlet.</td>
</tr>
<tr>
-<td>request:get-user-principal</td>
+<td>xsp-request:get-user-principal</td>
<td></td>
<td>yes</td>
<td>Gets a java.security.Principal object containing the name of the user,
@@ -458,14 +458,14 @@
</tr>
<tr>
-<td>request:is-requested-session-id-from-cookie</td>
+<td>xsp-request:is-requested-session-id-from-cookie</td>
<td></td>
<td>yes</td>
<td>Indicates whether the requested session id was provided in a cookie.</td>
</tr>
<tr>
-<td>request:is-requested-session-id-from-url</td>
+<td>xsp-request:is-requested-session-id-from-url</td>
<td></td>
<td>yes</td>
<td>Indicates whether the requested session id was provided as part of the
@@ -473,35 +473,35 @@
</tr>
<tr>
-<td>request:is-requested-session-id-valid</td>
+<td>xsp-request:is-requested-session-id-valid</td>
<td></td>
<td>yes</td>
<td>Indicates whether the requested session id is still valid.</td>
</tr>
<tr>
-<td>request:is-secure</td>
+<td>xsp-request:is-secure</td>
<td></td>
<td>yes</td>
<td>Indicates whether the request was made using a secure protocol such as HTTPS.</td>
</tr>
<tr>
-<td>request:is-user-in-role</td>
+<td>xsp-request:is-user-in-role</td>
<td>role</td>
<td>yes</td>
<td>Indicates whether the authenticated user is a member in the named role.</td>
</tr>
<tr>
-<td>request:remove-attribute</td>
+<td>xsp-request:remove-attribute</td>
<td>name</td>
<td>no</td>
<td>Removes the named attribute from the request.</td>
</tr>
<tr>
-<td>request:set-attribute</td>
+<td>xsp-request:set-attribute</td>
<td>name</td>
<td>no</td>
<td>Sets the named attribute to the value represented by any children of the element.
----------------------------------------------------------------------
In case of troubles, e-mail: webmaster@xml.apache.org
To unsubscribe, e-mail: cocoon-cvs-unsubscribe@xml.apache.org
For additional commands, e-mail: cocoon-cvs-help@xml.apache.org