cocoon-docs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From d...@cocoon.apache.org
Subject [Cocoon Wiki] Updated: InputModules
Date Sat, 10 Jul 2004 07:26:26 GMT
   Date: 2004-07-10T00:26:26
   Editor: StephanNiedermeier <s.niedermeier@logabit.com>
   Wiki: Cocoon Wiki
   Page: InputModules
   URL: http://wiki.apache.org/cocoon/InputModules

   no comment

Change Log:

------------------------------------------------------------------------------
@@ -3,7 +3,7 @@
 - DOCUMENT-STATUS: '''*draft*''' reviewed released[[BR]]
 ----
 
-Basic information about the !InputModules availabe in Cocoon 2.0.4. Descriptions are taken
from comments in the source code of each file. Provided here as a quick reference for new
Cocoon users/developers. -- BenjaminYoung
+Basic information about the !InputModules availabe in Cocoon 2.0.4. Descriptions are taken
from comments in the source code of each file (see also http://cocoon.apache.org/2.1/apidocs/org/apache/cocoon/components/modules/input/package-summary.html).
Provided here as a quick reference for new Cocoon users/developers. -- BenjaminYoung
 
 Where noted, a given module extends ''AbstractJX!PathModule'', which means that you can use
XPath expressions to access objects and their members/fields. 
 
@@ -31,6 +31,7 @@
 {{{<package name="java.util" prefix="util"/>}}}
  * Imports all classes in the package "java.util" as extension classes to the JX!PathContext
using the prefix "util". Thus "util:Date.new()" would create a new java.util.Date object.
 
+
 ----
 = AbstractMetaModule =
 
@@ -48,9 +49,10 @@
 
 {{{member}}}
  * Collection member:
-||'''Attribute'''||||Description
-||{{{name}}}||Parameter name, "*" may distinguish multiple collections
-||{{{type}}}||JDBC type name of members
+
+||Attribute||Description||
+||{{{name}}}||Parameter name, "*" may distinguish multiple collections||
+||{{{type}}}||JDBC type name of members||
 
 ----
 = DateInputModule =
@@ -106,8 +108,8 @@
   name="random"/>
 }}}
 
-||'''Accessor'''||||Description
-||(anything)||The random number
+||'''Accessor'''||Description||
+||(anything)||The random number||
 
 ----
 
@@ -141,43 +143,44 @@
 = RequestModule  (JXPath) =
 This module allows access to various useful properties of the request object (cookies, remoteAddr,
remoteUser, etc).
 
-This list may not be complete, see the Cocoon request API docs for all of the getXXX methods.
+This list may not be complete, see the Cocoon request API [http://cocoon.apache.org/2.1/apidocs/org/apache/cocoon/environment/http/HttpRequest.html
docs] for all of the getXXX methods.
+
 
-||'''Accessor'''||||Description
-||{{{attributeNames}}}                    || Returns an Enumeration containing the names
of the attributes available to this request.
-||{{{authType}}}                          || Returns the name of the authentication scheme
used to protect the servlet, for example, "BASIC" or "SSL," or null if the servlet was not
protected
-||{{{characterEncoding}}}                 || Returns the name of the character encoding used
in the body of this request.
-||{{{contentLength}}}                     || Returns the length, in bytes, of the request
body
-||{{{contentType}}}                       || Returns the MIME type of the body of the request
-||{{{contextPath}}}                       || Returns the portion of the request URI that
indicates the context of the request.
-||{{{cookieMap}}}                         || Returns a map of the Cookie objects the client
sent with this request, indexed by name.
-||{{{cookies}}}                           || Returns an array containing all of the Cookie
 objects the client sent with this request.
