[portal-commits] JBoss Portal SVN: r14007 - in docs/enterprise/trunk/Reference_Guide: en-US and 1 other directory.

Author: smumford Date: 2011-07-25 21:16:27 -0400 (Mon, 25 Jul 2011) New Revision: 14007 Modified: docs/enterprise/trunk/Reference_Guide/en-US/Book_Info.xml docs/enterprise/trunk/Reference_Guide/en-US/Error_Handling.xml docs/enterprise/trunk/Reference_Guide/en-US/Identity.xml docs/enterprise/trunk/Reference_Guide/en-US/Identity_Portlets.xml docs/enterprise/trunk/Reference_Guide/en-US/Ldap.xml docs/enterprise/trunk/Reference_Guide/en-US/Portal_API.xml docs/enterprise/trunk/Reference_Guide/en-US/Revision_History.xml docs/enterprise/trunk/Reference_Guide/en-US/Security.xml docs/enterprise/trunk/Reference_Guide/en-US/Theme_And_Layouts.xml docs/enterprise/trunk/Reference_Guide/en-US/Troubleshooting.xml docs/enterprise/trunk/Reference_Guide/en-US/Tutorials.xml docs/enterprise/trunk/Reference_Guide/en-US/WSRP.xml docs/enterprise/trunk/Reference_Guide/en-US/XML_Descriptors.xml docs/enterprise/trunk/Reference_Guide/publican.cfg Log: Updated old and broken hyperlinks. Modified: docs/enterprise/trunk/Reference_Guide/en-US/Book_Info.xml =================================================================== --- docs/enterprise/trunk/Reference_Guide/en-US/Book_Info.xml 2011-07-26 00:56:11 UTC (rev 14006) +++ docs/enterprise/trunk/Reference_Guide/en-US/Book_Info.xml 2011-07-26 01:16:27 UTC (rev 14007) @@ -3,31 +3,28 @@ ]> <bookinfo id="JBoss_Portal_Reference_Guide"> - <title>Reference Guide</title> - <subtitle>A Reference Guide for Enterprise Portal Platform 4.3</subtitle> - <edition>1</edition> - <pubsnumber>1.9</pubsnumber> - <productname>JBoss Enterprise Portal Platform</productname> - <productnumber>4.3</productnumber> - <isbn>N/A</isbn> - <issuenum>1</issuenum> - - - <abstract><para>This book is the Enterprise Portal Platform Reference Guide.</para> - </abstract> - <corpauthor> - <inlinemediaobject> - <imageobject> - <imagedata fileref="Common_Content/images/redhat-logo.svg" /> - </imageobject> - </inlinemediaobject> - </corpauthor> - - <copyright> - <year>&YEAR;</year> - <holder>&HOLDER;</holder> - </copyright> - <xi:include href="Common_Content/Legal_Notice.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include href="Author_Group.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <title>Reference Guide</title> + <subtitle>A Reference Guide for Enterprise Portal Platform 4.3</subtitle> + <productname>JBoss Enterprise Portal Platform</productname> + <productnumber>4.3</productnumber> + <edition>1</edition> + <pubsnumber>1.10</pubsnumber> + + <abstract><para>This book is the Enterprise Portal Platform Reference Guide.</para> + </abstract> + <corpauthor> + <inlinemediaobject> + <imageobject> + <imagedata fileref="Common_Content/images/redhat-logo.svg" /> + </imageobject> + </inlinemediaobject> + </corpauthor> + + <copyright> + <year>&YEAR;</year> + <holder>&HOLDER;</holder> + </copyright> + <xi:include href="Common_Content/Legal_Notice.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="Author_Group.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> </bookinfo> Modified: docs/enterprise/trunk/Reference_Guide/en-US/Error_Handling.xml =================================================================== --- docs/enterprise/trunk/Reference_Guide/en-US/Error_Handling.xml 2011-07-26 00:56:11 UTC (rev 14006) +++ docs/enterprise/trunk/Reference_Guide/en-US/Error_Handling.xml 2011-07-26 01:16:27 UTC (rev 14007) @@ -11,37 +11,37 @@ </chapterinfo>--> <title>Error Handling Configuration</title> <para> - The JBoss Portal request pipeline allows fine-grained, dynamic configuration of how JBoss Portal behaves when errors occur during runtime. + The JBoss Portal request pipeline allows fine-grained, dynamic configuration of how JBoss Portal behaves when errors occur during runtime. </para> <section> <title>Error Types</title> <para>There are several types of errors that can occur during a request: <itemizedlist> <listitem> - <para> - <emphasis>Access denied</emphasis>: the user does not have the required permissions to access the resource. - </para> - </listitem> + <para> + <emphasis>Access denied</emphasis>: the user does not have the required permissions to access the resource. + </para> + </listitem> <listitem> - <para> - <emphasis>Error</emphasis>: an anticipated error, such as when a portlet throws an exception. - </para> - </listitem> + <para> + <emphasis>Error</emphasis>: an anticipated error, such as when a portlet throws an exception. + </para> + </listitem> <listitem> - <para> - <emphasis>Internal error</emphasis>: an unexpected error. - </para> - </listitem> + <para> + <emphasis>Internal error</emphasis>: an unexpected error. + </para> + </listitem> <listitem> - <para> - <emphasis>Resource not found</emphasis>: the resource was not found. - </para> - </listitem> + <para> + <emphasis>Resource not found</emphasis>: the resource was not found. + </para> + </listitem> <listitem> - <para> - <emphasis>Resource unavailable</emphasis>: the resource was found, but was not serviceable. - </para> - </listitem> + <para> + <emphasis>Resource unavailable</emphasis>: the resource was found, but was not serviceable. + </para> + </listitem> </itemizedlist> </para> </section> @@ -52,33 +52,33 @@ <section> <title>Policy Delegation and Cascading</title> <para> - When a control policy is invoked, the response sent by the control flow can be changed. If the control policy ignores the error, the error is handled by the next policy. If the control policy provides a new response, the next policy is not invoked, since the new response is not an error. - </para> - <para> - If a portlet in a page produces an exception, the following reactions are possible: - </para> - <para> + When a control policy is invoked, the response sent by the control flow can be changed. If the control policy ignores the error, the error is handled by the next policy. If the control policy provides a new response, the next policy is not invoked, since the new response is not an error. + </para> + <para> + If a portlet in a page produces an exception, the following reactions are possible: + </para> + <para> <itemizedlist> <listitem> - <para> - the error is displayed in the window. - </para> - </listitem> + <para> + the error is displayed in the window. + </para> + </listitem> <listitem> - <para> - the window is removed from the aggregation. - </para> - </listitem> + <para> + the window is removed from the aggregation. + </para> + </listitem> <listitem> - <para> - a portal error page is displayed. - </para> - </listitem> + <para> + a portal error page is displayed. + </para> + </listitem> <listitem> - <para> - a HTTP 500 error response is sent to the Web browser. - </para> - </listitem> + <para> + a HTTP 500 error response is sent to the Web browser. + </para> + </listitem> </itemizedlist> </para> </section> @@ -86,60 +86,60 @@ <title>Default Policy</title> <para>The default policy applies when errors are not handled by another level. By default, errors are translated into the most appropriate HTTP response: - </para> - <para> + </para> + <para> <itemizedlist> <listitem> - <para> - Access denied: <computeroutput>HTTP 403 Forbidden</computeroutput> - </para> - </listitem> + <para> + Access denied: <computeroutput>HTTP 403 Forbidden</computeroutput> + </para> + </listitem> <listitem> - <para> - Error: <computeroutput>HTTP 500 Internal Server Error</computeroutput> - </para> - </listitem> + <para> + Error: <computeroutput>HTTP 500 Internal Server Error</computeroutput> + </para> + </listitem> <listitem> - <para> - Internal error: <computeroutput>HTTP 500 Internal Server Error</computeroutput> - </para> - </listitem> + <para> + Internal error: <computeroutput>HTTP 500 Internal Server Error</computeroutput> + </para> + </listitem> <listitem> - <para> - Resource not found: <computeroutput>HTTP 404 Not Found</computeroutput> - </para> - </listitem> + <para> + Resource not found: <computeroutput>HTTP 404 Not Found</computeroutput> + </para> + </listitem> <listitem> - <para> - Resource unavailable: <computeroutput>HTTP 404 Not Found</computeroutput> - </para> - </listitem> + <para> + Resource unavailable: <computeroutput>HTTP 404 Not Found</computeroutput> + </para> + </listitem> </itemizedlist> </para> </section> <section> <title>Portal Policy</title> <para> - The portal error-policy controls the response sent to the Web browser when an error occurs. A default error policy exists, which can be configured per portal. If an error occurs, the policy can either handle a redirect to a JSP page, or ignore it. If the error is ignored, it is handled by the default policy, otherwise a JSP page is invoked with the appropriate request attributes, allowing page customization. - </para> + The portal error-policy controls the response sent to the Web browser when an error occurs. A default error policy exists, which can be configured per portal. If an error occurs, the policy can either handle a redirect to a JSP page, or ignore it. If the error is ignored, it is handled by the default policy, otherwise a JSP page is invoked with the appropriate request attributes, allowing page customization. + </para> </section> <section> <title>Page Policy</title> <para> - The window error-policy controls how pages react to aggregation errors. Most of the time pages are an aggregation of several portlet windows, and the action to take when an error occurs differs from other policies. When an error occurs, the policy can either handle it, or ignore it. If the error is ignored, it is handled by the portal policy. Possible actions taken after such errors are: - </para> - <para> + The window error-policy controls how pages react to aggregation errors. Most of the time pages are an aggregation of several portlet windows, and the action to take when an error occurs differs from other policies. When an error occurs, the policy can either handle it, or ignore it. If the error is ignored, it is handled by the portal policy. Possible actions taken after such errors are: + </para> + <para> <itemizedlist> <listitem> - <para> - remove the window from the aggregation. - </para> - </listitem> + <para> + remove the window from the aggregation. + </para> + </listitem> <listitem> - <para> - replace the markup of the window using a redirect to a JSP page. - </para> - </listitem> + <para> + replace the markup of the window using a redirect to a JSP page. + </para> + </listitem> </itemizedlist> </para> </section> @@ -147,13 +147,13 @@ <section> <title>Configuration using XML Descriptors</title> <para> - Different policies are configured using portal object properties, allowing the error-handling policy for objects to be configured in XML descriptors -- the <filename>*-object.xml</filename> files -- for a portal deployment. + Different policies are configured using portal object properties, allowing the error-handling policy for objects to be configured in XML descriptors -- the <filename>*-object.xml</filename> files -- for a portal deployment. </para> <section> <title>Portal Policy Properties</title> <para> - A set of properties configure the the behavior of the portal policy. These properties are only taken into account for objects that use the <emphasis>portal</emphasis> type. The following table represents possible portal-policy properties: - </para> + A set of properties configure the behavior of the portal policy. These properties are only taken into account for objects that use the <emphasis>portal</emphasis> type. The following table represents possible portal-policy properties: + </para> <table frame="all"><title></title> <tgroup cols="3" align="left" colsep="1"> @@ -169,44 +169,44 @@ </thead> <tbody> <row> - <entry align="center"><computeroutput>control.portal.access_denied</computeroutput></entry> + <entry align="center"><computeroutput>control.portal.access_denied</computeroutput></entry> <entry align="center">when access is denied</entry> - <entry align="center"><computeroutput>ignore</computeroutput> and <computeroutput>jsp</computeroutput></entry> - </row> + <entry align="center"><computeroutput>ignore</computeroutput> and <computeroutput>jsp</computeroutput></entry> + </row> <row> - <entry align="center"><computeroutput>control.portal.unavailable</computeroutput></entry> + <entry align="center"><computeroutput>control.portal.unavailable</computeroutput></entry> <entry align="center">when a resource is unavailable</entry> - <entry align="center"><computeroutput>ignore</computeroutput> and <computeroutput>jsp</computeroutput></entry> + <entry align="center"><computeroutput>ignore</computeroutput> and <computeroutput>jsp</computeroutput></entry> </row> - <row> - <entry align="center"><computeroutput>control.portal.not_found</computeroutput></entry> - <entry align="center">when a resource is not found</entry> - <entry align="center"><computeroutput>ignore</computeroutput> and <computeroutput>jsp</computeroutput></entry> + <row> + <entry align="center"><computeroutput>control.portal.not_found</computeroutput></entry> + <entry align="center">when a resource is not found</entry> + <entry align="center"><computeroutput>ignore</computeroutput> and <computeroutput>jsp</computeroutput></entry> </row> - <row> - <entry align="center"><computeroutput>control.portal.internal_error</computeroutput></entry> - <entry align="center">when an unexpected error occurs</entry> - <entry align="center"><computeroutput>ignore</computeroutput> and <computeroutput>jsp</computeroutput></entry> + <row> + <entry align="center"><computeroutput>control.portal.internal_error</computeroutput></entry> + <entry align="center">when an unexpected error occurs</entry> + <entry align="center"><computeroutput>ignore</computeroutput> and <computeroutput>jsp</computeroutput></entry> </row> <row> - <entry align="center"><computeroutput>control.portal.error</computeroutput></entry> + <entry align="center"><computeroutput>control.portal.error</computeroutput></entry> <entry align="center">when an expected error occurs</entry> - <entry align="center"><computeroutput>ignore</computeroutput> and <computeroutput>jsp</computeroutput></entry> + <entry align="center"><computeroutput>ignore</computeroutput> and <computeroutput>jsp</computeroutput></entry> </row> <row> - <entry align="center"><computeroutput>control.portal.resource_uri</computeroutput></entry> + <entry align="center"><computeroutput>control.portal.resource_uri</computeroutput></entry> <entry align="center">the path to the JSP used for redirections</entry> <entry align="center">a valid path to a JSP located in the <filename>portal-core.war/</filename> directory</entry> </row> </tbody> </tgroup> </table> - + <para> - The following portal configuration demonstrates the use of portal-policy properties: - </para> - <para> + The following portal configuration demonstrates the use of portal-policy properties: + </para> + <para> <programlisting><![CDATA[ <portal> <portal-name>MyPortal</portal-name> @@ -245,9 +245,9 @@ </section> <section> <title>Page Policy Properties</title> - <para> - A set of properties configure the behavior of the page policy. These properties are only taken into account for objects that use the <emphasis>portal</emphasis> type. The following table represents possible page-policy properties: - </para> + <para> + A set of properties configure the behavior of the page policy. These properties are only taken into account for objects that use the <emphasis>portal</emphasis> type. The following table represents possible page-policy properties: + </para> <para> <table frame="all"><title></title> <tgroup cols="3" align="left" colsep="1" > @@ -263,43 +263,43 @@ </thead> <tbody> <row> - <entry align="center"><computeroutput>control.page.access_denied</computeroutput></entry> + <entry align="center"><computeroutput>control.page.access_denied</computeroutput></entry> <entry align="center">when access is denied</entry> - <entry align="center"><computeroutput>ignore</computeroutput>, <computeroutput>jsp</computeroutput> and <computeroutput>hide</computeroutput></entry> + <entry align="center"><computeroutput>ignore</computeroutput>, <computeroutput>jsp</computeroutput> and <computeroutput>hide</computeroutput></entry> </row> <row> - <entry align="center"><computeroutput>control.page.unavailable</computeroutput></entry> + <entry align="center"><computeroutput>control.page.unavailable</computeroutput></entry> <entry align="center">when a resource is unavailable</entry> - <entry align="center"><computeroutput>ignore</computeroutput>, <computeroutput>jsp</computeroutput> and <computeroutput>hide</computeroutput></entry> + <entry align="center"><computeroutput>ignore</computeroutput>, <computeroutput>jsp</computeroutput> and <computeroutput>hide</computeroutput></entry> </row> - <row> - <entry align="center"><computeroutput>control.page.not_found</computeroutput></entry> - <entry align="center">when a resource is not found</entry> - <entry align="center"><computeroutput>ignore</computeroutput>, <computeroutput>jsp</computeroutput> and <computeroutput>hide</computeroutput></entry> + <row> + <entry align="center"><computeroutput>control.page.not_found</computeroutput></entry> + <entry align="center">when a resource is not found</entry> + <entry align="center"><computeroutput>ignore</computeroutput>, <computeroutput>jsp</computeroutput> and <computeroutput>hide</computeroutput></entry> </row> - <row> - <entry align="center"><computeroutput>control.page.internal_error</computeroutput></entry> - <entry align="center">when an unexpected error occurs</entry> - <entry align="center"><computeroutput>ignore</computeroutput>, <computeroutput>jsp</computeroutput> and <computeroutput>hide</computeroutput></entry> + <row> + <entry align="center"><computeroutput>control.page.internal_error</computeroutput></entry> + <entry align="center">when an unexpected error occurs</entry> + <entry align="center"><computeroutput>ignore</computeroutput>, <computeroutput>jsp</computeroutput> and <computeroutput>hide</computeroutput></entry> </row> <row> - <entry align="center"><computeroutput>control.page.error</computeroutput></entry> + <entry align="center"><computeroutput>control.page.error</computeroutput></entry> <entry align="center">when an expected error occurs</entry> - <entry align="center"><computeroutput>ignore</computeroutput>, <computeroutput>jsp</computeroutput> and <computeroutput>hide</computeroutput></entry> + <entry align="center"><computeroutput>ignore</computeroutput>, <computeroutput>jsp</computeroutput> and <computeroutput>hide</computeroutput></entry> </row> - <row> - <entry align="center"><computeroutput>control.page.resource_uri</computeroutput></entry> - <entry align="center">the path to the JSP used for redirections</entry> - <entry align="center"><computeroutput>ignore</computeroutput>, <computeroutput>jsp</computeroutput> and <computeroutput>hide</computeroutput></entry> + <row> + <entry align="center"><computeroutput>control.page.resource_uri</computeroutput></entry> + <entry align="center">the path to the JSP used for redirections</entry> + <entry align="center"><computeroutput>ignore</computeroutput>, <computeroutput>jsp</computeroutput> and <computeroutput>hide</computeroutput></entry> </row> </tbody> </tgroup> </table> </para> - <para> - The following page configuration demonstrates the use of page-policy properties: - </para> - <para> + <para> + The following page configuration demonstrates the use of page-policy properties: + </para> + <para> <programlisting><![CDATA[ <page> <page-name>MyPortal</page-name> @@ -335,20 +335,20 @@ </page> ]]></programlisting> </para> - <para> + <para> <note> - <title>Page Property Inheritance for Objects</title> - <para> - When page properties are configured for objects that use the <emphasis>portal</emphasis> type, the properties are inherited by pages in that portal. - </para> - </note> + <title>Page Property Inheritance for Objects</title> + <para> + When page properties are configured for objects that use the <emphasis>portal</emphasis> type, the properties are inherited by pages in that portal. + </para> + </note> </para> </section> </section> <section> - <title>Using <trademark class="trade">JSP</trademark> to Handle Errors</title> + <title>Using <trademark class="trade">JSP</trademark> to Handle Errors</title> <para> - As described in previous sections, error handling can be redirected to a <trademark class="trade">JSP</trademark> page. Two pages can be created to handle errors: one for the portal level, and the other for the page level. Portal level error-handling requires a page that produces a full page, and page-level handling requires a page that produces markup, but only for a window. When the page is invoked, a set of request attributes are passed. The following table represents possible request attributes: + As described in previous sections, error handling can be redirected to a <trademark class="trade">JSP</trademark> page. Two pages can be created to handle errors: one for the portal level, and the other for the page level. Portal level error-handling requires a page that produces a full page, and page-level handling requires a page that produces markup, but only for a window. When the page is invoked, a set of request attributes are passed. The following table represents possible request attributes: </para> <para> <table frame="all"><title></title> @@ -367,7 +367,7 @@ <row> <entry align="center"><computeroutput>org.jboss.portal.control.ERROR_TYPE</computeroutput></entry> <entry align="center">the error type</entry> - <entry align="center">possible values are <computeroutput>ACCESS_DENIED</computeroutput>, <computeroutput>UNAVAILABLE</computeroutput>, <computeroutput>ERROR</computeroutput>, <computeroutput>INTERNAL_ERROR</computeroutput>, and <computeroutput>NOT_FOUND</computeroutput></entry> + <entry align="center">possible values are <computeroutput>ACCESS_DENIED</computeroutput>, <computeroutput>UNAVAILABLE</computeroutput>, <computeroutput>ERROR</computeroutput>, <computeroutput>INTERNAL_ERROR</computeroutput>, and <computeroutput>NOT_FOUND</computeroutput></entry> </row> <row> <entry align="center"><computeroutput>org.jboss.portal.control.CAUSE</computeroutput></entry> @@ -384,10 +384,10 @@ </table> </para> <para> - <note> - <title><trademark class="trade">JSP</trademark> Location</title><para> - The JavaServer Pages must be located in the <filename>jboss-portal.sar/portal-core.war/</filename> web application.</para> - </note> + <note> + <title><trademark class="trade">JSP</trademark> Location</title><para> + The JavaServer Pages must be located in the <filename>jboss-portal.sar/portal-core.war/</filename> web application.</para> + </note> </para> </section> <section> @@ -396,51 +396,51 @@ The error handling policy can be configured via the portal management application. To access the portal management application: </para> <para> - <orderedlist> - <listitem> - <para> - Use a Web browser to navigate to <ulink url="http://localhost:8080/portal" />. - </para> - </listitem> - <listitem> - <para> - Click the <guibutton>Login</guibutton> button on the top right-hand of the welcome page, and log in as the <option>admin</option> user. - </para> - </listitem> - <listitem> - <para> - Click the <guibutton>Admin</guibutton> tab on the top right-hand of the welcome page. Four tabs will appear on the left-hand side of the page. - </para> - </listitem> - <listitem> - <para> - Click the <guibutton>Admin</guibutton> tab to open the portal management application, and then click the <guibutton>Portal Objects</guibutton> tab to display available portals. - </para> - </listitem> - </orderedlist> + <orderedlist> + <listitem> + <para> + Use a Web browser to navigate to <ulink url="http://localhost:8080/portal" />. + </para> + </listitem> + <listitem> + <para> + Click the <guibutton>Login</guibutton> button on the top right-hand of the welcome page, and log in as the <option>admin</option> user. + </para> + </listitem> + <listitem> + <para> + Click the <guibutton>Admin</guibutton> tab on the top right-hand of the welcome page. Four tabs will appear on the left-hand side of the page. + </para> + </listitem> + <listitem> + <para> + Click the <guibutton>Admin</guibutton> tab to open the portal management application, and then click the <guibutton>Portal Objects</guibutton> tab to display available portals. + </para> + </listitem> + </orderedlist> </para> <para> - Configuration options are available as part of the properties for each configuration level. You can specify the default error handling policy (at the root of the portal object hierarchy) for each portal, or each page, by clicking on the <guibutton>Properties</guibutton> button for each page or portal: + Configuration options are available as part of the properties for each configuration level. You can specify the default error handling policy (at the root of the portal object hierarchy) for each portal, or each page, by clicking on the <guibutton>Properties</guibutton> button for each page or portal: </para> <para> - <mediaobject> - <imageobject> - <imagedata fileref="images/errorhandling/errorHandling_management.png" scalefit="1" /> - </imageobject> - </mediaobject> + <mediaobject> + <imageobject> + <imagedata fileref="images/errorhandling/errorHandling_management.png" scalefit="1" /> + </imageobject> + </mediaobject> </para> <para> - As well, you can specify how dashboards should behave with respect to error handling, by clicking on the <guibutton>Dashboards</guibutton> tab in the portal management application: + As well, you can specify how dashboards should behave with respect to error handling, by clicking on the <guibutton>Dashboards</guibutton> tab in the portal management application: </para> <para> - <mediaobject> + <mediaobject> <imageobject> - <imagedata fileref="images/errorhandling/errorHandlingUI.png" align="center" scalefit="1" /> + <imagedata fileref="images/errorhandling/errorHandlingUI.png" align="center" scalefit="1" /> </imageobject> - </mediaobject> + </mediaobject> </para> <para> - The page specified with <computeroutput>On error redirect to this resource</computeroutput> is used when the <option>Redirect to the specified resource</option> action is selected for an error type, such as <computeroutput>When access to the page is denied</computeroutput>. After making changes, click the <guibutton>Update</guibutton> button for settings to take effect. + The page specified with <computeroutput>On error redirect to this resource</computeroutput> is used when the <option>Redirect to the specified resource</option> action is selected for an error type, such as <computeroutput>When access to the page is denied</computeroutput>. After making changes, click the <guibutton>Update</guibutton> button for settings to take effect. </para> </section> </chapter> \ No newline at end of file Modified: docs/enterprise/trunk/Reference_Guide/en-US/Identity.xml =================================================================== --- docs/enterprise/trunk/Reference_Guide/en-US/Identity.xml 2011-07-26 00:56:11 UTC (rev 14006) +++ docs/enterprise/trunk/Reference_Guide/en-US/Identity.xml 2011-07-26 01:16:27 UTC (rev 14007) @@ -39,9 +39,9 @@ public boolean validatePassword(String password); ]]></programlisting> <warning> - <para> - Important Note! The proper usage of getId() method is: - </para> + <para> + Important Note! The proper usage of getId() method is: + </para> <programlisting><![CDATA[ // Always use it like this: user.getId().toString(); @@ -54,9 +54,9 @@ // We would get a String with an LDAP server (String)user.getId(); ]]></programlisting> - <para> - This is because the ID value depends on the User implementation. It'll probably be String object with the LDAP implementation and a Long object with the database implementation but it could be something else if one has chosen to make its own implementation. - </para> + <para> + This is because the ID value depends on the User implementation. It'll probably be String object with the LDAP implementation and a Long object with the database implementation but it could be something else if one has chosen to make its own implementation. + </para> </warning> </para> </listitem> @@ -161,7 +161,7 @@ <listitem> <para> The <emphasis role="bold">MembershipModule</emphasis> - interface exposes operations for obtaining or managing relationships beetween users and roles. + interface exposes operations for obtaining or managing relationships between users and roles. The role of this service is to decouple relationship information from user and roles. Indeed while user role relationship is pretty straightforward with a relational database (using a many to many relationship with an intermediary table), with an LDAP server there a different @@ -191,7 +191,7 @@ <listitem> <para> The <emphasis role="bold">UserProfileModule</emphasis> - interface exposes operations to access and manage informations stored in User profile: + interface exposes operations to access and manage information stored in User profile: <programlisting><![CDATA[ public Object getProperty(User user, String propertyName) @@ -207,10 +207,10 @@ throws IdentityException; ]]></programlisting> <warning> - <para> + <para> UserProfileModule.getProperty() method returns an Object. In most cases with DB backend it will always be String object. But normally you should check what - object will be retrieved using getProfileInfo() method.</para> + object will be retrieved using getProfileInfo() method.</para> </warning> </para> </listitem> @@ -287,7 +287,7 @@ (MembershipModule)new InitialContext().lookup("java:portal/MembershipModule"); (UserProfileModule)new InitialContext().lookup("java:portal/UserProfileModule");</programlisting> <para> - Another way to do this is, if you are fimiliar with JBoss Microkernel architecture is to + Another way to do this is, if you are familiar with JBoss Microkernel architecture is to get the <emphasis role="bold">IdentityServiceController</emphasis> mbean. You may want to inject it into your services like this: </para> @@ -327,8 +327,8 @@ <emphasis role="bold">User</emphasis> and <emphasis role="bold">Role</emphasis> - interfaces some API usages changed. Here are the most important changes you will need to aply to your - code while migrating your aplication to 2.6: + interfaces some API usages changed. Here are the most important changes you will need to apply to your + code while migrating your application to 2.6: </para> <itemizedlist> <listitem> @@ -406,21 +406,21 @@ by the portal. So an *example* of UserModule service could be a plain Java bean object that would be: </para> <itemizedlist> - <listitem> - <para><emphasis role="bold">Instantiated</emphasis> using reflection</para> - </listitem> - <listitem> - <para><emphasis role="bold">Initialized/Started</emphasis> by invoking some methods</para> - </listitem> - <listitem> - <para><emphasis role="bold">Registered/Exposed</emphasis> using JNDI and/or mbeans (JBoss Microkernel) services, so other services of the portal can use it</para> - </listitem> - <listitem> - <para><emphasis role="bold">Managed</emphasis> in the matter of lifecycle - so it'll be stopped and unregistered during portal shutdown</para> - </listitem> + <listitem> + <para><emphasis role="bold">Instantiated</emphasis> using reflection</para> + </listitem> + <listitem> + <para><emphasis role="bold">Initialized/Started</emphasis> by invoking some methods</para> + </listitem> + <listitem> + <para><emphasis role="bold">Registered/Exposed</emphasis> using JNDI and/or mbeans (JBoss Microkernel) services, so other services of the portal can use it</para> + </listitem> + <listitem> + <para><emphasis role="bold">Managed</emphasis> in the matter of lifecycle - so it'll be stopped and unregistered during portal shutdown</para> + </listitem> </itemizedlist> <para> - As you see from this point of view, configuration just specifies what Java class will be used and how it should be used by portal as a service. + As you see from this point of view, configuration just specifies what Java class will be used and how it should be used by portal as a service. </para> <note><title>Note</title><para>We use JBoss Microcontainer internally to manage the sub system made of those components so if you are interested in implementing custom services - look on the methods that are used by this framework.</para></note> @@ -507,7 +507,7 @@ <emphasis role="bold">Module</emphasis> section, so they will be ready to serve them.</para> <note><title>Note</title> - <para>This section isn't used with Database configuration as in JBoss Portal services exposing Hibernate + <para>This section isn't used with Database configuration as in JBoss Portal services exposing Hibernate are defined separately. It is used by LDAP configuration and we will use it as an example</para> </note> <programlisting><![CDATA[ @@ -538,12 +538,12 @@ </config> </datasource>]]></programlisting> <note> - <title>Note</title> - <para>If you look into JBoss Portal configuration files you will find that <![CDATA[<service-name/> and <class/>]]> + <title>Note</title> + <para>If you look into JBoss Portal configuration files you will find that <![CDATA[<service-name/> and <class/>]]> are specified in <emphasis role="bold">DefaultConfigFile</emphasis> and not in <emphasis role="bold">ConfigFile</emphasis>. So here is how it works: those two will be picked up from default configuration. The same rule is effective for the options - additional options will be picked up from default configuration. What is linking configuration in those two files - is the <emphasis role="bold"><![CDATA[<name>]]></emphasis> tag.</para> + is the <emphasis role="bold"><![CDATA[<name>]]></emphasis> tag.</para> </note> </section> <section> @@ -604,8 +604,8 @@ </para> </listitem> </itemizedlist> - <note><title>Note</title><para> - Here you can easily see the whole idea about having two config files - main one and the one with default values. + <note><title>Note</title><para> + Here you can easily see the whole idea about having two config files - main one and the one with default values. The above code snippet with User module comes from <emphasis role="bold">standardidentity-config.xml</emphasis>, so the file that defines default configuration values. Because of this in the main configuration file the definition of User module will be as short as: @@ -618,7 +618,7 @@ </module>]]></programlisting> As you can see we specify only the type and the implementation - all the other values (service-name, class and set of options) are read from default configuration. But remember that you can still overwrite any of those values in the - main config simply by overriding them.</para> + main config simply by overriding them.</para> </note> </section> @@ -684,12 +684,12 @@ </option> </option-group>]]></programlisting> <note> - <title>Note</title><para> - In this section we use the same inheritance mechanism. When an option is not set, its value will be read + <title>Note</title><para> + In this section we use the same inheritance mechanism. When an option is not set, its value will be read from the default config file. But this also means that you may need to overwrite some values that are specific to your LDAP architecture. All the options will be described along with module implementations - that use them.</para> - </note> + that use them.</para> + </note> </section> </section> </section> @@ -786,40 +786,40 @@ <itemizedlist> <listitem><para> - <emphasis role="bold">name</emphasis> - property name. This value will be used to refer to the property in <emphasis>UserProfileModule</emphasis></para> + <emphasis role="bold">name</emphasis> - property name. This value will be used to refer to the property in <emphasis>UserProfileModule</emphasis></para> </listitem> - <listitem><para> + <listitem><para> <emphasis role="bold">type</emphasis> - Java type of property. This type will be checked when in <emphasis>UserProfileModule</emphasis> - methods invocation.</para> + methods invocation.</para> </listitem> - <listitem><para> - <emphasis role="bold">access-mode</emphasis> - possible values are <emphasis>read-write</emphasis> and <emphasis>read-only</emphasis></para> + <listitem><para> + <emphasis role="bold">access-mode</emphasis> - possible values are <emphasis>read-write</emphasis> and <emphasis>read-only</emphasis></para> </listitem> <listitem> - <para><emphasis role="bold">usage</emphasis> - property usage can be <emphasis>mandatory</emphasis> or <emphasis>optional</emphasis>.</para> + <para><emphasis role="bold">usage</emphasis> - property usage can be <emphasis>mandatory</emphasis> or <emphasis>optional</emphasis>.</para> </listitem> <listitem> - <para><emphasis role="bold">display-name</emphasis> - property display name.</para> + <para><emphasis role="bold">display-name</emphasis> - property display name.</para> </listitem> <listitem> - <para><emphasis role="bold">description</emphasis> - description of property.</para> + <para><emphasis role="bold">description</emphasis> - description of property.</para> </listitem> <listitem> - <para> - <emphasis role="bold">mapping</emphasis> - defines how property is mapped in the underlaying storage mechanism. It can be mapped in <emphasis>database</emphasis> + <para> + <emphasis role="bold">mapping</emphasis> - defines how property is mapped in the underlying storage mechanism. It can be mapped in <emphasis>database</emphasis> either as a <emphasis>column</emphasis> or <emphasis>dynamic</emphasis> value. It can also be mapped as <emphasis>ldap</emphasis> attribute. - <note><title>Note</title><para>In current implementation <emphasis>column</emphasis> and <emphasis>dynamic</emphasis> mappings have the same effect, as database mappings are defined in hibernate configuration.</para></note> + <note><title>Note</title><para>In current implementation <emphasis>column</emphasis> and <emphasis>dynamic</emphasis> mappings have the same effect, as database mappings are defined in hibernate configuration.</para></note> - <note><title>Note</title> - <para>Property can have both <emphasis>ldap</emphasis> and <emphasis>database</emphasis> mappings. In such situation when LDAP support is enabled <emphasis>ldap</emphasis> mapping will take precedense. Also even when using LDAP some properties will be mapped to LDAP and some to database. Its because LDAP schema doesn't support all attributes proper to for portal properties. To solve this we have <emphasis role="bold">DelegatingUserProfileModuleImpl</emphasis> that will delegate method invocation to - <emphasis>ldap</emphasis> or <emphasis>database</emphasis> related <emphasis>UserProfile</emphasis> module. When <emphasis>LDAP</emphasis> support is enabled and property need to be stored in database user will be synchronized into database when needed. This behavior can be configured.</para> - </note> - </para> + <note><title>Note</title> + <para>Property can have both <emphasis>ldap</emphasis> and <emphasis>database</emphasis> mappings. In such situation when LDAP support is enabled <emphasis>ldap</emphasis> mapping will take precedence. Also even when using LDAP some properties will be mapped to LDAP and some to database. Its because LDAP schema doesn't support all attributes proper to for portal properties. To solve this we have <emphasis role="bold">DelegatingUserProfileModuleImpl</emphasis> that will delegate method invocation to + <emphasis>ldap</emphasis> or <emphasis>database</emphasis> related <emphasis>UserProfile</emphasis> module. When <emphasis>LDAP</emphasis> support is enabled and property need to be stored in database user will be synchronized into database when needed. This behavior can be configured.</para> + </note> + </para> </listitem> </itemizedlist> @@ -830,7 +830,7 @@ <title>Identity modules implementations</title> <note><title>Note</title><para>Identity modules implementations related to LDAP are described in <xref linkend="ldap.ldap_identity_modules"/>. - </para></note> + </para></note> <section> <title>Database modules</title> <para>JBoss portal comes with a set of database related identity modules implementations done using Hibernate - those are configured @@ -842,27 +842,27 @@ <para>Classes implementing identity modules: <itemizedlist> <listitem> - <para> - <emphasis role="bold">org.jboss.portal.identity.db.HibernateUserModuleImpl</emphasis> - implementaing <emphasis>UserModule</emphasis> interface</para> + <para> + <emphasis role="bold">org.jboss.portal.identity.db.HibernateUserModuleImpl</emphasis> - implementing <emphasis>UserModule</emphasis> interface</para> </listitem> - <listitem><para> - <emphasis role="bold">org.jboss.portal.identity.db.HibernateRoleModuleImpl</emphasis> - implementaing <emphasis>RoleModule</emphasis> interface</para> + <listitem><para> + <emphasis role="bold">org.jboss.portal.identity.db.HibernateRoleModuleImpl</emphasis> - implementing <emphasis>RoleModule</emphasis> interface</para> </listitem> - <listitem><para> - <emphasis role="bold">org.jboss.portal.identity.db.HibernateMembershipModuleImpl</emphasis> - implementaing <emphasis>MembershipModule</emphasis> interface</para> + <listitem><para> + <emphasis role="bold">org.jboss.portal.identity.db.HibernateMembershipModuleImpl</emphasis> - implementing <emphasis>MembershipModule</emphasis> interface</para> </listitem> - <listitem><para> - <emphasis role="bold">org.jboss.portal.identity.db.HibernateUserProfileModuleImpl</emphasis> - implementing <emphasis>UserProfileModule</emphasis> interface</para> + <listitem><para> + <emphasis role="bold">org.jboss.portal.identity.db.HibernateUserProfileModuleImpl</emphasis> - implementing <emphasis>UserProfileModule</emphasis> interface</para> </listitem> </itemizedlist> </para> <para>For each of those modules you can alter two config options: <itemizedlist> - <listitem><para> - <emphasis>sessionFactoryJNDIName</emphasis> - JNDI name under which hibernate SessionFactory object is registered</para> + <listitem><para> + <emphasis>sessionFactoryJNDIName</emphasis> - JNDI name under which hibernate SessionFactory object is registered</para> </listitem> <listitem> - <para><emphasis>jNDIName</emphasis> - JNDI name under which this module should be registered</para> + <para><emphasis>jNDIName</emphasis> - JNDI name under which this module should be registered</para> </listitem> </itemizedlist> </para> @@ -870,7 +870,7 @@ <section id="identity.management_api"> <title>Delegating UserProfile module</title> <para> - Delegating UserProfileModule implementation has very specific role. When we use a storage mechanism like LDAP we may not be able to map all + Delegating UserProfileModule implementation has very specific role. When we use a storage mechanism like LDAP we may not be able to map all user properties into LDAP attributes because of schema limitations. To solve this problem we still can use the database to store user properties that do not exist in the LDAP schema. The Delegating user profile module will recognize if a property is mapped as <emphasis role="bold">ldap</emphasis> or <emphasis role="bold">database</emphasis> @@ -909,14 +909,14 @@ <para> Module options are: <itemizedlist> - <listitem><para> - <emphasis role="bold">dbModuleJNDIName</emphasis> - JNDI name under which database implementation of UserProfileModule is registered.</para> + <listitem><para> + <emphasis role="bold">dbModuleJNDIName</emphasis> - JNDI name under which database implementation of UserProfileModule is registered.</para> </listitem> - <listitem><para> - <emphasis role="bold">ldapModuleJNDIName</emphasis> - JNDI name under which ldap implementation of UserProfileModule is registered.</para> + <listitem><para> + <emphasis role="bold">ldapModuleJNDIName</emphasis> - JNDI name under which ldap implementation of UserProfileModule is registered.</para> </listitem> - <listitem><para> - <emphasis role="bold">profileConfigFile</emphasis> - configuration file for user properties.</para> + <listitem><para> + <emphasis role="bold">profileConfigFile</emphasis> - configuration file for user properties.</para> </listitem> </itemizedlist> </para> @@ -930,26 +930,26 @@ Here are the options: </para> <itemizedlist> - <listitem><para> + <listitem><para> <emphasis role="bold">synchronizeNonExistingUsers</emphasis> - when set to "true" if the user subject to the operation does not exist, then it will - created it in database. By default it is "true".</para> + created it in database. By default it is "true".</para> </listitem> - <listitem><para> + <listitem><para> <emphasis role="bold">acceptOtherImplementations</emphasis> - if set to "true" module will accept user objects other than <emphasis>org.jboss.portal.identity.db.HibernateUserImpl</emphasis>. This is needed to enable cooperation with UserModule implementations other - than <emphasis>org.jboss.portal.identity.db.HibernateUserModuleImpl</emphasis>. The default value is set "true".</para> + than <emphasis>org.jboss.portal.identity.db.HibernateUserModuleImpl</emphasis>. The default value is set "true".</para> </listitem> <listitem> - <para><emphasis role="bold">defaultSynchronizePassword</emphasis> - if this option is set, the value will be used as a password for synchronized user.</para> + <para><emphasis role="bold">defaultSynchronizePassword</emphasis> - if this option is set, the value will be used as a password for synchronized user.</para> </listitem> <listitem> - <para><emphasis role="bold">randomSynchronizePassword</emphasis> - if this option is set to "true" synchronized user will have random generated password. This is mostly used for the security reasons. Default value is "false".</para> + <para><emphasis role="bold">randomSynchronizePassword</emphasis> - if this option is set to "true" synchronized user will have random generated password. This is mostly used for the security reasons. Default value is "false".</para> </listitem> <listitem> - <para><emphasis role="bold">sessionFactoryJNDIName</emphasis> - JNDI name under which this user will be registered.</para> + <para><emphasis role="bold">sessionFactoryJNDIName</emphasis> - JNDI name under which this user will be registered.</para> </listitem> <listitem> - <para><emphasis role="bold">profileConfigFile</emphasis> - file with user profile configuration. If this option is not set, and we use delegating UserProfileModule, profile configuration will be obtained from it.</para> + <para><emphasis role="bold">profileConfigFile</emphasis> - file with user profile configuration. If this option is not set, and we use delegating UserProfileModule, profile configuration will be obtained from it.</para> </listitem> </itemizedlist> Modified: docs/enterprise/trunk/Reference_Guide/en-US/Identity_Portlets.xml =================================================================== --- docs/enterprise/trunk/Reference_Guide/en-US/Identity_Portlets.xml 2011-07-26 00:56:11 UTC (rev 14006) +++ docs/enterprise/trunk/Reference_Guide/en-US/Identity_Portlets.xml 2011-07-26 01:16:27 UTC (rev 14007) @@ -786,7 +786,7 @@ </process-definition>]]></programlisting> <para> - <para>For more details about jBPM please read the appropriate JBPM Reference Guide from the SOA Platform documentation suite; <ulink url="http://docs.redhat.com/docs/en-US/JBoss_Enterprise_SOA_Platform...;. + For more details about jBPM please read the appropriate JBPM Reference Guide from the SOA Platform documentation suite; <ulink url="http://docs.redhat.com/docs/en-US/JBoss_Enterprise_SOA_Platform...;. </para> </section> </section> Modified: docs/enterprise/trunk/Reference_Guide/en-US/Ldap.xml =================================================================== --- docs/enterprise/trunk/Reference_Guide/en-US/Ldap.xml 2011-07-26 00:56:11 UTC (rev 14006) +++ docs/enterprise/trunk/Reference_Guide/en-US/Ldap.xml 2011-07-26 01:16:27 UTC (rev 14007) @@ -232,7 +232,7 @@ <title>UserModule</title> <para> <table frame="all"> - <title>Comparision of UserModule implementations</title> + <title>Comparison of UserModule implementations</title> <tgroup cols="3" align="left" colsep="1"> <colspec colname='c1'/> <colspec colname='c2'/> @@ -552,7 +552,7 @@ ]]> </programlisting> Pagination support is not widely implemented in LDAP servers. Because <emphasis>UserModule</emphasis> - implementations rely on JNDI and are targetted to be LDAP server agnostic those methods aren't very effecient. + implementations rely on JNDI and are targeted to be LDAP server agnostic those methods are not very efficient. As long as you don't rely on portal user management and use dedicated tools for user provisioning it shouldn't bother you. Otherwise you should consider extending the implementation and providing solution dedicated to your LDAP server.</para> @@ -665,7 +665,7 @@ <title>UserProfileModule</title> <section> <title>LDAPUserProfileModuleImpl</title> - <para>This is standard implementation that enables to retrieve user properties from atributes in LDAP entries.</para> + <para>This is standard implementation that enables to retrieve user properties from attributes in LDAP entries.</para> <para>To enable it in your configuration you should have: <programlisting><![CDATA[ <module> @@ -1156,7 +1156,7 @@ which means that if this single <emphasis>LoginModule</emphasis> return <emphasis>fail</emphasis> from authentication request whole process will fail. <emphasis>SynchronizingLoginModule</emphasis> has <emphasis>flag="optional"</emphasis>. Such combination is critical as - <emphasis>SynchronizingLoginModule</emphasis> always authenticates user sucessfully no matter what + <emphasis>SynchronizingLoginModule</emphasis> always authenticates user successfully no matter what credentials were provided. You always must have at least one <emphasis>LoginModule</emphasis> that you will rely on.</para> </listitem> Modified: docs/enterprise/trunk/Reference_Guide/en-US/Portal_API.xml =================================================================== --- docs/enterprise/trunk/Reference_Guide/en-US/Portal_API.xml 2011-07-26 00:56:11 UTC (rev 14006) +++ docs/enterprise/trunk/Reference_Guide/en-US/Portal_API.xml 2011-07-26 01:16:27 UTC (rev 14007) @@ -174,7 +174,7 @@ ... } ]]></programlisting> - <para>The interface offers methods to retrieve informations for a given node such as the node type, the node name + <para>The interface offers methods to retrieve information for a given node such as the node type, the node name or the properties of the node. The noticeable node types are:</para> <itemizedlist> <listitem><para>PortalNode.TYPE_PORTAL : the node represents a portal</para></listitem> @@ -274,12 +274,12 @@ <imagedata align="center" fileref="images/portalapi/PortalNodeEvent.png" scalefit="1"/> </imageobject> </mediaobject> - <para>The portal node event class hierarchy</para> + <para>The portal node event class hierarchy</para> - <para>The <emphasis>org.jboss.portal.api.node.event.PortalNodeEvent</emphasis> class extends the + <para>The <emphasis>org.jboss.portal.api.node.event.PortalNodeEvent</emphasis> class extends the <emphasis>org.jboss.portal.api.node.PortalEvent</emphasis> class and is the base class for all events of portal nodes. It defines a single method <emphasis>PortalNode getNode()</emphasis> which can be - used to retrieve the node targetted by the event.</para> + used to retrieve the node targeted by the event.</para> <para>The <emphasis>org.jboss.portal.api.node.event.WindowEvent</emphasis> is an extension for portal nodes of type window. It provides access to the mode and window state of the window. It has 3 subclasses which represent different kind of event that can target windows.</para> @@ -308,9 +308,9 @@ <imagedata align="center" fileref="images/portalapi/eventpropagation.png" /> </imageobject> </mediaobject> - <para>The portal node event propagation model</para> + <para>The portal node event propagation model</para> - + </section> <section> <title>Portal node event listener</title> @@ -332,9 +332,9 @@ <imagedata align="center" fileref="images/portalapi/PortalNodeEventContext.png" /> </imageobject> </mediaobject> - <para>The PortalNodeEventContext interface</para> + <para>The PortalNodeEventContext interface</para> - <para>The <emphasis>org.jboss.portal.api.node.event.PortalNodeEventContext</emphasis> interface extends + <para>The <emphasis>org.jboss.portal.api.node.event.PortalNodeEventContext</emphasis> interface extends the <emphasis>PortalEventContext</emphasis> interface and plays an important role in the event delivery model explained in the previous section. That interface gives full control over the delivery of the event to ascendant nodes in the hierarchy, even more it gives the possibility to replace @@ -363,9 +363,9 @@ <imagedata align="center" fileref="images/portalapi/PortalSessionEvent.png" /> </imageobject> </mediaobject> - <para>The PortalSessionEvent class</para> + <para>The PortalSessionEvent class</para> - <para>There are two different types of events: + <para>There are two different types of events: <itemizedlist> <listitem><para>org.jboss.portal.api.session.event.PortalSessionEvent.SESSION_CREATED, fired when a new portal session is created</para></listitem> <listitem><para>org.jboss.portal.api.session.event.PortalSessionEvent.SESSION_DESTROYED, fired when a new portal session is destroyed</para></listitem> @@ -383,9 +383,9 @@ </imageobject> </mediaobject> - <para>The UserEvent class and UserAuthenticationEvent sub-classes</para> - - <para>The UserAuthenticationEvent triggers two events that can be catched: + <para>The UserEvent class and UserAuthenticationEvent sub-classes</para> + + <para>The UserAuthenticationEvent triggers two events that can be caught: <itemizedlist> <listitem><para>org.jboss.portal.api.session.event.UserAuthenticationEvent.SIGN_IN, fired when a portal user signs in</para></listitem> <listitem><para>org.jboss.portal.api.session.event.UserAuthenticationEvent.SIGN_OUT, fired when a portal user signs out</para></listitem> @@ -459,7 +459,7 @@ proxy-type="attribute">portal:service=ListenerRegistry</depends> <attribute name="RegistryId">counter_listener</attribute> <attribute name="ListenerClassName"> - org.jboss.portal.core.portlet.test.event.UserCounterListener + org.jboss.portal.core.portlet.test.event.UserCounterListener </attribute> </mbean> </server> Modified: docs/enterprise/trunk/Reference_Guide/en-US/Revision_History.xml =================================================================== --- docs/enterprise/trunk/Reference_Guide/en-US/Revision_History.xml 2011-07-26 00:56:11 UTC (rev 14006) +++ docs/enterprise/trunk/Reference_Guide/en-US/Revision_History.xml 2011-07-26 01:16:27 UTC (rev 14007) @@ -3,9 +3,23 @@ ]> <appendix id="appe-Publican-Revision_History"> - <title>Revision History</title> - <simpara> - <revhistory> + <title>Revision History</title> + <simpara> + <revhistory> + <revision> + <revnumber>1-1.10</revnumber> + <date>Fri Jul 15 2011</date> + <author> + <firstname>Scott</firstname> + <surname>Mumford</surname> + <email></email> + </author> + <revdescription> + <simplelist> + <member>Updated old and broken hyperlinks.</member> + </simplelist> + </revdescription> + </revision> <revision> <revnumber>1-1.9</revnumber> <date>Fri Apr 08 2011</date> @@ -20,79 +34,79 @@ </simplelist> </revdescription> </revision> - <revision> - <revnumber>1-1.8</revnumber> - <date>Tue Oct 26 2010</date> - <author> - <firstname>Scott</firstname> - <surname>Mumford</surname> - <email&gt;smumford(a)redhat.com&lt;/email&gt; - </author> - <revdescription> - <simplelist> - <member>Rebuilt for new Publican version features.</member> - </simplelist> - </revdescription> - </revision> + <revision> + <revnumber>1-1.8</revnumber> + <date>Tue Oct 26 2010</date> + <author> + <firstname>Scott</firstname> + <surname>Mumford</surname> + <email&gt;smumford(a)redhat.com&lt;/email&gt; + </author> + <revdescription> + <simplelist> + <member>Rebuilt for new Publican version features.</member> + </simplelist> + </revdescription> + </revision> - <revision> - <revnumber>1-1.7</revnumber> - <date>Thu Oct 21 2010</date> - <author> - <firstname>Scott</firstname> - <surname>Mumford</surname> - <email&gt;smumford(a)redhat.com&lt;/email&gt; - </author> - <revdescription> - <simplelist> - <member>Add Revision History.</member> - </simplelist> - </revdescription> - </revision> + <revision> + <revnumber>1-1.7</revnumber> + <date>Thu Oct 21 2010</date> + <author> + <firstname>Scott</firstname> + <surname>Mumford</surname> + <email&gt;smumford(a)redhat.com&lt;/email&gt; + </author> + <revdescription> + <simplelist> + <member>Add Revision History.</member> + </simplelist> + </revdescription> + </revision> - <revision> - <revnumber>1-1.6</revnumber> - <date>Mon Oct 11 2010</date> - <author> - <firstname>Scott</firstname> - <surname>Mumford</surname> - <email&gt;smumford(a)redhat.com&lt;/email&gt; - </author> - <revdescription> - <simplelist> - <member>Edit Product version number for publishing restructure.</member> - </simplelist> - </revdescription> - </revision> - <revision> - <revnumber>1-1.5</revnumber> - <date>Wed Nov 14 2009</date> - <author> - <firstname></firstname> - <surname></surname> - <email></email> - </author> - <revdescription> - <simplelist> - <member>Updated for 4.3 CP05 release.</member> - </simplelist> - </revdescription> - </revision> + <revision> + <revnumber>1-1.6</revnumber> + <date>Mon Oct 11 2010</date> + <author> + <firstname>Scott</firstname> + <surname>Mumford</surname> + <email&gt;smumford(a)redhat.com&lt;/email&gt; + </author> + <revdescription> + <simplelist> + <member>Edit Product version number for publishing restructure.</member> + </simplelist> + </revdescription> + </revision> + <revision> + <revnumber>1-1.5</revnumber> + <date>Wed Nov 14 2009</date> + <author> + <firstname></firstname> + <surname></surname> + <email></email> + </author> + <revdescription> + <simplelist> + <member>Updated for 4.3 CP05 release.</member> + </simplelist> + </revdescription> + </revision> <revision> - <revnumber>1-1.0</revnumber> - <date>Wed Nov 05 2008</date> - <author> - <firstname></firstname> - <surname></surname> - <email></email> - </author> - <revdescription> - <simplelist> - <member>Initial Creation of book.</member> - </simplelist> - </revdescription> - </revision> - </revhistory> - </simpara> + <revnumber>1-1.0</revnumber> + <date>Wed Nov 05 2008</date> + <author> + <firstname></firstname> + <surname></surname> + <email></email> + </author> + <revdescription> + <simplelist> + <member>Initial Creation of book.</member> + </simplelist> + </revdescription> + </revision> + </revhistory> + </simpara> </appendix> Modified: docs/enterprise/trunk/Reference_Guide/en-US/Security.xml =================================================================== --- docs/enterprise/trunk/Reference_Guide/en-US/Security.xml 2011-07-26 00:56:11 UTC (rev 14006) +++ docs/enterprise/trunk/Reference_Guide/en-US/Security.xml 2011-07-26 01:16:27 UTC (rev 14007) @@ -78,34 +78,34 @@ </para> <itemizedlist> <listitem> - <para> <emphasis role="bold">&lt;unchecked/&gt;</emphasis> - Anyone can view this page.</para> + <para> <emphasis role="bold">&lt;unchecked/&gt;</emphasis> + Anyone can view this page.</para> </listitem> <listitem> - <para> <emphasis role="bold">&lt;role-name&gt;SOMEROLE&lt;/role-name&gt;</emphasis> - Access to this page is limited to the defined role.</para> + <para> <emphasis role="bold">&lt;role-name&gt;SOMEROLE&lt;/role-name&gt;</emphasis> + Access to this page is limited to the defined role.</para> </listitem> </itemizedlist> - <para> + <para> <emphasis role="bold">Access Rights:</emphasis> You must define the access rights given to the role defined. Possible values are: </para> <itemizedlist> <listitem> - <para> <emphasis role="bold">view</emphasis> - Users can view the page.</para> + <para> <emphasis role="bold">view</emphasis> + Users can view the page.</para> </listitem> <listitem> - <para> <emphasis role="bold">viewrecursive</emphasis> - Users can view the page and child pages.</para> + <para> <emphasis role="bold">viewrecursive</emphasis> + Users can view the page and child pages.</para> </listitem> <listitem> - <para><emphasis role="bold">personalize</emphasis> - Users are able to personalize the page's theme.</para> + <para><emphasis role="bold">personalize</emphasis> + Users are able to personalize the page's theme.</para> </listitem> <listitem> - <para> <emphasis role="bold">personalizerecursive</emphasis> - Users are able to personalize the page AND its children's pages themes.</para> + <para> <emphasis role="bold">personalizerecursive</emphasis> + Users are able to personalize the page AND its children's pages themes.</para> </listitem> </itemizedlist> @@ -116,7 +116,7 @@ must be changed from viewrecursive to view, and viewrecursive security constraints must be added to its children so that they can be viewed except the one you want to restrict access to.</para> </note> - <para> + <para> We provide three live samples of this descriptor, here <xref linkend="desc_instancesxml"/> , @@ -133,19 +133,19 @@ considered to be CMS resources that can be secured based on portal Roles and/or Users. </para> <para> - The following features are supported by the fine grained security system of Portal CMS: - <itemizedlist> - <listitem><para> - You can associate "Read", "Write", and "Manage" Permissions at the CMS node level. (Both Files and Folders are treated as CMS nodes)</para> + The following features are supported by the fine grained security system of Portal CMS: + <itemizedlist> + <listitem><para> + You can associate "Read", "Write", and "Manage" Permissions at the CMS node level. (Both Files and Folders are treated as CMS nodes)</para> </listitem> <listitem> - <para>The Permissions are propagated recursively down a folder hierarchy</para> + <para>The Permissions are propagated recursively down a folder hierarchy</para> </listitem> <listitem> - <para> Any Permissions specified explicitly on the CMS Node overrides the policy inherited via recursive propagation</para> + <para> Any Permissions specified explicitly on the CMS Node overrides the policy inherited via recursive propagation</para> </listitem> <listitem> - <para>You can manage the Permissions using the CMS Admin GUI tool via the newly added "Secure Node" feature</para> + <para>You can manage the Permissions using the CMS Admin GUI tool via the newly added "Secure Node" feature</para> </listitem> </itemizedlist> </para> @@ -153,156 +153,156 @@ <table frame="all"> <title> Portal CMS Permission Matrix: </title> <tgroup cols="3" align="left" colsep="1" > - - <thead> - <row> - <entry align="center">Permissions</entry> - <entry align="center">Allowed Actions</entry> - <entry align="center">Implies</entry> - </row> - </thead> - <tbody> - <row> - <entry> Read </entry> - <entry> Read Contents of Folder, File and its versions </entry> - <entry> N/A </entry> - </row> - <row> - <entry> Write</entry> - <entry> Create and Update new Folder and File </entry> - <entry> Read Access </entry> - </row> - <row> - <entry> Manage </entry> - <entry> Delete/Copy/Move/Rename Folders and Files</entry> - <entry> Read and Write Access </entry> - </row> - </tbody> - </tgroup> - </table> - </para> + + <thead> + <row> + <entry align="center">Permissions</entry> + <entry align="center">Allowed Actions</entry> + <entry align="center">Implies</entry> + </row> + </thead> + <tbody> + <row> + <entry> Read </entry> + <entry> Read Contents of Folder, File and its versions </entry> + <entry> N/A </entry> + </row> + <row> + <entry> Write</entry> + <entry> Create and Update new Folder and File </entry> + <entry> Read Access </entry> + </row> + <row> + <entry> Manage </entry> + <entry> Delete/Copy/Move/Rename Folders and Files</entry> + <entry> Read and Write Access </entry> + </row> + </tbody> + </tgroup> + </table> + </para> <section id="security.security_cms_configuration"> <title>CMS Security Configuration</title> <para> The configuration for the CMS Security service is specified in the <literal>jboss-portal.sar/portal-cms.sar/META-INF/jboss-service.xml</literal> file. The portion of the configuration relevant for securing the CMS service is listed as follows: - <programlisting> - <![CDATA[ - <!-- CMS Authorization Security Service --> - <mbean - code="org.jboss.portal.cms.security.AuthorizationManagerImpl" - name="portal:service=AuthorizationManager,type=cms" - xmbean-dd="" - xmbean-code="org.jboss.portal.jems.as.system.JBossServiceModelMBean"> - <xmbean/> - <attribute name="JNDIName">java:portal/cms/AuthorizationManager</attribute> - <depends optional-attribute-name="Provider" proxy-type="attribute"> - portal:service=AuthorizationProvider,type=cms - </depends> - </mbean> - <mbean - code="org.jboss.portal.cms.security.AuthorizationProviderImpl" - name="portal:service=AuthorizationProvider,type=cms" - xmbean-dd="" - xmbean-code="org.jboss.portal.jems.as.system.JBossServiceModelMBean"> - <xmbean/> - <!-- - NOTE: cmsRootUserName denotes a single Portal user that has access to everything in the CMS. Denote this user - carefully and should be synonymous to the 'root' user in UNIX operating systems. By default: this value is the built-in - 'admin' user account. This can be changed to any other user account registered in your Portal - --> - <attribute name="CmsRootUserName">admin</attribute> - <depends optional-attribute-name="IdentityServiceController" proxy-type="attribute">portal:service=Module,type=IdentityServiceController</depends> - </mbean> - <!-- ACL Security Interceptor --> - <mbean - code="org.jboss.portal.cms.impl.interceptors.ACLInterceptor" - name="portal:service=Interceptor,type=Cms,name=ACL" - xmbean-dd="" - xmbean-code="org.jboss.portal.jems.as.system.JBossServiceModelMBean"> - <xmbean/> - <attribute name="JNDIName">java:/portal/cms/ACLInterceptor</attribute> - <attribute name="CmsSessionFactory">java:/portal/cms/CMSSessionFactory</attribute> - <attribute name="IdentitySessionFactory">java:/portal/IdentitySessionFactory</attribute> - <attribute name="DefaultPolicy"> - <policy> - <!-- permissions on the root cms node --> - <criteria name="path" value="/"> - <permission name="cms" action="read"> - <role name="Anonymous"/> - </permission> - <permission name="cms" action="write"> - <role name="User"/> - </permission> - <permission name="cms" action="manage"> - <role name="Admin"/> - </permission> - </criteria> - <!-- permissions on the default cms node --> - <criteria name="path" value="/default"> - <permission name="cms" action="read"> - <role name="Anonymous"/> - </permission> - <permission name="cms" action="write"> - <role name="User"/> - </permission> - <permission name="cms" action="manage"> - <role name="Admin"/> - </permission> - </criteria> - <!-- permissions on the private/protected node --> - <criteria name="path" value="/default/private"> - <permission name="cms" action="manage"> - <role name="Admin"/> - </permission> - </criteria> - </policy> - </attribute> - <depends optional-attribute-name="AuthorizationManager" proxy-type="attribute"> - portal:service=AuthorizationManager,type=cms - </depends> - <depends>portal:service=Hibernate,type=CMS</depends> - <depends>portal:service=Module,type=IdentityServiceController</depends> - </mbean>]]> - </programlisting> - </para> - <section id="security.security_cms_configuration_superuser"> - <title>CMS Super User</title> - <para> - A CMS Super User is a designated Portal User Account that has access to all resources/functions in the CMS. It is a concept similar to the - super user concept in a Linux and UNIX security systems. This account should be carefully used and properly protected. By default, JBoss Portal designates the - built-in 'admin' user account as a CMS Super User. This can be changed by modifying the <emphasis>cmsRootUserName</emphasis> value in the - <literal>jboss-portal.sar/portal-cms.sar/META-INF/jboss-service.xml</literal> configuration. - <programlisting> - <![CDATA[ - <mbean - code="org.jboss.portal.cms.security.AuthorizationProviderImpl" - name="portal:service=AuthorizationProvider,type=cms" - xmbean-dd="" - xmbean-code="org.jboss.portal.jems.as.system.JBossServiceModelMBean"> - <xmbean/> - <!-- - NOTE: cmsRootUserName denotes a single Portal user that has access to everything in the CMS. Denote this user - carefully and should be synonymous to the 'root' user in UNIX operating systems. By default: this value is the built-in - 'admin' user account. This can be changed to any other user account registered in your Portal - --> - <attribute name="CmsRootUserName">admin</attribute> - <depends optional-attribute-name="IdentityServiceController" proxy-type="attribute">portal:service=Module,type=IdentityServiceController</depends> - </mbean> - ]]> - </programlisting> - </para> - </section> - <section id="security.security_cms_configuration_securityconsole"> - <title>CMS Security Console</title> - <para> - The CMS Security Console is used to assign proper permissions to all the nodes/content in the CMS. Besides protection on CMS content, this console itself - needs to be secured against unauthorized acceess. Currently, the console can be accessed only by Portal users that are members of the specified Role. By default, - JBoss Portal uses the built-in <emphasis>Admin</emphasis> role to allow access to this security console. This can be customized by modifying the value of - <emphasis>defaultAdminRole</emphasis> option specified in <literal>jboss-portal.sar/conf/identity/standardidentity-config.xml</literal> - </para> - </section> + <programlisting> + <![CDATA[ + <!-- CMS Authorization Security Service --> + <mbean + code="org.jboss.portal.cms.security.AuthorizationManagerImpl" + name="portal:service=AuthorizationManager,type=cms" + xmbean-dd="" + xmbean-code="org.jboss.portal.jems.as.system.JBossServiceModelMBean"> + <xmbean/> + <attribute name="JNDIName">java:portal/cms/AuthorizationManager</attribute> + <depends optional-attribute-name="Provider" proxy-type="attribute"> + portal:service=AuthorizationProvider,type=cms + </depends> + </mbean> + <mbean + code="org.jboss.portal.cms.security.AuthorizationProviderImpl" + name="portal:service=AuthorizationProvider,type=cms" + xmbean-dd="" + xmbean-code="org.jboss.portal.jems.as.system.JBossServiceModelMBean"> + <xmbean/> + <!-- + NOTE: cmsRootUserName denotes a single Portal user that has access to everything in the CMS. Denote this user + carefully and should be synonymous to the 'root' user in UNIX operating systems. By default: this value is the built-in + 'admin' user account. This can be changed to any other user account registered in your Portal + --> + <attribute name="CmsRootUserName">admin</attribute> + <depends optional-attribute-name="IdentityServiceController" proxy-type="attribute">portal:service=Module,type=IdentityServiceController</depends> + </mbean> + <!-- ACL Security Interceptor --> + <mbean + code="org.jboss.portal.cms.impl.interceptors.ACLInterceptor" + name="portal:service=Interceptor,type=Cms,name=ACL" + xmbean-dd="" + xmbean-code="org.jboss.portal.jems.as.system.JBossServiceModelMBean"> + <xmbean/> + <attribute name="JNDIName">java:/portal/cms/ACLInterceptor</attribute> + <attribute name="CmsSessionFactory">java:/portal/cms/CMSSessionFactory</attribute> + <attribute name="IdentitySessionFactory">java:/portal/IdentitySessionFactory</attribute> + <attribute name="DefaultPolicy"> + <policy> + <!-- permissions on the root cms node --> + <criteria name="path" value="/"> + <permission name="cms" action="read"> + <role name="Anonymous"/> + </permission> + <permission name="cms" action="write"> + <role name="User"/> + </permission> + <permission name="cms" action="manage"> + <role name="Admin"/> + </permission> + </criteria> + <!-- permissions on the default cms node --> + <criteria name="path" value="/default"> + <permission name="cms" action="read"> + <role name="Anonymous"/> + </permission> + <permission name="cms" action="write"> + <role name="User"/> + </permission> + <permission name="cms" action="manage"> + <role name="Admin"/> + </permission> + </criteria> + <!-- permissions on the private/protected node --> + <criteria name="path" value="/default/private"> + <permission name="cms" action="manage"> + <role name="Admin"/> + </permission> + </criteria> + </policy> + </attribute> + <depends optional-attribute-name="AuthorizationManager" proxy-type="attribute"> + portal:service=AuthorizationManager,type=cms + </depends> + <depends>portal:service=Hibernate,type=CMS</depends> + <depends>portal:service=Module,type=IdentityServiceController</depends> + </mbean>]]> + </programlisting> + </para> + <section id="security.security_cms_configuration_superuser"> + <title>CMS Super User</title> + <para> + A CMS Super User is a designated Portal User Account that has access to all resources/functions in the CMS. It is a concept similar to the + super user concept in a Linux and UNIX security systems. This account should be carefully used and properly protected. By default, JBoss Portal designates the + built-in 'admin' user account as a CMS Super User. This can be changed by modifying the <emphasis>cmsRootUserName</emphasis> value in the + <literal>jboss-portal.sar/portal-cms.sar/META-INF/jboss-service.xml</literal> configuration. + <programlisting> + <![CDATA[ + <mbean + code="org.jboss.portal.cms.security.AuthorizationProviderImpl" + name="portal:service=AuthorizationProvider,type=cms" + xmbean-dd="" + xmbean-code="org.jboss.portal.jems.as.system.JBossServiceModelMBean"> + <xmbean/> + <!-- + NOTE: cmsRootUserName denotes a single Portal user that has access to everything in the CMS. Denote this user + carefully and should be synonymous to the 'root' user in UNIX operating systems. By default: this value is the built-in + 'admin' user account. This can be changed to any other user account registered in your Portal + --> + <attribute name="CmsRootUserName">admin</attribute> + <depends optional-attribute-name="IdentityServiceController" proxy-type="attribute">portal:service=Module,type=IdentityServiceController</depends> + </mbean> + ]]> + </programlisting> + </para> + </section> + <section id="security.security_cms_configuration_securityconsole"> + <title>CMS Security Console</title> + <para> + The CMS Security Console is used to assign proper permissions to all the nodes/content in the CMS. Besides protection on CMS content, this console itself + needs to be secured against unauthorized access. Currently, the console can be accessed only by Portal users that are members of the specified Role. By default, + JBoss Portal uses the built-in <emphasis>Admin</emphasis> role to allow access to this security console. This can be customized by modifying the value of + <emphasis>defaultAdminRole</emphasis> option specified in <literal>jboss-portal.sar/conf/identity/standardidentity-config.xml</literal> + </para> + </section> </section> </section> @@ -315,19 +315,19 @@ related to web applications. The main entry point of the whole portal is the <emphasis>jboss-portal.sar/portal-server.war</emphasis> deployment which is the web application that defines and maps the portal servlet. Here you can configure various things <itemizedlist> - <listitem><para>In the <emphasis>WEB-INF/web.xml</emphasis> you can change the authentication mode. The default + <listitem><para>In the <emphasis>WEB-INF/web.xml</emphasis> you can change the authentication mode. The default authentication mechanism uses the form based authentication, however you can change it to any of the - mechanism provided by the servlet specification.</para></listitem> + mechanism provided by the servlet specification.</para></listitem> <listitem><para>In the <emphasis>WEB-INF/jboss-web.xml</emphasis> you can change the security domain used by the portal. The default security domain used by the portal is <emphasis>java:/jaas/portal</emphasis>. That setting is specific to the JBoss Application Server and how it binds the Java EE security to the operational environment. A security domain is a scope defined at the Application Server Level and defines usually a JAAS authentication stack. The portal security domain authentication stack is defined in the <emphasis>jboss-portal.sar/conf/login-config.xml</emphasis> and is dynamically deployed with the portal. The JBoss Application Server documentation is certainly the best - reference for that topic.</para> + reference for that topic.</para> </listitem> - <listitem><para>The files <emphasis>login.jsp</emphasis> and <emphasis>error.jsp</emphasis> represent the pages used - the form based authentication process. More information can be found in any good servlet documentation.</para></listitem> + <listitem><para>The files <emphasis>login.jsp</emphasis> and <emphasis>error.jsp</emphasis> represent the pages used + the form based authentication process. More information can be found in any good servlet documentation.</para></listitem> </itemizedlist> </para> </section> @@ -335,23 +335,23 @@ <title>The portal servlet</title> <para>The portal defines a single servlet to take care of all portal requests. The class name of that servlet is <emphasis>org.jboss.portal.server.servlet.PortalServlet</emphasis>. That servlet needs to be declared two times with different - configurations otherwise the portal would not be able to know about some request details which are importants. + configurations otherwise the portal would not be able to know about some request details which are important. <itemizedlist> - <listitem><para><emphasis>PortalServletWithPathMapping</emphasis> is used for path mapping mappings.</para></listitem> - <listitem><para><emphasis>PortalServletWithDefaultServletMapping</emphasis> is used for the default servlet mapping.</para></listitem> + <listitem><para><emphasis>PortalServletWithPathMapping</emphasis> is used for path mapping mappings.</para></listitem> + <listitem><para><emphasis>PortalServletWithDefaultServletMapping</emphasis> is used for the default servlet mapping.</para></listitem> </itemizedlist> The portal servlet is mapped four times with different semantics, the differences between the semantics are related to the transport layer. Each one of those for mappings will have the same request meaning for the portal beside the transport aspect. By default those mappings are <itemizedlist> - <listitem><para><emphasis>/*</emphasis> : the default access, does not define any security constraint. This is the default - access that everybody uses.</para></listitem> - <listitem><para><emphasis>/sec/*</emphasis> : the secured access, requires https usage. It is triggered when + <listitem><para><emphasis>/*</emphasis> : the default access, does not define any security constraint. This is the default + access that everybody uses.</para></listitem> + <listitem><para><emphasis>/sec/*</emphasis> : the secured access, requires https usage. It is triggered when a portlet is defined as secure or when a secure portlet link is created. It requires the configuration of the https connector in JBoss Web. The JBoss Application Server documentation provides more information - about it.</para></listitem> + about it.</para></listitem> <listitem><para><emphasis>/auth/*</emphasis> : the authenticated access, requires the user to be authenticated - to be used.</para></listitem> + to be used.</para></listitem> <listitem><para><emphasis>/authsec/*</emphasis> : combine the two previous options into a single one.</para></listitem> </itemizedlist> Usually ones should not care much about those mappings as the portal will by itself switch to the most appropriate mapping. @@ -372,10 +372,10 @@ class and any permission checked in the portal should extend the <emphasis>PortalPermission</emphasis> as well. That permission adds two fields to the <emphasis>Permission</emphasis> class <itemizedlist> - <listitem><para>uri : is a string which represents an URI of the resource described by the permission.</para></listitem> - <listitem><para>collection : an object of class <emphasis>org.jboss.portal.security.PortalPermissionCollection</emphasis> which + <listitem><para>uri : is a string which represents an URI of the resource described by the permission.</para></listitem> + <listitem><para>collection : an object of class <emphasis>org.jboss.portal.security.PortalPermissionCollection</emphasis> which is used when the permission act as a container for other permissions. If that object exists then the uri field should be null - as a portal permission represents an uri or acts as a container in an exclusive manner.</para></listitem> + as a portal permission represents an uri or acts as a container in an exclusive manner.</para></listitem> </itemizedlist> </para> </section> @@ -393,13 +393,13 @@ } </programlisting> <itemizedlist> - <listitem><para><emphasis>org.jboss.portal.security.spi.provider.DomainConfigurator</emphasis> provides configuration access - to an authorization domain. The authorization schema is very simple as it consists of bindings between URI, roles and permissions.</para></listitem> - <listitem><para><emphasis>org.jboss.portal.security.spi.provider.PermissionRepository</emphasis> provides runtime access to the authorization + <listitem><para><emphasis>org.jboss.portal.security.spi.provider.DomainConfigurator</emphasis> provides configuration access + to an authorization domain. The authorization schema is very simple as it consists of bindings between URI, roles and permissions.</para></listitem> + <listitem><para><emphasis>org.jboss.portal.security.spi.provider.PermissionRepository</emphasis> provides runtime access to the authorization domain. Usually it is used to retrieve the permissions for a specific role and URI. It is used at runtime by the framework - to take security decisions.</para></listitem> + to take security decisions.</para></listitem> <listitem><para><emphasis>org.jboss.portal.security.spi.provider.PermissionFactory</emphasis> is a factory to instantiate permissions - for the specific domain. It is used at runtime to create permissions objects of the appropriate type by the security framework.</para></listitem> + for the specific domain. It is used at runtime to create permissions objects of the appropriate type by the security framework.</para></listitem> </itemizedlist> </para> </section> @@ -417,7 +417,7 @@ <mbean code='MyService" name="portal:service=MyService"> - <depends + <depends optional-attribute-name="PortalAuthorizationManagerFactory" proxy-type="attribute">portal:service=PortalAuthorizationManagerFactory</depends> ... Modified: docs/enterprise/trunk/Reference_Guide/en-US/Theme_And_Layouts.xml =================================================================== --- docs/enterprise/trunk/Reference_Guide/en-US/Theme_And_Layouts.xml 2011-07-26 00:56:11 UTC (rev 14006) +++ docs/enterprise/trunk/Reference_Guide/en-US/Theme_And_Layouts.xml 2011-07-26 01:16:27 UTC (rev 14007) @@ -46,17 +46,17 @@ effectively the same for all the pages of a portal, it makes sense to encapsulate it in its own entity. </para> - <para>To implement this encapsulation there are several ways:</para> - <itemizedlist> + <para>To implement this encapsulation there are several ways:</para> + <itemizedlist> - <listitem><para>JSP pages that get included from the layout JSP for each region/portlet</para></listitem> - <listitem><para>a taglib that allows to place region, window, and decoration tags into the layout JSP</para> + <listitem><para>JSP pages that get included from the layout JSP for each region/portlet</para></listitem> + <listitem><para>a taglib that allows to place region, window, and decoration tags into the layout JSP</para> </listitem> - <listitem><para>a taglib that uses a pluggable API to delegate the markup generation to a set of classes</para> + <listitem><para>a taglib that uses a pluggable API to delegate the markup generation to a set of classes</para> </listitem> </itemizedlist> - - <para> + + <para> In JBoss Portal you can currently see two out of these approaches, namely the first and the last. Examples for the first can be found in the portal-core.war, implemented by the nodesk and phalanx layouts. Examples for the third approach can be found @@ -64,15 +64,15 @@ markup generation for each region, window, and portlet decoration in this last approach is what's called the RenderSet. </para> - <para>The RenderSet consist of four interfaces that correspond with the four markup - containers that wrap the markup fragments of one of more portlets: + <para>The RenderSet consist of four interfaces that correspond with the four markup + containers that wrap the markup fragments of one of more portlets: </para> <itemizedlist> - <listitem><para>Region</para></listitem> - <listitem><para>Window</para></listitem> - <listitem><para>Decoration</para></listitem> - <listitem><para>Portlet Content</para></listitem> + <listitem><para>Region</para></listitem> + <listitem><para>Window</para></listitem> + <listitem><para>Decoration</para></listitem> + <listitem><para>Portlet Content</para></listitem> </itemizedlist> <para>While we want to leave it open to you to decide which way to implement your layouts and @@ -109,7 +109,7 @@ <section> <title>Overview</title> <para>The default header is divided into two parts, links to pages displayed as tabs and links - to navigate between portals and dahsboards as well as loggin in and out. Those two parts are + to navigate between portals and dashboards as well as logging in and out. Those two parts are included into the template thanks to the layout as defined in <xref linkend="layouts"/>. In fact, the region named, <literal>dashboardnav</literal> will include the navigation links, while the region named <literal>navigation</literal> will include the navigation tabs. @@ -121,22 +121,22 @@ <imagedata fileref="images/themeguide/portal-header.gif" scalefit="1"/> </imageobject> </mediaobject> - <para>Screenshot of the header with the 'renaissance' theme</para> + <para>Screenshot of the header with the 'renaissance' theme</para> <note><title>Note</title><para>Here, we use split content from rendering by using a CSS style sheet, it allows us to change the - display by switching the CSS without affecting the content. THe Maple theme will display the links - on the left side with a different font for example. THis is up to you to choose or not this approach</para> + display by switching the CSS without affecting the content. The Maple theme will display the links + on the left side with a different font for example. This is up to you to choose or not this approach</para> </note> <para>To customize the header there are several options detailed after. <itemizedlist> - <listitem><para>The first option would simply require to modify + <listitem><para>The first option would simply require to modify the theme CSS, by doing this you could change the fonts, the way tabs are rendered, colors and many - other things but not change the content.</para></listitem> + other things but not change the content.</para></listitem> <listitem><para>The second option is to modify the provided JSP files, <literal>header.jsp</literal> and <literal>tabs.jsp</literal>. It gives you more flexibility than the previous solution on modifying the content. Links to legacy application could easily be added, URLs could be arranged differently, the CSS approach could be replaced by good old HTML, CSS style names could be changed... The drawback of - this method compare to the next one is the limitation in what is accessible from the JSP.</para></listitem> + this method compare to the next one is the limitation in what is accessible from the JSP.</para></listitem> <!-- listitem>The third option is the most flexible and let you inject whatever you want, it consists in replacing the default <literal>PageCustomizerInterceptor</literal> by your own.</listitem--> </itemizedlist> @@ -167,22 +167,22 @@ </mbean>]]></programlisting> The three attributes are: <itemizedlist> - <listitem><para>TargetContextPath: Defines the web application context where the JSP files are located</para></listitem> - <listitem><para>HeaderPath: Defines the location (in the web application previously defined) of the JSP in charge of writing the header links</para></listitem> - <listitem><para>TabsPath: Defines the location (in the web application previously defined) of the JSP in charge of writing the pages links (note that it doesn't have to be renderer as tabs)</para></listitem> + <listitem><para>TargetContextPath: Defines the web application context where the JSP files are located</para></listitem> + <listitem><para>HeaderPath: Defines the location (in the web application previously defined) of the JSP in charge of writing the header links</para></listitem> + <listitem><para>TabsPath: Defines the location (in the web application previously defined) of the JSP in charge of writing the pages links (note that it doesn't have to be renderer as tabs)</para></listitem> </itemizedlist> </para> <para>Writing the header JSP</para> <para>A couple of request attributes are set so that they can be used by the JSP, here is the list of attributes and their meaning: <itemizedlist> - <listitem><para><literal>org.jboss.portal.header.USER</literal>: A <literal>org.jboss.portal.identity.User</literal> object of the logged-in user, null if the user is not logged-in.</para></listitem> - <listitem><para><literal>org.jboss.portal.header.LOGIN_URL</literal>: URL to logging-in.</para></listitem> - <listitem><para><literal>org.jboss.portal.header.DASHBOARD_URL</literal>: URL to the dashboard, null if the user is already on the dashboard, null if the user is on the default portal already.</para></listitem> - <listitem><para><literal>org.jboss.portal.header.DEFAULT_PORTAL_URL</literal>: URL to the default page of the portal named 'default', null if the user is on the default portal already.</para></listitem> - <listitem><para><literal>org.jboss.portal.header.ADMIN_PORTAL_URL</literal>: URL to the default page of the admin portal (named 'admin'), null if the user is on the admin portal already.</para></listitem> - <listitem><para><literal>org.jboss.portal.header.EDIT_DASHBOARD_URL</literal>: URL to the page content editor of the dashboard, set only if the user is on the dashboard, null otherwise.</para></listitem> - <listitem><para><literal>org.jboss.portal.header.COPY_TO_DASHBOARD_URL</literal>: URL to copy a page from a portal to the personal dashboard, null if the user is on the dashboard.</para></listitem> - <listitem><para><literal>org.jboss.portal.header.SIGN_OUT_URL</literal>: URL to log out the portal.</para></listitem> + <listitem><para><literal>org.jboss.portal.header.USER</literal>: A <literal>org.jboss.portal.identity.User</literal> object of the logged-in user, null if the user is not logged-in.</para></listitem> + <listitem><para><literal>org.jboss.portal.header.LOGIN_URL</literal>: URL to logging-in.</para></listitem> + <listitem><para><literal>org.jboss.portal.header.DASHBOARD_URL</literal>: URL to the dashboard, null if the user is already on the dashboard, null if the user is on the default portal already.</para></listitem> + <listitem><para><literal>org.jboss.portal.header.DEFAULT_PORTAL_URL</literal>: URL to the default page of the portal named 'default', null if the user is on the default portal already.</para></listitem> + <listitem><para><literal>org.jboss.portal.header.ADMIN_PORTAL_URL</literal>: URL to the default page of the admin portal (named 'admin'), null if the user is on the admin portal already.</para></listitem> + <listitem><para><literal>org.jboss.portal.header.EDIT_DASHBOARD_URL</literal>: URL to the page content editor of the dashboard, set only if the user is on the dashboard, null otherwise.</para></listitem> + <listitem><para><literal>org.jboss.portal.header.COPY_TO_DASHBOARD_URL</literal>: URL to copy a page from a portal to the personal dashboard, null if the user is on the dashboard.</para></listitem> + <listitem><para><literal>org.jboss.portal.header.SIGN_OUT_URL</literal>: URL to log out the portal.</para></listitem> </itemizedlist> Every attribute that is an URL attribute is an object implementing the <emphasis>org.jboss.portal.api.PortalURL</emphasis> interface. Therefore it is possible to generate the URL using the <emphasis>toString()</emphasis> method and change various things related @@ -215,9 +215,9 @@ <para>Writing the tabs JSP</para> <para>A couple of request attributes are set so that they can be used by the JSP, here is the list of attributes and their meaning: <itemizedlist> - <listitem><para><literal>org.jboss.portal.api.PORTAL_NODE</literal>: A <literal>org.jboss.portal.api.node.PortalNode</literal> object of the root Portal node. Authorized children and siblings - of this object are accessible.</para></listitem> - <listitem><para><literal>org.jboss.portal.api.PORTAL_RUNTIME_CONTEXT</literal>: A <literal>org.jboss.portal.api.PortalRuntimeContext</literal> object that can be used to render URLs.</para></listitem> + <listitem><para><literal>org.jboss.portal.api.PORTAL_NODE</literal>: A <literal>org.jboss.portal.api.node.PortalNode</literal> object of the root Portal node. Authorized children and siblings + of this object are accessible.</para></listitem> + <listitem><para><literal>org.jboss.portal.api.PORTAL_RUNTIME_CONTEXT</literal>: A <literal>org.jboss.portal.api.PortalRuntimeContext</literal> object that can be used to render URLs.</para></listitem> </itemizedlist> </para> <para>The default file in charge of displaying the tabs can be found in: <literal>portal-core.war/WEB-INF/jsp/header/</literal></para> @@ -372,13 +372,13 @@ <para>The portal comes with a set of <trademark class="trade">JSP</trademark> tags that allow the layout developer faster development. </para> - <para>There are currently two taglibs, containing tags for different approaches to - layouts: + <para>There are currently two taglibs, containing tags for different approaches to + layouts: </para> <itemizedlist> - <listitem><para>portal-layout.tld</para></listitem> - <listitem><para>theme-basic-lib.tld</para></listitem> + <listitem><para>portal-layout.tld</para></listitem> + <listitem><para>theme-basic-lib.tld</para></listitem> </itemizedlist> <para>The theme-basic-lib.tld contains a list of tags that allow a JSP writer to access @@ -638,15 +638,15 @@ <para>A RenderSet consists of the implementations of four interfaces. Each of those interfaces corresponds to a markup container on the page. </para> - <para>Here are the four markup containers and their interface representation:</para> - <itemizedlist> + <para>Here are the four markup containers and their interface representation:</para> + <itemizedlist> - <listitem><para>Region - RegionRenderer</para></listitem> - <listitem><para>Window - WindowRenderer</para></listitem> - <listitem><para>Decoration - DecorationRenderer</para></listitem> - <listitem><para>Portlet Content - PortletRenderer</para></listitem> + <listitem><para>Region - RegionRenderer</para></listitem> + <listitem><para>Window - WindowRenderer</para></listitem> + <listitem><para>Decoration - DecorationRenderer</para></listitem> + <listitem><para>Portlet Content - PortletRenderer</para></listitem> </itemizedlist> - <para> + <para> All the renderer interfaces are specified in the org.jboss.portal.theme.render package. </para> @@ -1090,39 +1090,39 @@ <title>Overview</title> <note><title>Note</title><para>This section to be updated soon with new CSS selectors found in JBoss Portal 2.6. The current definitions remain, but the newer additions with regards to dashboards/drag-n-drop have not been - documented as of yet.</para> + documented as of yet.</para> </note> <para>This document outlines the different selectors used to handle the layout and look/feel of the Industrial theme included in the JBoss portal. </para> - <para>A couple of things to know about the theming approach discussed below:</para> - - <itemizedlist> + <para>A couple of things to know about the theming approach discussed below:</para> + + <itemizedlist> - <listitem><para>Main premise behind this approach was to provide a clean separation between + <listitem><para>Main premise behind this approach was to provide a clean separation between the business and presentation layer of the portal. As we go through each selector and explain the relation to the visual presentation on the page, this will become - more apparent.</para> + more apparent.</para> </listitem> - <listitem><para>The flexibility of the selectors used in the theme stylesheet allow a + <listitem><para>The flexibility of the selectors used in the theme stylesheet allow a designer to very easily customize the visual aspects of the portal, thereby taking the responsibility off of the developers hands through allowing the designer to quickly achieve the desired effect w/out the need to dive down into code and/or having to deploy changes to the portal. This saves time and allows both developers - and designers to focus on what they do best.</para> + and designers to focus on what they do best.</para> </listitem> - <listitem><para>This theme incorporates a liquid layout approach which allows elements on a + <listitem><para>This theme incorporates a liquid layout approach which allows elements on a page to expand/contract based on screen resolution and provides a consistent look across varying display settings. However, the stylesheet is adaptable to facilitate a fixed layout and/or combination approach where elements are pixel - based and completely independent of viewport.</para> + based and completely independent of viewport.</para> </listitem> - <listitem><para>The pieces that make up the portal theme consist of at least one stylesheet + <listitem><para>The pieces that make up the portal theme consist of at least one stylesheet and any associated images. Having a consolidated set of files to control the portal look and feel allows administrators to effortlessly swap themes on the fly. In addition, this clean separation of the pieces that make up a specific theme will enable sharing and collaboration of different themes by those looking to get - involved or contribute to the open source initiative.</para> + involved or contribute to the open source initiative.</para> </listitem> </itemizedlist> @@ -1131,7 +1131,7 @@ <title>Main Screen Shot</title> <para>Screen shot using color outline of main ID selectors used to control presentation and layout: - <mediaobject> + <mediaobject> <imageobject> <imagedata fileref="images/themeguide/selector-outline.gif" scalefit="1"/> </imageobject> @@ -1139,19 +1139,19 @@ </para> <itemizedlist> - <listitem><para>Red Border - portal-container</para></listitem> - <listitem><para>Yellow Border - header-container</para></listitem> - <listitem><para>Orange Border - content-container</para></listitem> - <listitem><para>Blue Border - regionA/regionB</para></listitem> - <listitem><para>Green Border - portlet-container</para></listitem> + <listitem><para>Red Border - portal-container</para></listitem> + <listitem><para>Yellow Border - header-container</para></listitem> + <listitem><para>Orange Border - content-container</para></listitem> + <listitem><para>Blue Border - regionA/regionB</para></listitem> + <listitem><para>Green Border - portlet-container</para></listitem> </itemizedlist> </section> <section> <title>List of CSS Selectors</title> - <para>The following is a list of the selectors used in the theme stylesheet, - including a brief explanation of how each selector is used in the portal: + <para>The following is a list of the selectors used in the theme stylesheet, + including a brief explanation of how each selector is used in the portal: </para> <itemizedlist> @@ -1202,11 +1202,11 @@ bottom and left sides of the header. Screenshot: - <mediaobject> + <mediaobject> <imageobject> <imagedata fileref="images/themeguide/portal-header.gif" scalefit="1"/> </imageobject> - </mediaobject> + </mediaobject> <programlisting>#header { height: 65px; @@ -1255,12 +1255,12 @@ of the portal, or a full width look as illustrated in the Industrial theme). Screenshot: - <mediaobject> + <mediaobject> <imageobject> <imagedata fileref="images/themeguide/region-selectors.gif" scalefit="1" /> </imageobject> - </mediaobject> - + </mediaobject> + <programlisting>/* min width for IE */ #expander { position: relative; @@ -1344,12 +1344,12 @@ controls the width of the region as well as its location on the page. Screenshot: - <mediaobject> + <mediaobject> <imageobject> <imagedata fileref="images/themeguide/regions.gif" scalefit="1"/> </imageobject> - </mediaobject> - + </mediaobject> + <programlisting> hr.cleaner { clear:both; @@ -1419,7 +1419,7 @@ <imagedata fileref="images/themeguide/portlet-titlebar-left.gif" /> </imageobject> - </mediaobject> + </mediaobject> <programlisting>.portlet-titlebar-center { background-image: url( images/portlet-top-middle.gif ); background-repeat: repeat-x; @@ -1567,7 +1567,7 @@ background-image: url( images/portlet-bottom-middle.gif ); height: 4px; background-repeat: repeat-x; - /* background-color:#FFFFFF; + /* background-color:#FFFFFF; border-bottom: 1px solid #98b7c6; height:5px; */ @@ -1846,7 +1846,7 @@ }</programlisting> Usage: Text that appears beside a "standard" icon (e.g - Ok, or Cancel). + OK, or Cancel). <programlisting>.portlet-form-field-label { font-family: Verdana, Arial, Helvetica, Sans-Serif, sans-serif; font-size: 10px; @@ -2087,39 +2087,39 @@ those CSS styles are provided by ajaxified layouts but it may not fit with some themes. It is possible to redefine them in the stylesheet of the themes.</para> <itemizedlist> - <listitem><para> + <listitem><para> <programlisting> .dyna-region {} </programlisting> Usage: - Denotes a dynamic region which can be subject to ajax capabilities.</para> + Denotes a dynamic region which can be subject to ajax capabilities.</para> </listitem> - <listitem><para> + <listitem><para> <programlisting> .dyna-window {} </programlisting> Usage: - Denotes a dynamic window which can be subject to ajax capabilities.</para> + Denotes a dynamic window which can be subject to ajax capabilities.</para> </listitem> - <listitem><para> + <listitem><para> <programlisting> .dyna-decoration {} </programlisting> Usage: - Denotes a dynamic decorator which can be subject to ajax capabilities.</para> + Denotes a dynamic decorator which can be subject to ajax capabilities.</para> </listitem> - <listitem><para> + <listitem><para> <programlisting> .dyna-portlet {} </programlisting> Usage: - Denotes a dynamic content which can be subject to ajax capabilities.</para> + Denotes a dynamic content which can be subject to ajax capabilities.</para> </listitem> - <listitem><para> + <listitem><para> <programlisting> .dnd-handle { cursor: move; @@ -2128,9 +2128,9 @@ Usage: Denotes the handle offered by draggable windows. By default it changes the mouse shape to indicate - to the user that his mouse is hovering a draggable window.</para> + to the user that his mouse is hovering a draggable window.</para> </listitem> - <listitem><para> + <listitem><para> <programlisting> .dnd-droppable { border: red 1px dashed; @@ -2140,7 +2140,7 @@ Usage: Denotes a zone where a user can drop a window during drag and drop operations. This selector is added - and removed dynamically at runtime by the ajax framework and is not present in the generated markup.</para> + and removed dynamically at runtime by the ajax framework and is not present in the generated markup.</para> </listitem> </itemizedlist> </section> Modified: docs/enterprise/trunk/Reference_Guide/en-US/Troubleshooting.xml =================================================================== --- docs/enterprise/trunk/Reference_Guide/en-US/Troubleshooting.xml 2011-07-26 00:56:11 UTC (rev 14006) +++ docs/enterprise/trunk/Reference_Guide/en-US/Troubleshooting.xml 2011-07-26 01:16:27 UTC (rev 14007) @@ -19,20 +19,20 @@ <listitem><para> <xref linkend="conf1"/> I am seeing "ERROR [JDBCExceptionReporter] Table not found in statement" in the logfile - on first boot. What is this?</para> + on first boot. What is this?</para> </listitem> - <listitem><para> + <listitem><para> <xref linkend="conf2"/> I want to do a clean install/upgrade over my existing one. What are the - steps?</para> + steps?</para> </listitem> - <listitem><para> - <xref linkend="conf3"/> Is my database vendor/version combination supported?</para> + <listitem><para> + <xref linkend="conf3"/> Is my database vendor/version combination supported?</para> </listitem> <listitem> - <para><xref linkend="conf4"/> How do I force the Hibernate Dialect used for my database?</para> + <para><xref linkend="conf4"/> How do I force the Hibernate Dialect used for my database?</para> </listitem> <listitem> - <para> <xref linkend="conf5"/> How do I change the context-root of the portal to http://localhost:8080/?</para> + <para> <xref linkend="conf5"/> How do I change the context-root of the portal to http://localhost:8080/?</para> </listitem> </itemizedlist> </para> @@ -40,13 +40,13 @@ <emphasis role="bold">CMS</emphasis> <itemizedlist> <listitem> - <para> <xref linkend="cms1"/>. How do I change the CMS repository configuration?</para> + <para> <xref linkend="cms1"/>. How do I change the CMS repository configuration?</para> </listitem> <listitem> - <para> <xref linkend="cms2"/>.On reboot, the CMS is complaining about a locked repository.</para> + <para> <xref linkend="cms2"/>.On reboot, the CMS is complaining about a locked repository.</para> </listitem> <listitem> - <para> <xref linkend="cms3"/>. I created a file in the CMSAdmin. How do I view it?</para> + <para> <xref linkend="cms3"/>. I created a file in the CMSAdmin. How do I view it?</para> </listitem> </itemizedlist> </para> @@ -54,11 +54,11 @@ <emphasis role="bold">Errors</emphasis> <itemizedlist> <listitem> - <para> <xref linkend="error1"/>. When I access a specific portal-instance or page, I keep seeing "401 - not - authorized" error in my browser.</para> + <para> <xref linkend="error1"/>. When I access a specific portal-instance or page, I keep seeing "401 - not + authorized" error in my browser.</para> </listitem> <listitem> - <para> <xref linkend="error2"/>. How do I disable development-mode errors on the presentation layer?</para> + <para> <xref linkend="error2"/>. How do I disable development-mode errors on the presentation layer?</para> </listitem> </itemizedlist> </para> @@ -66,9 +66,9 @@ <emphasis role="bold">Miscellaneous</emphasis> <itemizedlist> <listitem> - <para> <xref linkend="misc1"/>Is there a sample portlet I can look at to learn about portlet development and + <para> <xref linkend="misc1"/>Is there a sample portlet I can look at to learn about portlet development and JBoss - Portal deployments?</para> + Portal deployments?</para> </listitem> </itemizedlist> </para> @@ -89,10 +89,10 @@ <para > <emphasis role="bold">I want to do a clean install/upgrade over my existing one. What are the steps?</emphasis> <itemizedlist> - <listitem><para>Shut down JBoss AS</para></listitem> - <listitem><para>Delete JBOSS_HOME/server/default/data/portal</para></listitem> - <listitem><para>Delete all JBoss Portal tables from your database</para></listitem> - <listitem><para>Start JBoss AS.</para></listitem> + <listitem><para>Shut down JBoss AS</para></listitem> + <listitem><para>Delete JBOSS_HOME/server/default/data/portal</para></listitem> + <listitem><para>Delete all JBoss Portal tables from your database</para></listitem> + <listitem><para>Start JBoss AS.</para></listitem> </itemizedlist> </para> </section> @@ -134,7 +134,7 @@ <para> <emphasis role="bold">On reboot, the CMS is complaining about a locked repository.</emphasis> - This occurs when JBoss AS is improperly shutdown or the CMS Service errors on startup. To remove the lock, + This occurs when JBoss AS is improperly shutdown or the CMS Service errors on start up. To remove the lock, shutdown JBoss, and then remove the file under JBOSS_HOME/server/default/data/portal/cms/conf/.lock. </para> </section> @@ -143,14 +143,14 @@ <para> <emphasis role="bold">I created a file in the CMSAdmin. How do I view it?</emphasis> - Using the default configuration, the path to the file in the browser would be: + Using the default configuration, the path to the file in the browser would be: http://localhost:8080/portal/content/path/to/file.ext. Note that all requests for cms content must be prepended with /content and then followed by the path/to/the/file.gif as it is in your directory structure. </para> </section> - <section id="error1"><title>"401 - not authorised"</title> + <section id="error1"><title>"401 - not authorized"</title> <para> <emphasis role="bold">When I access a specific portal-instance or page, I keep seeing "401 - not authorized" error in my browser.</emphasis> @@ -174,12 +174,12 @@ </para> <itemizedlist> - <listitem><para>Sample portlets with tutorials can be found here, - <xref linkend="tutorials_tutorials"/></para> + <listitem><para>Sample portlets with tutorials can be found here, + <xref linkend="tutorials_tutorials"/></para> </listitem> - <listitem><para>Additional Portlets can be found at + <listitem><para>Additional Portlets can be found at <ulink url="http://www.portletswap.com">PortletSwap.com</ulink> - .</para> + .</para> </listitem> </itemizedlist> </section> Modified: docs/enterprise/trunk/Reference_Guide/en-US/Tutorials.xml =================================================================== --- docs/enterprise/trunk/Reference_Guide/en-US/Tutorials.xml 2011-07-26 00:56:11 UTC (rev 14006) +++ docs/enterprise/trunk/Reference_Guide/en-US/Tutorials.xml 2011-07-26 01:16:27 UTC (rev 14007) @@ -159,8 +159,8 @@ <imagedata fileref="images/tutorials/first_portlet/deployed.png" /> </imageobject> </mediaobject> - - SimplestHelloWorldPortlet deployed on a new page. + + SimplestHelloWorldPortlet deployed on a new page. </para> </section> @@ -323,7 +323,7 @@ method needs to be implemented, and the <literal>GenericPortlet</literal> <literal>render</literal> - implemention calls our implementation when the + implementation calls our implementation when the <literal>view</literal> mode is requested. </para> @@ -703,8 +703,8 @@ element being the path to the file in the CMS. This behavior is pluggable: you can plug in almost any type of content. </para> - <formalpara> - <title>Beware of context-path change</title> + <formalpara> + <title>Beware of context-path change</title> <para> If the context-path change the portal may not be able to find a reference on your portlets anymore. For that reason it's recommended to @@ -919,7 +919,7 @@ <para> If you have read the portlet specification carefully you should have notice that portlet calls happen in one or two phases. One when the portlet is - just rendered, two when the portlet is actionned then rendered. An action + just rendered, two when the portlet is actioned then rendered. An action phase is a phase where some state change. The render phase will have access to render parameters that will be passed each time the portlet is refreshed (with the exception of caching capabilities). @@ -984,7 +984,7 @@ <filename>edit.jsp</filename> files are very simple, they simply display some text. Note that we used CSS styles as defined in the portlet specification. It ensures that the portlet - will look "good" within the theme and accross portal vendors. + will look "good" within the theme and across portal vendors. </para> <programlisting role="XHTML"><![CDATA[<div class="portlet-section-header">Help mode</div> <div class="portlet-section-body">This is the help mode, a convenient place to give the user some help information.</div>]]></programlisting> @@ -1108,7 +1108,7 @@ lets us write a portlet application as if it was a JSF application, the bridge takes care of the interactions between the two layers.</para> <para>Such an example is available in jboss-epp-4.3/jboss-as/docs/portal/examples/JSFHelloUser, it uses the JBoss Portlet Bridge. - The configuration is slightly different from a JSP application, since it is a bit tricky it is usally a good + The configuration is slightly different from a JSP application, since it is a bit tricky it is usually a good idea to copy an existing application that starting from scratch.</para> <para>First, as any JSF application, the file <literal>faces-config.xml</literal> is required. It includes the following required information in it: Modified: docs/enterprise/trunk/Reference_Guide/en-US/WSRP.xml =================================================================== --- docs/enterprise/trunk/Reference_Guide/en-US/WSRP.xml 2011-07-26 00:56:11 UTC (rev 14006) +++ docs/enterprise/trunk/Reference_Guide/en-US/WSRP.xml 2011-07-26 01:16:27 UTC (rev 14007) @@ -50,7 +50,7 @@ </para> <para>As far as caching goes, we have Level 1 Producer and Consumer. We support Cookie handling properly on the - Consumer and our Producer requires initialization of cookies (as we have found that it improved interoperabilty + Consumer and our Producer requires initialization of cookies (as we have found that it improved interoperability with some consumers). We don't support custom window states or modes, as Portal doesn't either. We do, however, support CSS on both the Producer (though it's more a function of the portlets than inherent Producer capability) and Consumer. @@ -238,7 +238,7 @@ <title>Using the configuration portlet</title> <para> As of Portal 2.6, a configuration portlet is provided to configure access to remote WSRP Producers - grahically. You can access it at + graphically. You can access it at <filename>http://{hostname}:{port}/portal/auth/portal/admin/WSRP</filename> or by logging in as a Portal administrator and clicking on the WSRP tab in the Admin portal. If all went well, you should see something similar to this: @@ -483,7 +483,7 @@ <section> <title>Optional configuration</title> - <para>It is also possible to provide addtional configuration, which, in some cases, might be important to + <para>It is also possible to provide additional configuration, which, in some cases, might be important to establish a proper connection to the remote producer. </para> Modified: docs/enterprise/trunk/Reference_Guide/en-US/XML_Descriptors.xml =================================================================== --- docs/enterprise/trunk/Reference_Guide/en-US/XML_Descriptors.xml 2011-07-26 00:56:11 UTC (rev 14006) +++ docs/enterprise/trunk/Reference_Guide/en-US/XML_Descriptors.xml 2011-07-26 01:16:27 UTC (rev 14007) @@ -542,7 +542,7 @@ (display-name* | (resource-bundle, supported-locale+)))>]]> </programlisting> <para> - A portal object that uses the <emphasis>page</emphasis> type. A page type represents a page, and can only have children that use the <emphasis>page</emphasis> and <emphasis>window</emphasis> types. The children windows are the windows of the page, and the children pages are the subpages of the page. + A portal object that uses the <emphasis>page</emphasis> type. A page type represents a page, and can only have children that use the <emphasis>page</emphasis> and <emphasis>window</emphasis> types. The children windows are the windows of the page, and the children pages are the sub-pages of the page. </para> <programlisting><![CDATA[ <!ELEMENT page-name (#PCDATA)>]]> @@ -1551,7 +1551,7 @@ </programlisting> </para> <para> - A depoloyment is composed of a <computeroutput>&lt;deployments&gt;</computeroutput> element, which is a container for <computeroutput>&lt;deployment&gt;</computeroutput> elements. In the previous example, a page is defined, the portlet is placed as a window on a page, and an instance of the portlet is created. The Mangement portlet (bundled with JBoss Portal) can modify portal instances, page position, and so on. + A deployment is composed of a <computeroutput>&lt;deployments&gt;</computeroutput> element, which is a container for <computeroutput>&lt;deployment&gt;</computeroutput> elements. In the previous example, a page is defined, the portlet is placed as a window on a page, and an instance of the portlet is created. The Management portlet (bundled with JBoss Portal) can modify portal instances, page position, and so on. </para> <para> The following list describes elements in a <filename>*-object.xml</filename> file: @@ -1563,7 +1563,7 @@ &lt;if-exists&gt; </programlisting> <para> - The <computeroutput>&lt;if-exists&gt;</computeroutput> element defines the action to take if an instance with the same name already exists. Accepted values are <computeroutput>overwrite</computeroutput> and <computeroutput>keep</computeroutput>. The <computeroutput>overwrite</computeroutput> option destroys the existing object, and creates a new one based on the content of the deployment. The <computeroutput>keep</computeroutput> option matains the existing object deployment, or creates a new one if it does not exist. + The <computeroutput>&lt;if-exists&gt;</computeroutput> element defines the action to take if an instance with the same name already exists. Accepted values are <computeroutput>overwrite</computeroutput> and <computeroutput>keep</computeroutput>. The <computeroutput>overwrite</computeroutput> option destroys the existing object, and creates a new one based on the content of the deployment. The <computeroutput>keep</computeroutput> option maintains the existing object deployment, or creates a new one if it does not exist. </para> </listitem> <listitem> Modified: docs/enterprise/trunk/Reference_Guide/publican.cfg =================================================================== --- docs/enterprise/trunk/Reference_Guide/publican.cfg 2011-07-26 00:56:11 UTC (rev 14006) +++ docs/enterprise/trunk/Reference_Guide/publican.cfg 2011-07-26 01:16:27 UTC (rev 14007) @@ -5,3 +5,6 @@ xml_lang: en-US brand: JBoss +cvs_branch: DOCS-RHEL-6 +cvs_root: :ext:cvs.devel.redhat.com:/cvs/dist +cvs_pkg: JBoss_Enterprise_Portal_Platform-Reference_Guide-4.3-web-__LANG__ \ No newline at end of file