You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@cocoon.apache.org by sh...@apache.org on 2002/06/18 05:36:03 UTC
cvs commit: xml-cocoon2/src/documentation/xdocs/developing/webapps authentication.xml sunrise.xml
shannon 2002/06/17 20:36:02
Modified: src/documentation/xdocs/developing/webapps
authentication.xml sunrise.xml
Log:
validation problems fixed
Revision Changes Path
1.2 +11 -11 xml-cocoon2/src/documentation/xdocs/developing/webapps/authentication.xml
Index: authentication.xml
===================================================================
RCS file: /home/cvs/xml-cocoon2/src/documentation/xdocs/developing/webapps/authentication.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- authentication.xml 14 Jun 2002 07:09:11 -0000 1.1
+++ authentication.xml 18 Jun 2002 03:36:02 -0000 1.2
@@ -9,7 +9,7 @@
</header>
<body>
<s1 title="Introduction">
- <note><strong>IMPORTANT:</strong> This document conforms to the development version of Cocoon. So
+ <note>IMPORTANT: This document conforms to the development version of Cocoon. So
you will only find these components in the current CVS. An early alpha version is already
available in the latest release of Cocoon, you will find an introduction <link href="sunrise.html">here</link>.
</note>
@@ -217,11 +217,11 @@
in the subsitemap are then simply protected in the same way as if the action
were declared in the main sitemap. This makes moving resources from one sitemap
to the other very simple.</p>
- <p><Strong>However, there is one drawback with this solution. After
+ <p><strong>However, there is one drawback with this solution. After
you have started your server, make sure that first a resource using the framework
- from the main sitemap is invoked, before any of the subsitemap!</Strong></p>
- <p><Strong>The definition of handlers in a sub-sitemap is a TODO and will be
- available in the next release.</Strong></p>
+ from the main sitemap is invoked, before any of the subsitemap!</strong></p>
+ <p><strong>The definition of handlers in a sub-sitemap is a TODO and will be
+ available in the next release.</strong></p>
</s2>
</s1>
<s1 title="User Management">
@@ -413,16 +413,16 @@
about the available users is needed. There are three different uses of this
resource:</p>
<ul>
- <il>Loading all users: The resource gets the parameter "type"
+ <li>Loading all users: The resource gets the parameter "type"
with the value "users". It should then deliver all users in the system.
- </il>
- <il>Loading all users of one role. The resource gets the
+ </li>
+ <li>Loading all users of one role. The resource gets the
parameters "type" with the value "users" and "role" with the rolename.
- </il>
- <il>Load information of one user. The resource gets the
+ </li>
+ <li>Load information of one user. The resource gets the
parameters "type" with the value "user", "role" with the rolename and "ID" with
the authentication ID of the user.
- </il>
+ </li>
</ul>
<p>The XML format of the resource should look like the
following:</p>
1.2 +35 -35 xml-cocoon2/src/documentation/xdocs/developing/webapps/sunrise.xml
Index: sunrise.xml
===================================================================
RCS file: /home/cvs/xml-cocoon2/src/documentation/xdocs/developing/webapps/sunrise.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- sunrise.xml 14 Jun 2002 07:09:11 -0000 1.1
+++ sunrise.xml 18 Jun 2002 03:36:02 -0000 1.2
@@ -23,12 +23,12 @@
management/authentication system.</p>
</s1>
<s1 title="Sitemap-Components">
- <p>sunRise adds some actions to the sitemap: the <en>sunRise-auth</en>
- action, the <en>sunRise-login</en> action, the <en>sunRise-logout</en> action
- and the <en>sunRise-loggedIn</en> action. The <en>sunRise-auth</en> action gets
+ <p>sunRise adds some actions to the sitemap: the <em>sunRise-auth</em>
+ action, the <em>sunRise-login</em> action, the <em>sunRise-logout</em> action
+ and the <em>sunRise-loggedIn</em> action. The <em>sunRise-auth</em> action gets
the configuration for sunRise and controlles the pipelines. The
- <en>sunRise-login</en> and the <en>sunRise-logout</en> action control the
- authentication the <en>sunRiseLoggedIn</en> action controlles the application
+ <em>sunRise-login</em> and the <em>sunRise-logout</em> action control the
+ authentication the <em>sunRiseLoggedIn</em> action controlles the application
flow.</p>
<p>The use of sunRise and its components is described in the following
chapters.</p>
@@ -117,7 +117,7 @@
<p>This redirect-to resource is an unprotected resource in the
sitemap. For tracking which resource was requested, the redirect-to resource
gets the request parameter "resource" with the value. In addition all
- parameters specified inside the <en>redirect-to</en> tag of the handler
+ parameters specified inside the <em>redirect-to</em> tag of the handler
configuration are passed to the resource.</p>
<p>This redirect-to resource can contain a form for the user
authentication. This form should invoke the real login resource which is
@@ -179,8 +179,8 @@
</action></source>
<p>If the authentication resource is a sitemap resource or a remote
resource, this resource is requested by sunRise with the given parameters from
- the <en>sunRise-login</en> action (see previous chapter: parameters: userid and
- password). In addition all parameters inside the <en>authentication</en> tag of
+ the <em>sunRise-login</em> action (see previous chapter: parameters: userid and
+ password). In addition all parameters inside the <em>authentication</em> tag of
the handler configuration are passed to the resource. The response for this
resource must contain valid XML conforming to the following scheme:</p>
<source><authentication>
@@ -222,9 +222,9 @@
in the subsitemap are then simply protected in the same way as if the action
were declared in the main sitemap. This makes moving resources from one sitemap
to the other very simple.</p>
- <p><Strong>However, there is one drawback with this solution. After
+ <p><strong>However, there is one drawback with this solution. After
you have started your server, make sure that first a resource using sunRise
- from the main sitemap is invoked, before any of the subsitemap!</Strong></p>
+ from the main sitemap is invoked, before any of the subsitemap!</strong></p>
</s2>
</s1>
@@ -400,7 +400,7 @@
<url>db:usertable</url>
</delete-user></source>
<s2 title="Getting Roles">
- <p>The <en>load-roles</en> resource is invoked from sunRise whenever
+ <p>The <em>load-roles</em> resource is invoked from sunRise whenever
it needs information about the available roles. This resource gets the
parameter "type" with the value "roles" and should deliver an XML schema with
the root node "roles" and for each role a subelement "role" with a text child
@@ -412,20 +412,20 @@
</roles></source>
</s2>
<s2 title="Getting Users">
- <p>The <en>load-users</en> resource is called whenever information
+ <p>The <em>load-users</em> resource is called whenever information
about the available users is needed. There are three different uses of this
resource:</p>
<ul>
- <il>Loading all users: The resource gets the parameter "type"
+ <li>Loading all users: The resource gets the parameter "type"
with the value "users". It should then deliver all users in the system.
- </il>
- <il>Loading all users of one role. The resource gets the
+ </li>
+ <li>Loading all users of one role. The resource gets the
parameters "type" with the value "users" and "role" with the rolename.
- </il>
- <il>Load information of one user. The resource gets the
+ </li>
+ <li>Load information of one user. The resource gets the
parameters "type" with the value "user", "role" with the rolename and "ID" with
the sunRise ID of the user.
- </il>
+ </li>
</ul>
<p>The XML format of the resource should look like the
following:</p>
@@ -442,19 +442,19 @@
</users></source>
</s2>
<s2 title="Creating a new role">
- <p>The <en>new-role</en> resource creates a new role in the system. It
+ <p>The <em>new-role</em> resource creates a new role in the system. It
gets the parameters "type" with the value "role" and "role" with the new
rolename.</p>
</s2>
<s2 title="Creating a new user">
- <p>The <en>new-user</en> resource creates a new user with a role. It
- gets the parameters <en>"type"</en> with the value <en>"user"</en>,
- <en>"role"</en> with the rolename and <en>"ID"</en> with the new ID for this
+ <p>The <em>new-user</em> resource creates a new user with a role. It
+ gets the parameters <em>"type"</em> with the value <em>"user"</em>,
+ <em>"role"</em> with the rolename and <em>"ID"</em> with the new ID for this
user.</p>
<p>The sunrise transformer offers a tag to create a newuser:
- <en>"adduser"</en>. The input for this element is all information needed to add
+ <em>"adduser"</em>. The input for this element is all information needed to add
a user including the ID and the role. All these values are then passed on to
- the <en>"new-user"</en> resource:</p>
+ the <em>"new-user"</em> resource:</p>
<source><adduser>
<ID>New ID for this user</ID>
<role>The role</role>
@@ -466,9 +466,9 @@
...
</adduser></source>
<p>In the example above a sunRise tries to create a new user with the
- given <en>"ID"</en> and <en>"role"</en>. The <en>"new-user"</en> resource gets
- also the parameters <en>"firstname"</en> and <en>"lastname"</en> with the
- values <en>"X"</en> and <en>"Y"</en>.</p>
+ given <em>"ID"</em> and <em>"role"</em>. The <em>"new-user"</em> resource gets
+ also the parameters <em>"firstname"</em> and <em>"lastname"</em> with the
+ values <em>"X"</em> and <em>"Y"</em>.</p>
<p>If no user with this ID exists the "sunrise:adduser" element is
replaced with the element "success". Inside this element all the values are
repeated inside the "values" element:</p>
@@ -503,18 +503,18 @@
</error></source>
</s2>
<s2 title="Changing information of a user">
- <p>The <en>change-user</en> resources changes information of a user.
+ <p>The <em>change-user</em> resources changes information of a user.
It gets the parameters "type" with the value "user", "role" with the rolename
and "ID" with the ID of the user. In addition all - application specific -
information of this user is send as parameters.</p>
</s2>
<s2 title="Delete a user">
- <p>The <en>delete-user</en> resource should delete a user. It gets the
+ <p>The <em>delete-user</em> resource should delete a user. It gets the
parameters "type" with the value "user", "role" with the rolename and "ID" with
the ID of the user.</p>
</s2>
<s2 title="Delete a role">
- <p>The <en>delete-role</en> resources deletes a role. It gets the
+ <p>The <em>delete-role</em> resources deletes a role. It gets the
parameters "type" with the value "role" and "role" with the rolename .</p>
</s2>
</s1>
@@ -627,9 +627,9 @@
</s2>
<s2 title="Controlling the Application Flow">
<p>If you want to create resources which behave different wheather you
- are logged in or not, the <en>sunRiseLoggedIn</en> action is the component to
+ are logged in or not, the <em>sunRiseLoggedIn</em> action is the component to
controll your application flow. This action checks if the user is authenticated
- for a given handler and calls all sitemap components inside the <en>act</en>
+ for a given handler and calls all sitemap components inside the <em>act</em>
tag.</p>
<source><map:match pattern="startpage">
@@ -644,10 +644,10 @@
<map:serialize/>
</map:match></source>
<p>In the example above, if the user is already logged he is
- redirected to the <en>loggedInStartPage</en> resource. If he is not logged in
+ redirected to the <em>loggedInStartPage</em> resource. If he is not logged in
for the given handler, the usual start page is generated.</p>
- <p>Both actions, the <en>sunRise-auth</en> and the
- <en>sunRise-loggedIn</en> action return - if the user is logged in for the
+ <p>Both actions, the <em>sunRise-auth</em> and the
+ <em>sunRise-loggedIn</em> action return - if the user is logged in for the
given handler - all values from the context to the sitemap, e.g. ID, role etc.
These values can be used within the other components:</p>
<source><map:match pattern"protected">
----------------------------------------------------------------------
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