-||{{{headerNames}}}                       || Returns an enumeration of all the header names
this request contains.
-||{{{headers}}}                           || Returns all the values of the specified request
header as an Enumeration of String objects.
-||{{{locale}}}                            || Returns the preferred Locale that the client
will accept content in, based on the Accept-Language header.
-||{{{locales}}}                           || Returns an Enumeration of Locale objects indicating,
in decreasing order starting with the preferred locale, the locales that are acceptable to
the client based on the Accept-Language header.
-||{{{method}}}                            || Returns the name of the HTTP method with which
this request was made, for example, GET, POST, or PUT.
-||{{{parameterNames}}}                    || Returns an Enumeration of String  objects containing
the names of the parameters contained in this request.
-||{{{pathInfo}}}                          || Returns any extra path information associated
with the URL the client sent when it made this request.
-||{{{pathTranslated}}}                    || Returns any extra path information after the
servlet name but before the query string, and translates it to a real path.
-||{{{protocol}}}                          || Returns the name and version of the protocol
the request uses in the form protocol/majorVersion.minorVersion, for example, HTTP/1.1.
-||{{{queryString}}}                       || Returns the query string that is contained in
the request URL after the path.
-||{{{remoteAddr}}}                        || Returns the Internet Protocol (IP) address of
the client that sent the request.
-||{{{remoteHost}}}                        || Returns the fully qualified name of the client
that sent the request, or the IP address of the client if the name cannot be determined.
-||{{{remoteUser}}}                        || Returns the login of the user making this request,
if the user has been authenticated, or null if the user has not been authenticated.
-||{{{requestedSessionId}}}                || Returns the session ID specified by the client.
-||{{{requestedSessionIdFromCookie}}}      ||
-||{{{requestedSessionIdFromURL}}}         ||
-||{{{requestedSessionIdValid}}}           ||
-||{{{requestURI}}}                        || Returns the part of this request's URL from
the protocol name up to the query string in the first line of the HTTP request.
-||{{{scheme}}}                            || Returns the name of the scheme used to make
this request, for example, http, https, or ftp.
-||{{{secure}}}                            || Returns a boolean indicating whether this request
was made using a secure channel, such as HTTPS.
-||{{{serverName}}}                        || Returns the host name of the server that received
the request
-||{{{serverPort}}}                        || Returns the port number on which this request
was received.
-||{{{servletPath}}}                       || Returns the part of this request's URL that
calls the servlet.
-||{{{session}}}                           || Returns the current session associated with
this request, or if the request does not have a session, creates one.
-||{{{sitemapURI}}}                        || Returns the URI of the requested resource as
interpreted by the sitemap.
-||{{{userPrincipal}}}                     || Returns the login of the user making this request,
if the user has been authenticated, or null if the user has not been authenticated.
+||'''Accessor'''||||Description||
+||{{{attributeNames}}}                    || Returns an Enumeration containing the names
of the attributes available to this request.||
+||{{{authType}}}                          || Returns the name of the authentication scheme
used to protect the servlet, for example, "BASIC" or "SSL," or null if the servlet was not
protected||
+||{{{characterEncoding}}}                 || Returns the name of the character encoding used
in the body of this request.||
+||{{{contentLength}}}                     || Returns the length, in bytes, of the request
body||
+||{{{contentType}}}                       || Returns the MIME type of the body of the request||
+||{{{contextPath}}}                       || Returns the portion of the request URI that
indicates the context of the request.||
+||{{{cookieMap}}}                         || Returns a map of the Cookie objects the client
sent with this request, indexed by name.||
+||{{{cookies}}}                           || Returns an array containing all of the Cookie
 objects the client sent with this request.||
