Return-Path: Delivered-To: apmail-xml-cocoon-cvs-archive@xml.apache.org Received: (qmail 51177 invoked by uid 500); 22 Jul 2001 20:18:17 -0000 Mailing-List: contact cocoon-cvs-help@xml.apache.org; run by ezmlm Precedence: bulk Reply-To: cocoon-dev@xml.apache.org list-help: list-unsubscribe: list-post: Delivered-To: mailing list cocoon-cvs@xml.apache.org Received: (qmail 51168 invoked by uid 500); 22 Jul 2001 20:18:17 -0000 Delivered-To: apmail-xml-cocoon2-cvs@apache.org Date: 22 Jul 2001 20:16:06 -0000 Message-ID: <20010722201606.62857.qmail@icarus.apache.org> From: vgritsenko@apache.org To: xml-cocoon2-cvs@apache.org Subject: cvs commit: xml-cocoon2/xdocs request.xml X-Spam-Rating: h31.sny.collab.net 1.6.2 0/1000/N 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.

+See xsp-request:get-parameter below for more information on this topic.

@@ -36,14 +36,14 @@ It may be helpful to be familiar with XSP before working with this (or any) logicsheet.

To use the Request logicsheet, you must first declare the request -namespace, mapping it to the uri http://www.apache.org/1999/XSP/Request. +

To use the Request logicsheet, you must first declare the xsp-request +namespace, mapping it to the uri http://apache.org/xsp/request/2.0. This is typically done like this:

... @@ -69,12 +69,12 @@ - Request method:

+ Request method:

- Fruit requested:

+ Fruit requested:

]]> @@ -103,10 +103,10 @@ -

]]> @@ -129,7 +129,7 @@ - String fruit = ; + String fruit = ; if (fruit != null) { fruit = fruit.toUpperCase(); } @@ -150,11 +150,11 @@

The following fragments are equivalent:

+ ]]> fruit +fruit ]]>

All Request elements which get data from the request can output the data @@ -169,17 +169,17 @@ the following code fragment:

+ ]]>

results in output similar to:

apple +apple ]]>

This is especially useful with elements that return multiple pieces of -information, such as request:get-parameter-values. Without using +information, such as xsp-request:get-parameter-values. Without using as="node", 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.

@@ -207,22 +207,22 @@ -request:get-attribute +xsp-request:get-attribute name yes Gets a named attribute set by the servlet container or by a previous -request:set-attribute operation. +xsp-request:set-attribute operation. -request:get-attribute-names +xsp-request:get-attribute-names yes Gets the names of all available request attributes. -request:get-auth-type +xsp-request:get-auth-type yes Gets the name of the authentication scheme used to protect this request @@ -230,42 +230,42 @@ -request:get-character-encoding +xsp-request:get-character-encoding yes Gets the name of the character encoding used in the body of this request. -request:get-content-length +xsp-request:get-content-length yes Gets the length, in bytes, of the request body, or -1 if the length is unknown. -request:get-content-type +xsp-request:get-content-type yes Gets the MIME type of the body of the request. -request:get-context-path +xsp-request:get-context-path yes Gets the portion of the request URI that indicates the context of the request. -request:get-cookies +xsp-request:get-cookies yes Gets all cookie objects supplied by the client with this request. -request:get-date-header +xsp-request:get-date-header name, format (optional) yes Gets the value of the named request header that represents a date. Use this @@ -279,28 +279,28 @@ -request:get-header +xsp-request:get-header name yes Gets the string value of the named request header. -request:get-headers +xsp-request:get-headers name yes Gets all values of the named request header. -request:get-header-names +xsp-request:get-header-names yes Gets the names of all available request headers. -request:get-int-header +xsp-request:get-int-header name yes Gets the value of the named request header which represents an integer, @@ -309,7 +309,7 @@ -request:get-locale +xsp-request:get-locale yes Gets the preferred locale for the client browser, or the default @@ -317,52 +317,52 @@ -request:get-locales +xsp-request:get-locales yes Gets the locales accepted by the client in order of preference. -request:get-method +xsp-request:get-method yes Gets the name of the method associated with this request, e.g., GET, POST, or PUT. -request:get-parameter +xsp-request:get-parameter name yes 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. +value. See xsp-request:get-parameter-values. -request:get-parameter-names +xsp-request:get-parameter-names yes Gets the names of all the request parameters. -request:get-parameter-values +xsp-request:get-parameter-values name yes Gets all values for the named request parameter. -request:get-path-info +xsp-request:get-path-info yes Gets any additional path information supplied by the client with this request. -request:get-path-translated +xsp-request:get-path-translated yes Gets any additional path information after the servlet name but before the query string, @@ -370,28 +370,28 @@ -request:get-protocol +xsp-request:get-protocol yes Gets the name and version of the protocol the request uses, for example, HTTP/1.1. -request:get-query-string +xsp-request:get-query-string yes Gets the query string for this request (e.g., "?fruit=apple&bread=rye"). -request:get-remote-addr +xsp-request:get-remote-addr yes Gets the IP address of the requesting client. -request:get-remote-host +xsp-request:get-remote-host yes Gets the fully-qualified name of the requesting client, or the IP address @@ -399,7 +399,7 @@ -request:get-remote-user +xsp-request:get-remote-user yes Gets the login name of the user making the request, if a user has been @@ -407,14 +407,14 @@ -request:get-requested-session-id +xsp-request:get-requested-session-id yes Gets the session id contained in the request. -request:get-request-uri +xsp-request:get-request-uri yes Gets the part of the request URL from the protocol name up to the @@ -422,35 +422,35 @@ -request:get-scheme +xsp-request:get-scheme yes Gets the name of the scheme used in this request, e.g., http or https. -request:get-server-name +xsp-request:get-server-name yes Gets the name of the server that received the request. -request:get-server-port +xsp-request:get-server-port yes Gets the port on which the request was received, e.g., 80 or 443. -request:get-servlet-path +xsp-request:get-servlet-path yes Gets the part of the request URL that calls the servlet. -request:get-user-principal +xsp-request:get-user-principal yes Gets a java.security.Principal object containing the name of the user, @@ -458,14 +458,14 @@ -request:is-requested-session-id-from-cookie +xsp-request:is-requested-session-id-from-cookie yes Indicates whether the requested session id was provided in a cookie. -request:is-requested-session-id-from-url +xsp-request:is-requested-session-id-from-url yes Indicates whether the requested session id was provided as part of the @@ -473,35 +473,35 @@ -request:is-requested-session-id-valid +xsp-request:is-requested-session-id-valid yes Indicates whether the requested session id is still valid. -request:is-secure +xsp-request:is-secure yes Indicates whether the request was made using a secure protocol such as HTTPS. -request:is-user-in-role +xsp-request:is-user-in-role role yes Indicates whether the authenticated user is a member in the named role. -request:remove-attribute +xsp-request:remove-attribute name no Removes the named attribute from the request. -request:set-attribute +xsp-request:set-attribute name no 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