+||{{{headerNames}}}                       || Returns an enumeration of all the header names
this request contains.||
+||{{{headers}}}                           || Returns all the values of the specified request
header as an Enumeration of String objects.||
+||{{{locale}}}                            || Returns the preferred Locale that the client
will accept content in, based on the Accept-Language header.||
+||{{{locales}}}                           || Returns an Enumeration of Locale objects indicating,
in decreasing order starting with the preferred locale, the locales that are acceptable to
the client based on the Accept-Language header.||
+||{{{method}}}                            || Returns the name of the HTTP method with which
this request was made, for example, GET, POST, or PUT.||
+||{{{parameterNames}}}                    || Returns an Enumeration of String  objects containing
the names of the parameters contained in this request.||
+||{{{pathInfo}}}                          || Returns any extra path information associated
with the URL the client sent when it made this request.||
+||{{{pathTranslated}}}                    || Returns any extra path information after the
servlet name but before the query string, and translates it to a real path.||
+||{{{protocol}}}                          || Returns the name and version of the protocol
the request uses in the form protocol/majorVersion.minorVersion, for example, HTTP/1.1.||
+||{{{queryString}}}                       || Returns the query string that is contained in
the request URL after the path.||
+||{{{remoteAddr}}}                        || Returns the Internet Protocol (IP) address of
the client that sent the request.||
+||{{{remoteHost}}}                        || Returns the fully qualified name of the client
that sent the request, or the IP address of the client if the name cannot be determined.||
+||{{{remoteUser}}}                        || Returns the login of the user making this request,
if the user has been authenticated, or null if the user has not been authenticated.||
+||{{{requestedSessionId}}}                || Returns the session ID specified by the client.||
+||{{{requestedSessionIdFromCookie}}}      || ||
+||{{{requestedSessionIdFromURL}}}         || ||
+||{{{requestedSessionIdValid}}}           || ||
+||{{{requestURI}}}                        || Returns the part of this request's URL from
the protocol name up to the query string in the first line of the HTTP request.||
+||{{{scheme}}}                            || Returns the name of the scheme used to make
this request, for example, http, https, or ftp.||
+||{{{secure}}}                            || Returns a boolean indicating whether this request
was made using a secure channel, such as HTTPS.||
+||{{{serverName}}}                        || Returns the host name of the server that received
the request||
+||{{{serverPort}}}                        || Returns the port number on which this request
was received.||
+||{{{servletPath}}}                       || Returns the part of this request's URL that
calls the servlet.||
+||{{{session}}}                           || Returns the current session associated with
this request, or if the request does not have a session, creates one.||
+||{{{sitemapURI}}}                        || Returns the URI of the requested resource as
interpreted by the sitemap.||
+||{{{userPrincipal}}}                     || Returns the login of the user making this request,
if the user has been authenticated, or null if the user has not been authenticated.||
 
 
 For a complete listing of all available properties, see the [http://cocoon.apache.org/2.1/apidocs/org/apache/cocoon/environment/Request.html
Cocoon Request API Docs].
@@ -266,13 +269,13 @@
 
 The following is not a complete list;  For a complete listing of all available accessors,
the [http://cocoon.apache.org/2.1/apidocs/org/apache/cocoon/environment/Session.html Cocoon
Session API Docs] may be useful.
 
-||'''Accessor'''||||Description
-||{{{attributeNames}}}||Returns a collection of attribute names in the session
-||{{{creationTime}}}||A Unix timestamp (seconds since the epoch) representing when the session
was created.
-||{{{id}}}||The unique session identifier
-||{{{lastAccessedTime}}}||A Unix timestamp representing when the session was last accessed.
-||{{{maxInactiveInterval}}}||# of seconds before an inactive session is invalidated.
-||{{{new}}}||Set to "true" if the session is new, otherwise "false"
+||'''Accessor'''||||Description||
+||{{{attributeNames}}}||Returns a collection of attribute names in the session||
+||{{{creationTime}}}||A Unix timestamp (seconds since the epoch) representing when the session
was created.||
+||{{{id}}}||The unique session identifier||
+||{{{lastAccessedTime}}}||A Unix timestamp representing when the session was last accessed.||
+||{{{maxInactiveInterval}}}||# of seconds before an inactive session is invalidated.||
+||{{{new}}}||Set to "true" if the session is new, otherwise "false"||
 
 ----
 = SessionAttributeModule =
@@ -307,7 +310,7 @@
 }}}
 
 ----
-== XML!FileModule (JXPath) ==
+== XMLFileModule (JXPath) ==
 
 This module provides an interface into any XML document (Using XPath expressions), and is
therefore very powerful.
 
@@ -331,10 +334,10 @@
 
 Returns the real path of a context-relative virtual path (if not deployed from a .war). e.g.
 
-||Accessor ||Value 
-||/ ||/home/resin/webapps/cocoon/   
-||/images ||/home/resin/webapps/cocoon/images   
-||/WEB-INF ||/home/resin/webapps/cocoon/WEB-INF   
+||Accessor||||Value|| 
+||/ ||/home/resin/webapps/cocoon/   ||
+||/images ||/home/resin/webapps/cocoon/images||
+||/WEB-INF ||/home/resin/webapps/cocoon/WEB-INF|| 
  
 The real path is relative to the webapp-context, not to the sitemap.
 Sometimes, you would rather have a path relative to the sitemap.

Mime
View raw message