Added: portals/site/jetspeed/jetspeed-2.3/jetspeed-guide-admin/src/site/xdoc/site.xml URL: http://svn.apache.org/viewvc/portals/site/jetspeed/jetspeed-2.3/jetspeed-guide-admin/src/site/xdoc/site.xml?rev=1691449&view=auto ============================================================================== --- portals/site/jetspeed/jetspeed-2.3/jetspeed-guide-admin/src/site/xdoc/site.xml (added) +++ portals/site/jetspeed/jetspeed-2.3/jetspeed-guide-admin/src/site/xdoc/site.xml Thu Jul 16 21:01:09 2015 @@ -0,0 +1,478 @@ +<?xml version="1.0"?> +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<document> + <properties> + <title>Portal Site Administration Guide</title> + <subtitle>Guide to Administering Portal Site</subtitle> + <authors> + <person name="David Sean Taylor" email="[email protected]" /> + <person name="Jody McAlister" email="[email protected]" /> + <person name="Niels van Kampenhout" email="[email protected]" /> + </authors> + </properties> + <body> + <section name="Portal Site Administration Guide"> + <p> + The Portal Site Manager can be looked at as a file-system-like tree of portal resources. + </p> + <p> + The site is made up of three different kinds of resources: + </p> + <ul> + <li><a href="#PSML_Pages">PSML Pages</a></li> + <li><a href="#Folders">Folders</a></li> + <li><a href="#Links">Links</a></li> + </ul> + <p> + All portal resources can be customized in Jetspeed. Portal Site Manager is just one of the + tools available for customizing. Other tools are the Jetspeed Customizer (both Desktop and Portal), Edit Mode, + Configure Mode, Edit Defaults Mode of a portlet and the Portlet Selector. + </p> + <subsection name="PSML Pages"> + <p> + The XML dialect for defining resources and elements that make up the site is also known as PSML (Portal Structure Markup Language). + PSML is not a standard. + </p> + <p> + PSML pages define how and where portlets are placed on a page, as well as how the page is decorated and branded. + </p> + <p> + A PSML page defines : + <ul> + <li>metadata, such as titles and descriptions</li> + <li>decorations (both page and portlet)</li> + <li>layout fragments (number of columns on the page, and nesting of columns)</li> + <li>which portlets are displayed on the page, defined by portlet fragments</li> + <li>the position of the portlet on the page</li> + <li>properties of the portlets</li> + <li>preferences of a portlet</li> + <li>security constraints</li> + </ul> + </p> + <p> + To customize a PSML page through the Portal Site Manager, select it in the tree. On the right side of the tree + four tabs will appear allowing you to customize various aspects of the page through a form. + </p> + <p> + Each of the four tabs is described below. + </p> + <h4>Information Tab</h4> + <p> + The Information Tab allows you to customize the title and appearance of the page. + </p> + <img src="images/psm_psml_info.png"/> + <table> + <tr> + <th>Field</th> + <th>Description</th> + </tr> + <tr> + <td>Name</td> + <td>Name of the .psml file.</td> + </tr> + <tr> + <td>Title</td> + <td>Name that appears in the xml title field for this object.</td> + </tr> + <tr> + <td>Short Title</td> + <td>Name that appears in the xml short title field for this object.</td> + </tr> + <tr> + <td>Page Decorator</td> + <td>Drop down menu of all available page decorators.</td> + </tr> + <tr> + <td>Portlet Decorator</td> + <td>Drop down menu of all available portlet decorators.</td> + </tr> + <tr> + <td>Desktop Theme</td> + <td>Drop down menu of all available desktop themes.</td> + </tr> + <tr> + <td>Hidden</td> + <td>Hidden folders do not show up on menus, but can still be navigated to. </td> + </tr> + </table> + <h4>Security Tab</h4> + <p> + The Security Tab allows you to modify a page's security constraints. All security constraints + defined for the selected page are shown in a list. To modify a constraint, select it from the list + and choose a new value in the dropdown field. + </p> + <img src="images/psm_psml_security.png"/> + <table> + <tr> + <th>Field</th> + <th>Description</th> + </tr> + <tr> + <td>Constraints</td> + <td>Any Security and Constraint types will be listed here for the selected item.</td> + </tr> + </table> + <h4>Metadata Tab</h4> + <p> + The Metadata Tab shows a list of metadata properties that might be defined for the page, e.g. translations + in different languages of the page title, such as shown in the screenshot below. Clicking on a property + will load it in the form right below the list so that the values can be modified. + </p> + <img src="images/psm_psml_metadata.png"/> + <table> + <tr> + <th>Field</th> + <th>Description</th> + </tr> + <tr> + <td>Name</td> + <td>Name of attribute in xml file for this object.</td> + </tr> + <tr> + <td>Language</td> + <td>Localization of the attribute.</td> + </tr> + <tr> + <td>Value</td> + <td>Text to be localized.</td> + </tr> + </table> + <h4>Export Tab</h4> + <p> + The Export Tab provides an XML export of the page. The exported XML file can be used + to store customizations made through the user interface in a custom portal project, + so that when a new version of the portal is deployed, the customizations do not have + to be made again. + </p> + <img src="images/psm_psml_export.png" /> + <table> + <tr> + <th>Field</th> + <th>Description</th> + </tr> + <tr> + <td>Export Object</td> + <td>Export the selected item in XML format.</td> + </tr> + </table> + </subsection> + <subsection name="Links"> + <p> + Links are URLs to external resources, usually outside of the site. + The element is persisted with the .link extension on the file system. + </p> + <p> + To customize a link through the Portal Site Manager, select it in the tree. On the right side of the tree + four tabs will appear allowing you to customize various aspects of the link through a form. + </p> + <p> + Each of the four tabs is described below. + </p> + <h4>Information Tab</h4> + <p> + The Information Tab allows you to change the title and the URL of a link. + </p> + <img src="images/psm_link_info.png"/> + <table> + <tr> + <th>Field</th> + <th>Description</th> + </tr> + <tr> + <td>Name</td> + <td>Name of .link file.</td> + </tr> + <tr> + <td>Title</td> + <td>Name that appears in the xml title field for this object.</td> + </tr> + <tr> + <td>Short Title</td> + <td>Name that appears in the xml short title field for this object.</td> + </tr> + <tr> + <td>URL</td> + <td>The resource to be displayed when clicked.</td> + </tr> + <tr> + <td>Target Window</td> + <td>The web browser action when the link is clicked on for displaying the Target. (New, Self, Parent, Top)</td> + </tr> + <tr> + <td>Hidden</td> + <td>Hidden folders do not show up on menus, but can still be navigated to. </td> + </tr> + </table> + <h4>Security Tab</h4> + <p> + The Security Tab allows you to modify a link's security constraints. All security constraints + defined for the selected link are shown in a list. To modify a constraint, select it from the list + and choose a new value in the dropdown field. + </p> + <img src="images/psm_link_security.png"/> + <table> + <tr> + <th>Field</th> + <th>Description</th> + </tr> + <tr> + <td>Constraints</td> + <td>Any Security and Constraint types will be listed here for the selected item.</td> + </tr> + </table> + <h4>Metadata Tab</h4> + <p> + The Metadata Tab shows a list of metadata properties that might be defined for the link, e.g. translations + in different languages of the link title, such as shown in the screenshot below. Clicking on a property + will load it in the form right below the list so that the values can be modified. + </p> + <img src="images/psm_link_metadata.png"/> + <table> + <tr> + <th>Field</th> + <th>Description</th> + </tr> + <tr> + <td>Name</td> + <td>Name of attribute in xml file for this object.</td> + </tr> + <tr> + <td>Language</td> + <td>Localization of the attribute.</td> + </tr> + <tr> + <td>Value</td> + <td>Text to be localized.</td> + </tr> + </table> + <h4>Export Tab</h4> + <p> + The Export Tab allows you to export a link to an XML file. + </p> + <img src="images/psm_link_export.png"/> + <table> + <tr> + <th>Field</th> + <th>Description</th> + </tr> + <tr> + <td>Export Object</td> + <td>Export the selected item in xml format.</td> + </tr> + </table> + </subsection> + <subsection name="Folders"> + <p> + A folder is a container object that holds: + </p> + <ul> + <li>subfolders (which in turn can hold subfolders, pages, links...)</li> + <li>pages</li> + <li>links</li> + </ul> + <p> + Folders make up the physical layout of your site and have the following attributes : + </p> + <ul> + <li>Localizable Metadata (name, title, short-title, description)</li> + <li>Optional Default-page </li> + <li>Optional Decorator</li> + <li>Hidden Flag (hidden folders do not show up on menus, but can still be navigated to)</li> + <li>Security Constraints </li> + <li>Menus</li> + <li>Document Ordering</li> + </ul> + <p> + To customize a folder through the Portal Site Manager, select it in the tree. On the right side of the tree + seven tabs will appear allowing you to customize various aspects of the link through a form. + </p> + <p> + Five of the seven tabs are described below (Information, Security, Metadata, Import, Export). The Menus and Order Tabs + are placeholders for future functionalities and do not currently contain any information. + </p> + <h4>Information Tab</h4> + <img src="images/psm_folder_info.png"/> + <table> + <tr> + <th>Field</th> + <th>Description</th> + </tr> + <tr> + <td>Name</td> + <td>Name of the folder in the Portal Site Manager tree.</td> + </tr> + <tr> + <td>Title</td> + <td>Title of the Folder as it appears in the xml file.</td> + </tr> + <tr> + <td>Short Title</td> + <td>Short Tile of the folder as it appears in the xml file.</td> + </tr> + <tr> + <td>Default Page</td> + <td>Optional. Page to default to when browsing.</td> + </tr> + <tr> + <td>Page Decorator</td> + <td>Drop down menu of all available page decorators.</td> + </tr> + <tr> + <td>Portlet Decorator</td> + <td>Drop down menu of all available portlet decorators.</td> + </tr> + <tr> + <td>Hidden</td> + <td>Hidden folders do not show up on menus, but can still be navigated to. </td> + </tr> + </table> + <h4>Security Tab</h4> + <p> + The Security Tab allows you to modify a folder's security constraints. All security constraints + defined for the selected folder are shown in a list. To modify a constraint, select it from the list + and choose a new value in the dropdown field. + </p> + <img src="images/psm_folder_security.png"/> + <table> + <tr> + <th>Field</th> + <th>Description</th> + </tr> + <tr> + <td>Constraints</td> + <td>Any Security and Constraint types will be listed here for the selected item.</td> + </tr> + </table> + <h4>Metadata Tab</h4> + <p> + The Metadata Tab shows a list of metadata properties that might be defined for the folder, e.g. translations + in different languages of the folder title, such as shown in the screenshot below. Clicking on a property + will load it in the form right below the list so that the values can be modified. + </p> + <img src="images/psm_folder_metadata.png"/> + <table> + <tr> + <th>Field</th> + <th>Description</th> + </tr> + <tr> + <td>Name</td> + <td>Name of attribute in xml file for this object.</td> + </tr> + <tr> + <td>Language</td> + <td>Localization of the attribute.</td> + </tr> + <tr> + <td>Value</td> + <td>Text to be localized.</td> + </tr> + </table> + <h4>Import Tab</h4> + <p> + The Import Tab allows you to import a folder that you previously exported as XML file. + </p> + <img src="images/psm_folder_import.png"/> + <table> + <tr> + <th>Field</th> + <th>Description</th> + </tr> + <tr> + <td>File to Import</td> + <td>Use the browse button to search local files for the xml file to be imported.</td> + </tr> + <tr> + <td>File Destination</td> + <td>The path to place the xml file being imported.</td> + </tr> + </table> + <h4>Export Tab</h4> + <p> + The Export Tab allows you to export a folder to an XML file. Optionally you can resursively + export all sub items inside the folder as well by checking the "Export recursively" checkbox. + </p> + <img src="images/psm_folder_export.png"/> + <table> + <tr> + <th>Field</th> + <th>Description</th> + </tr> + <tr> + <td>Export Object</td> + <td>Export folder.metadata in xml format.</td> + </tr> + <tr> + <td>Export Recursively</td> + <td>Export all sub-items in the xml format as well as the folder.metadata.</td> + </tr> + </table> + </subsection> + <subsection name="Portal Tree vs. User Tree"> + <p> + There are system wide portal resources and personalized or user specific portal resources. These are + represented by separate trees. The Portal Site Manager allows you to switch between these two + trees. + </p> + <h4>Portal Tree</h4> + <img src="images/psmportal.png" /> + <h4>User Tree</h4> + <img src="images/psmusertree.png" /> + </subsection> + <subsection name="Control Folders"> + <p> + Control folders always start with the underscore _. + </p> + <p> + Control folders are used to separate pages based on runtime parameters. For example, you may have a different set of pages for a phone vs. a full web-browser. + In that case, you place your pages for the phone under a WML directory, where you may have less portlets per page than the HTML directory. + </p> + <p> + There is a special folder named (_subsite_root) : + </p> + <ul> + <li>Subsites sub-divide your portal site into independent "portal site" trees. This enables use-case scenarios such as hosting two or more + portals on the same portal instance (app server)</li> + <li>Users can be configured to point to a particular subsite which will become their view of the portal</li> + </ul> + <p> + The User folder (_user) : + </p> + <ul> + <li>The _user folder holds the home pages of all users. Each user can have a folder with multiple subfolders, pages and links</li> + <li>A user is not required to have a home folder. Depending on the user profile, the user home page may or may not be used </li> + <li>Usually, a user's home page is made customizable (editable) to the user, but not to others</li> + <li>Jetspeed uses "templates" to create default pages for users when the user first registers or is created by an Administrator</li> + </ul> + <p> + Roles and Group Folders (_role and _group) : + </p> + <ul> + <li>Role and group folders are useful for sharing pages based on the roles or groups that a user belongs in. Typical use cases are for granting (or denying) + access to pages</li> + <li>Role folder names should be the same as the roles defined in the system, likewise for groups</li> + <li>A user's profile defines where pages are to be searched</li> + <li>A user profile called "role-fallback" looks for pages in the _role directory, based on the users's security profile. It will search + through all folders based on the roles that a user holds</li> + <li>A common profile rule is to first search the user's home directory, then each of the role directories for the given user, and the the + default root tree to find the page</li> + </ul> + </subsection> + </section> + </body> +</document> \ No newline at end of file
Added: portals/site/jetspeed/jetspeed-2.3/jetspeed-guide-admin/src/site/xdoc/space-manager.xml URL: http://svn.apache.org/viewvc/portals/site/jetspeed/jetspeed-2.3/jetspeed-guide-admin/src/site/xdoc/space-manager.xml?rev=1691449&view=auto ============================================================================== --- portals/site/jetspeed/jetspeed-2.3/jetspeed-guide-admin/src/site/xdoc/space-manager.xml (added) +++ portals/site/jetspeed/jetspeed-2.3/jetspeed-guide-admin/src/site/xdoc/space-manager.xml Thu Jul 16 21:01:09 2015 @@ -0,0 +1,61 @@ +<?xml version="1.0"?> + <!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version + 2.0 (the "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 Unless required by + applicable law or agreed to in writing, software distributed under + the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES + OR CONDITIONS OF ANY KIND, either express or implied. See the + License for the specific language governing permissions and + limitations under the License. + --> +<document> + <properties> + <title>Spaces Manager Guide</title> + <subtitle>Guide to Administering JetUI Spaces</subtitle> + <authors> + <person name="David Sean Taylor" email="[email protected]" /> + </authors> + </properties> + <body> + <section name="Spaces and the Space Manager"> + <p> +A space is a top level organization of the Jetspeed site. You can use spaces to organize or group projects or teams into a common area. Spaces can then be navigate to using the +Space Navigator. Spaces were introduced in version 2.2.1 as a part of the JetUI feature set. +There are two administrative portlets for you to manage your Spaces. The Spaces List and Spaces Manager Detail. + </p> + <img src="images/spaces-list.png"/><img src="images/spaces-manager.png"/> + <p>The Spaces List shows you a list of all spaces in the system that are visible to the current user. A space is only visible if you have secure access to modify it. Notice that when you + are logged on as the administrator, you may actually see spaces owned by other users (see the Owner column). Jetspeed will only allow you to delete spaces where you have the security + privilege to delete those spaces. There is a special space, called the Public Space. This is the logical root folder on the system. It can never be deleted. Use the Public Space + for setting global settings in the system, like the default theme or default security constraint. Then other spaces can override these defaults settings. All users will also see + another special Space called <b>My Pages</b>. It will show up as the last space in your list of folders. This is actually the current users Home Space. Every user has a home space. + </p> + <p> + The Space Manager Detail allows you to edit specific properties on a space including + <ul> + <li>The Space Name</li> + <li>The Space Owner - must be a valid username</li> + <li>The Space Title</li> + <li>A Description of the Space</li> + <li>A drop down list of possible Security Constraints for this space. Please see the <a href="constraints.html">Security Constraints</a> guide for more details on setting up secure access to spaces.</li> + <li>A theme for the Space. Themes are special decorators only available in JetUI</li> + </ul> + </p> + </section> + <section name="Space Navigator"> + <p> + The Space Navigator is a JetUI special navigational portlet giving users quick access to spaces. From the Space Navigator, you can navigate to any space in the system where you +have secure access to view that space. Additionally, from the Space Navigator, the Admin can Edit the current space, as well as create a new space. The Space Navigator is +implemented using two new features introduced with JetUI: page templates and detached portlets. In order for the Space Navigator to appear on every page in the system, we have +configured it on a page template. See the <a href="../deployguide/guide-jetui.html">JetUI Guide</a> and <a href="../deployguide/guide-page-templates.html">Template guide</a> for more information. +</p> + <img src='images/space-navigator.png'/> +</section> + </body> +</document> \ No newline at end of file Added: portals/site/jetspeed/jetspeed-2.3/jetspeed-guide-admin/src/site/xdoc/sso.xml URL: http://svn.apache.org/viewvc/portals/site/jetspeed/jetspeed-2.3/jetspeed-guide-admin/src/site/xdoc/sso.xml?rev=1691449&view=auto ============================================================================== --- portals/site/jetspeed/jetspeed-2.3/jetspeed-guide-admin/src/site/xdoc/sso.xml (added) +++ portals/site/jetspeed/jetspeed-2.3/jetspeed-guide-admin/src/site/xdoc/sso.xml Thu Jul 16 21:01:09 2015 @@ -0,0 +1,271 @@ +<?xml version="1.0"?> + <!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version + 2.0 (the "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 Unless required by + applicable law or agreed to in writing, software distributed under + the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES + OR CONDITIONS OF ANY KIND, either express or implied. See the + License for the specific language governing permissions and + limitations under the License. + --> +<document> + <properties> + <title>SSO Administration Guide</title> + <subtitle>Guide to Administering Single Sign-on</subtitle> + <authors> + <person name="David Sean Taylor" email="[email protected]" /> + <person name="Jody McAlister" email="[email protected]" /> + </authors> + </properties> + <body> + <section name="Jetspeed Single Sign On"> + <p>Jetspeed-2 (J2) Single Sign-on (SSO) feature is a + credential store implemented as a component. It uses J2 security + implementation for storing credentials. A management portlet + allows the editing of SSO sites and remote credentials. It + supports Basic Authentication and Form Based authentication and + supports cookies.</p> + <p>The SSO Management feature enables you to create "single + sign-on" access, a permission-based access to applications and + underlying tools, which provides an added layer of security and + administarative control of Jetspeed-2 content. SSO Management + enables the Users of Groups (several Users initially defined in + the Group Management tab) to sign-on a single time for + jetspeed-2 portal and specified sites and databases.</p> + </section> + <section name="SSOProxy Portlet"> + <para>As the name indicates the SSOProxy portlet is the proxy + between the portal and authenticated sites. In the preferences a + user defines the destination page which might need + authentication itself or has links to authenticated pages + (inside or outside the portal).</para> + <para>The SSOProxy Portlet authenticates all SSO sites for the + user before it goes to the destination URL defined in the + preferences. The SSOProxy keeps a cache of of the proxy client + so that the authentication only takes place the first time. + </para> + <para /> + </section> + <section name="SSOReverseProxyIFrame Portlet"> + <p> + The SSOReverseProxyIFrame portlet leverages the Reverse Proxy Service component + of <a href="http://portals.apache.org/applications/webcontent/";>Apache Portals Web Content Application</a>. + This portlet provides Single Sign-on site and credentials of the user + to the Reverse Proxy Service component based on the navigated URLs. + The Reverse Proxy Service component authenticates the site for the + user automatically if the site is registered as a Single Sign-on site + for the user in the Jetspeed-2 Single Sign-on credential store. + </p> + <p> + For example, if the following preferences are set, + <br/> + <table> + <tr> + <th>Preference Name</th> + <th>Preference Value</th> + </tr> + <tr> + <td>SRC</td> + <td>http://localhost:8080/manager/list</td> + </tr> + <tr> + <td>PROXYREMOTEURL</td> + <td>http://localhost:8080/</td> + </tr> + <tr> + <td>PROXYLOCALPATH</td> + <td>${contextPath}/rproxy/localhost/</td> + </tr> + </table> + <br/> + then the portlet tries to retrieve the registered SSO sites and SSO remote users information + of the user by the SRC URL, 'http://localhost:8080/manager/list'. + </p> + <p> + If the user has the following SSO sites and SSO remote users information, + <br/> + <table> + <tr> + <th>Site Name</th> + <th>Site URL</th> + <th>Site Realm</th> + <th>Remote Principal</th> + <th>Remote Credential</th> + </tr> + <tr> + <td>Tomcat Management</td> + <td>http://localhost:8080/manager/</td> + <td>Tomcat Manager Application</td> + <td>tomcat</td> + <td>tomcat</td> + </tr> + </table> + <br/> + then the Reverse Proxy Service component can retrieve the above information from the portlet + and it would try to authenticate by the provided credentials. + </p> + <p> + If there are multiple SSO sites which have similar URLs, then best URL-matched SSO sites and credentials + would be chosen for authentication. + For example, when the user has the following SSO sites and credentials registered, + <br/> + <table> + <tr> + <th>No.</th> + <th>Site Name</th> + <th>Site URL</th> + <th>Site Realm</th> + <th>Remote Principal</th> + <th>Remote Credential</th> + <th>User Form Field</th> + <th>Password Form Field</th> + </tr> + <tr> + <td>1</td> + <td>My Root Website</td> + <td>http://localhost:8080/</td> + <td></td> + <td>user</td> + <td>user</td> + <td></td> + <td></td> + </tr> + <tr> + <td>2</td> + <td>My Basic Auth Website</td> + <td>http://localhost:8080/basic/</td> + <td>ExampleBasicAuthJSP</td> + <td>basic</td> + <td>basic</td> + <td></td> + <td></td> + </tr> + <tr> + <td>3</td> + <td>My Form Auth Website</td> + <td>http://localhost:8080/form/</td> + <td></td> + <td>form</td> + <td>form</td> + <td>user</td> + <td>pass</td> + </tr> + </table> + <br/> + then the Reverse Proxy Service component will be provided best-matched SSO sites and credentials information + like the following examples: + <br/> + <table> + <tr> + <th>Requested URL</th> + <th>No.</th> + <th>Description</th> + </tr> + <tr> + <td>http://localhost:8080/</td> + <td>1</td> + <td> + This requested URL is matched to the first SSO site URL only. + </td> + </tr> + <tr> + <td>http://localhost:8080/index.html</td> + <td>1</td> + <td> + This requested URL starts with the first SSO site URL + and is matched to the first SSO site URL only. + </td> + </tr> + <tr> + <td>http://localhost:8080/somewhere/index.html</td> + <td>1</td> + <td> + This requested URL starts with the first SSO site URL + and is matched to the first SSO site URL only. + </td> + </tr> + <tr> + <td>http://localhost:8080/basic/</td> + <td>2, 1</td> + <td> + This requested URL starts with the first and the second SSO site URLs. + Because the second one is more well-matched, the second SSO site and credentials + information would be used first for authentication. + </td> + </tr> + <tr> + <td>http://localhost:8080/basic/index.html</td> + <td>2, 1</td> + <td> + This requested URL starts with the first and the second SSO site URLs. + Because the second one is more well-matched, the second SSO site and credentials + information would be used first for authentication. + </td> + </tr> + <tr> + <td>http://localhost:8080/form/</td> + <td>3</td> + <td> + This requested URL starts with the first and the third SSO site URLs. + The third one is more well-matched. + However, unlike the basic authentication examples, the first one will never be used + because the best-matched SSO site is configured to use form-based authentication. + When the best-matched SSO site is configured to use form-based authentication, + the Reverse Proxy Service component would use it only for authentication. + <br/> + The Reverse Proxy Service component would post username form field and password form field + with the specified form field names + only when the requested URL is equals to the URL of the SSO site. + <em>If the requested URL is changed by user's navigation in the IFrame, then it would not try posting the + username and password form fields again.</em> + </td> + </tr> + <tr> + <td>http://localhost:8080/form/index.html</td> + <td>3</td> + <td> + This requested URL starts with the first and the third SSO site URLs. + The third one is more well-matched. + However, unlike the basic authentication examples, the first one will never be used + because the best-matched SSO site is configured to use form-based authentication. + When the best-matched SSO site is configured to use form-based authentication, + the Reverse Proxy Service component would use it only for authentication. + <br/> + The Reverse Proxy Service component would post username form field and password form field + with the specified form field names + only when the requested URL is equals to the URL of the SSO site. + <em>If the requested URL is changed by user's navigation in the IFrame, then it would not try posting the + username and password form fields again.</em> + </td> + </tr> + </table> + </p> + </section> + <section name="SSO Provider service"> + <para>The SSO Provider is a part of the jetspeed service + framework and is available to any portlet and not just the + SSOProxy Portlet. The component takes care of storing the sites + and credentials and has an API to get content from a url.</para> + <para /> + </section> + <section name="SSO Management"> + <para>The SSO management portlet helps to administer SSO + credentials and assigning them to Portal Users.</para> + <p> + <img src="images/sso-manage.png" /> + </p> + <p> + The Portal Principal field may be populated by clicking on either the + user icon or the group icon. A pop up window will display to + allow you to + select your user or group. + </p> + </section> + </body> +</document> \ No newline at end of file Added: portals/site/jetspeed/jetspeed-2.3/jetspeed-guide-admin/src/site/xdoc/statistics.xml URL: http://svn.apache.org/viewvc/portals/site/jetspeed/jetspeed-2.3/jetspeed-guide-admin/src/site/xdoc/statistics.xml?rev=1691449&view=auto ============================================================================== --- portals/site/jetspeed/jetspeed-2.3/jetspeed-guide-admin/src/site/xdoc/statistics.xml (added) +++ portals/site/jetspeed/jetspeed-2.3/jetspeed-guide-admin/src/site/xdoc/statistics.xml Thu Jul 16 21:01:09 2015 @@ -0,0 +1,39 @@ +<?xml version="1.0"?> +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<document> + <properties> + <title>Portal Statistics Administration Guide</title> + <subtitle>Guide to Administering Portal Statistics</subtitle> + <authors> + <person name="David Sean Taylor" email="[email protected]" /> + <person name="Jody McAlister" email="[email protected]" /> + </authors> + </properties> + <body> + <section name="Portal Statistics Administration Guide"> + <subsection name="Viewing Statistics"> + <p> + Jetpseed-2 provides administrative portlets that report on portal statistics. + <br/><br/> + <img src="images/portlet-statistics.gif" border="0"/><br/> + <img src="images/page-statistics.gif" border="0"/> + </p> + </subsection> +</section> + </body> +</document> \ No newline at end of file Added: portals/site/jetspeed/jetspeed-2.3/jetspeed-guide-admin/src/site/xdoc/subsites.xml URL: http://svn.apache.org/viewvc/portals/site/jetspeed/jetspeed-2.3/jetspeed-guide-admin/src/site/xdoc/subsites.xml?rev=1691449&view=auto ============================================================================== --- portals/site/jetspeed/jetspeed-2.3/jetspeed-guide-admin/src/site/xdoc/subsites.xml (added) +++ portals/site/jetspeed/jetspeed-2.3/jetspeed-guide-admin/src/site/xdoc/subsites.xml Thu Jul 16 21:01:09 2015 @@ -0,0 +1,374 @@ +<?xml version="1.0"?> +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<document> + <properties> + <title>Jetspeed Subsites</title> + <subtitle>Guide to Jetspeed Subsites</subtitle> + <authors> + <person name="David Sean Taylor" email="[email protected]" /> + </authors> + </properties> + <body> + <section name="What are Subsites?"> + <p> + Subsites are a feature for sub-dividing your portal site map into independent "portal site" trees. + This enables use-case scenarios such as hosting two or more Jetspeed portals on the same portal instance (application server). + With subsites, subsets of users can be configured to only view a sub-tree, or subsite, of the overall portal site. + These users will never see content outside of their subsite. + The creation of subsites is based upon profiling rules. You apply profiling rules to navigate users to their subsite root. + In this example, + </p> + </section> + <section name='A Subsite Scenario: Subsite By Hostname'> + <p>In order to direct users to different subsites, you will need to define a set of rules, known as profiling rules. + These rules determine which subsite users and guests will visit. + Rules are based on runtime parameters, such as username, roles of the current user, request parameters, session state, or more. + In this example we will look at directing users to subsites based on the <b>hostname</b> portion of the URL. + Use case scenario we are going to look at are:</p> + <ul> + <li>A virtual hosting scenario where you are hosting different sites.</li> + <li>A single organization with two or more sites, which may also some content in common amongst those subsites.</li> + </ul> + <subsection name='Virtual Hosting'> + <p>In our Virtual Hosting example, we are hosting three different portal subsites:</p> + <img src='images/subsites2.jpg' border="0"/> + <p>Here we have three subsites (four including localhost) defined for three different companies: + </p> + <ul> + <li>www.company-1.com - the subsite for "Company 1"</li> + <li>www.company-2.com - the subsite for "Company 2"</li> + <li>www.company-3.com - the subsite for "Company 3"</li> + </ul> + </subsection> + <subsection name='Single Organization'> + <p>In our Single Organization example, we are hosting three different portal subsites within the organization:</p> + <img src='images/subsites.jpg' border="0"/> + <p>Here we have three subsites (four including localhost) defined for three different companies: + </p> + <ul> + <li>employees.my-company.com - subsite for employees</li> + <li>partners.my-company.com - subsite for partners</li> + <li>www.my-company.com - subsite for the public</li> + </ul> + </subsection> + <subsection name='Site Manager'> + <p>The screenshots above show using the Site Manager to configure your subsites. + The Site Manager is useful for configuring a live site. When you configure a site initially, + subsites are configured on the file system as folders, subfolders and pages. Optionally, these folders can be imported + in the database. See the <a href='../devguide/guide-psml.html'>Database Page Manager</a> for details on storing subsites in the database. + </p> + <p> + The Site Manager mirrors your file system (or database structure) in a tree view. Looking at the Site View screenshots + above, there are several directories we need to take note of: + </p> + <ul> + <li><b>__subsite-root</b> - this is a reserved directory, containing all subsite control roots</li> + <li><b>_hostname</b> - this is a <i>control</i> directory (prefixed with underscore) containing all hostname-based subsites</li> + </ul> + <p>Control directories must always begin with an underscore. Profiling rules navigate through control directories based on + runtime parameters. In this example, we are creating subsites based on the hostname runtime parameter</p> + </subsection> + <subsection name='/etc/hosts'> + <p>Note that the localhost site is there only for developers. Even developers can simulate a virtual hosting environment + by editing their <b>/etc/hosts</b> file on their local machines (on Windows under <b>\windows\system32\drivers\etc\hosts</b>) + and making fake entries such as: + </p> +<source> +<![CDATA[ + 127.0.0.1 www.company-1.com + 127.0.0.1 www.company-2.com + 127.0.0.1 www.company-3.com + + 127.0.0.1 employees.my-company.com + 127.0.0.1 partners.my-company.com + 127.0.0.1 www.my-company.com +]]> +</source> + </subsection> + </section> + <section name="XML Seed Configuration"> + <p> + When initially setting up your Jetspeed portal, you will need to provide initial seed data for your portal. + Here we demonstrate how to configure your XML seed data for a subsite. + We will be initializing:</p> + <ul> + <li>Profiling Rules</li> + <li>Users</li> + </ul> + <subsection name='Profiling Rules'> + +<source test=""> + <![CDATA[ +<ProfilingRule id="subsite-by-hostname" standardRule="false"> + <description value="A rule based on role fallback algorithm with specified subsite and home page"/> + <Criteria> + <Criterion name="navigation"> + <type value="navigation"/> + <value value="subsite-root"/> + <fallBackOrder value="0"/> + <fallBackType value="2"/> + </Criterion> + <Criterion name="hostname"> + <type value="hostname"/> + <fallBackOrder value="1"/> + <fallBackType value="2"/> + </Criterion> + <Criterion name="user"> + <type value="user"/> + <fallBackOrder value="2"/> + <fallBackType value="2"/> + </Criterion> + <Criterion name="navigation-2"> + <type value="navigation"/> + <value value="subsite-root"/> + <fallBackOrder value="3"/> + <fallBackType value="2"/> + </Criterion> + <Criterion name="hostname-2"> + <type value="hostname"/> + <fallBackOrder value="4"/> + <fallBackType value="2"/> + </Criterion> + <Criterion name="role"> + <type value="role"/> + <fallBackOrder value="5"/> + <fallBackType value="2"/> + </Criterion> + <Criterion name="path"> + <type value="path"/> + <value value="home"/> + <fallBackOrder value="6"/> + <fallBackType value="2"/> + </Criterion> + </Criteria> +</ProfilingRule> +]]> +</source> +<p>A profiling rule contains one or more criterion. Each criterion defines an instruction on how to locate a page in the physical portal site map. +Criterion of the type <i>navigation</i> are used to navigate down the portal site tree. +The <i>fallBackOrder</i> tag should normally just be listed sequential. You can almost always get by with a <i>fallBackType</i> of 2. +All of the available criterion <i>types</i> are documented in the online <a href='profiler.html'>Profiler Guide</a>. +The table below describes each criterion in our subsite rule and how it is used in a subsite location algorithm. This rule is a subsite location rule that uses a user-role-fallback algorithm. +User-role-fallback algorithms first look for a page in the users home directory. If not found there, they then look for a page in each of the users corresponding role directories. +There are other algorithms provided by out of the box such as role-fallback, group-fallback, mediatype/language fallback. Or you can create your own algorithms by creating new profiling rules in the XML seed data or with +the Profiler Admininistrative portlet. +</p> +<table> +<tr><th>Name</th><th>Type</th><th>Value</th><th>Description</th></tr> +<tr><td>navigation</td><td>navigation</td><td>subsite-root</td><td>Navigates to the physical /__subsite-root directory.</td></tr> +<tr><td>hostname</td><td>hostname</td><td>(provided at runtime)</td><td>Navigates to the control directory /__subsite-root/_hostname, and then to the subdirectory matching the runtime _hostname parameter. If the runtime _hostname parameter equals "localhost", then the physical location is /__subsite-root/_hostname/localhost.</td></tr> +<tr><td>user</td><td>user</td><td>(provided at runtime)</td><td>Navigates to the control directory /__subsite-root/_hostname/user, and then to the subdirectory matching the runtime _user parameter. If the runtime _user parameter equals "dean", then the physical location is /__subsite-root/_hostname/localhost/_user/dean.</td></tr> +<tr><td>navigation-2</td><td>navigation</td><td>subsite-root</td><td>When a page is not found under the user directory, we start over and navigate back to the subsite root.</td></tr> +<tr><td>hostname</td><td>hostname</td><td>(provided at runtime)</td><td>Then again navigate to the _hostname directory</td></tr> +<tr><td>role</td><td>role</td><td>(provided at runtime)</td><td>Navigate to each role directory of the given user until we find the page. For example, for a role named "role1", navigate to the control directory /__subsite-root/_hostname/role, and then to the subdirectory matching each runtime _role parameters. If the runtime _role parameter is only "role1", then the physical location is /__subsite-root/_hostname/localhost/_role/role1.</td></tr> +<tr><td>path</td><td>path</td><td>home</td><td>This is a constant used in all calculations, the path portion of the URL, such as home.psml, or /accounting/worksheet.psml. It is always appended to the calculated path to give the complete physical address of the page. In the case where there is no page specified, the default value provided in the rule "home" is used, and that actually maps to "home.psml" as the default page extensions.</td></tr> +</table> +<p> +The screenshot below shows the directory tree for a <i>localhost</i> subsite. +</p> +<img src='images/localhost-site.jpg'/> +<p> +Notice the _user and _role directories. These are control directories based on the runtime parameters <i>user</i> and <i>role</i>. +The user parameter represents the username of the currently logged on user. The role parameter can represent one or more roles of the current user. +The subsite algorithm will navigate down to a user directory first, and look in the directory for the current user by name. +It will look there for name of the current page requested on the URL. +Given the following example runtime parameters, the tables below demonstrates the fallback search path algorthm used by the profiler in locating a page given our subsite profiling rule. +Once it finds the page, the page is immediately returned and the algorithm is terminated. +For each of the examples below, consider the following runtime parameters: +<table> +<tr><td>Username</td><td>dean</td></tr> +<tr><td>Roles</td><td>role1, role2, role3</td></tr> +<tr><td>Hostname</td><td>localhost</td></tr> +</table> +</p> +<p> +<b>http://localhost:8080/jetspeed/portal/calendar.psml</b> +<table> +<tr><th>URL</th><th>Site Physical Location</th></tr> +<tr><td>http://localhost:8080/jetspeed/portal/calendar.psml</td><td>/__subsite-root/_hostname/localhost/_user/dean/calendar.psml</td></tr> +<tr><td></td><td>/__subsite-root/_hostname/localhost/_role/role1/calendar.psml</td></tr> +<tr><td></td><td>/__subsite-root/_hostname/localhost/_role/role2/calendar.psml</td></tr> +<tr><td></td><td>/__subsite-root/_hostname/localhost/_role/role3/calendar.psml</td></tr> +<tr><td></td><td>/__subsite-root/_hostname/localhost/calendar.psml</td></tr> +<tr><td></td><td>/__subsite-root/calendar.psml</td></tr> +</table> +</p> + +<p> +<b>http://localhost:8080/jetspeed/portal/accounting/worksheet.psml</b> +<table> +<tr><th>URL</th><th>Site Physical Location</th></tr> +<tr><td>http://localhost:8080/jetspeed/portal/accounting/worksheets.psml</td><td>/__subsite-root/_hostname/localhost/_user/dean/accounting/worksheet.psml</td></tr> +<tr><td></td><td>/__subsite-root/_hostname/localhost/_role/role1/accounting/worksheet.psml</td></tr> +<tr><td></td><td>/__subsite-root/_hostname/localhost/_role/role2/accounting/worksheet.psml</td></tr> +<tr><td></td><td>/__subsite-root/_hostname/localhost/_role/role3/accounting/worksheet.psml</td></tr> +<tr><td></td><td>/__subsite-root/_hostname/localhost/accounting/worksheet.psml</td></tr> +<tr><td></td><td>/__subsite-root/accounting/worksheet.psml</td></tr> +</table> +</p> + +<p> +<b>http://localhost:8080/jetspeed/portal/</b> +<table> +<tr><th>URL</th><th>Site Physical Location</th></tr> +<tr><td>http://localhost:8080/jetspeed/portal/</td><td>/__subsite-root/_hostname/localhost/_user/dean/home.psml</td></tr> +<tr><td></td><td>/__subsite-root/_hostname/localhost/_role/role1/home.psml</td></tr> +<tr><td></td><td>/__subsite-root/_hostname/localhost/_role/role2/home.psml</td></tr> +<tr><td></td><td>/__subsite-root/_hostname/localhost/_role/role3/home.psml</td></tr> +<tr><td></td><td>/__subsite-root/_hostname/localhost/home.psml</td></tr> +<tr><td></td><td>/__subsite-root/home.psml</td></tr> +</table> +</p> + </subsection> + <subsection name='Associated Rules with Users'> +<p> +All users are either explicity or implicity associated with a profiling rule. +The User Administration utility has a tab to setup the profiling rule associated with a user: +</p> +<img src='images/user-profile.jpg' border="0"/> +<p> +Additionally, you can associate users with profiling rules in the XML seed data configuration: +</p> + <source> + <![CDATA[ +<Users> +... +<User name="jetspeed"> + <credentials password="jetspeed" enabled="TRUE" requiresUpdate="FALSE"/> + <roles>manager</roles> + <groups>engineering</groups> + <preferences/> + <userinfo/> + <Rules> + <Rule locator="menu" rule="role-group"/> + <Rule locator="page" rule="role-fallback"/> + </Rules> +</User> +</Users> +]]> +</source> +<p>Looking at the <b>Rule</b> element of a User, the locator can be either:</p> +<ul> +<li>page - use associated profiling rule to locate pages</li> +<li>menu - use the associated profiling rule to locate menus (if not specified, use the page locator)</li> +</ul> +<p>The <b>rule</b> attribute on the <b>Rule</b> element of a User defines which profiling rule is associated to either a page or menu locator. +If a user is not associated with a locator, then there is a system wide locator configured in the Spring configuration file <i>profiler.xml</i>. +See the contructor-arg of index = 1. This locator is the default locator, system-wide, for when there is no-associated profiling rule. +Normally, profiling rules are associated with user during activities such as the creation of new users with the User Administration portlet, +or during new user registration. +</p> +<source> +<![CDATA[ +<beans> + <!-- Profiler --> + <bean id="profilerImpl" class="org.apache.jetspeed.profiler.impl.JetspeedProfilerImpl" init-method="init"> + <constructor-arg index="0"> + <value>JETSPEED-INF/ojb/profiler_repository.xml</value> + </constructor-arg> + <constructor-arg index="1"> + <value>j2</value> + </constructor-arg> + .... +]]> +</source> + </subsection> + </section> + <section name="Hostname Profiling Rule Configuration"> + <p> +There is an option for hostnames to use the entire hostname or a prefix. +This is configured in the Spring configuration file <i>profiler.xml</i>. + </p> + <source> + <![CDATA[ + <bean id='HostnameCriterionResolver' class='org.apache.jetspeed.profiler.rules.impl.HostnameCriterionResolver'> + <!-- use the dot prefix, for ex: "accounting.xyz.com" returns "accounting" --> + <constructor-arg type="boolean" index="0"> + <value>false</value> + </constructor-arg> + </bean> +]]> + </source> + <p> +By settting the prefix boolean argument to true, the hostname resolve will only look at the prefix of the hostname. +For example, with the dot prefix flag set to true, a hostname of "accounting.xyz.com" returns "accounting". + </p> + </section> + <section name="Administering Subsites with the User Manager"> + <p>When creating a new user from User Manager Administration, you can specify two fields to enable and configure subsite behavior for that new user: + </p> + <ul> + <li><b>Profiling Rule:</b> choose a profiling rule to assign to the new user that has built in subsite support such as the example used in this document: <b>subsite-by-hostname</b>.</li> + <li><b>Subsites:</b> from the dropdown select the subsite to assign as the home subsite to the new user, or leave blank to use default /_user home.</li> + </ul> + <img src='images/newuser-subsite-admin.png' border="0"/> + <p>When using the <b>subsite-by-hostname</b> profiling rule, make sure to select a subsite from the subsites drop-down, as these two attributes work together. + The rule is the instructions on where to look for home pages, and the subsite selection tells the profiling rule which subsite will hold this user directory</p> + <p>Subsite management can also be delegated to managers of particular subsites. For example, you may want to setup User Manager Administration pages for each subsite. + By modifying the deployment descriptor for the j2-admin application, each User Manager details portlet can be configured with a different default subsite:</p> + <img src='images/subsite-fields.png' border="0"/> + </section> + <section name="Administering Subsites with User Registration"> + <p>When creating a new user from the User Registration portlet, you can specify two fields to enable and configure subsite behavior for that new user: + </p> + <ul> + <li><b>rulesValues:</b> choose a profiling rule to assign to the new user that has built in subsite support such as the example used in this document: <b>subsite-by-hostname</b>.</li> + <li><b>subsiteRootFolder:</b> the full path to one unique subsite root folder.</li> + </ul> + <img src='images/user-reg-subsite.png' border="0"/> + <p>NOTE: the User Registration portlet will store these preference values on a per user basis. Usually this means the preferences are stored for the administrative user only. + If you will have administrators registering users, then this approach works fine. However, with <b>self-registration</b> portal, you will need to set these values in the defaults for the portlet. + The defaults are usually set in the portlet.xml, for example: + </p> +<source> +<![CDATA[ +... + <preference> + <name>subsiteRootFolder</name> + <value>/__subsite-root/_hostname/localhost</value> + </preference> + <preference> + <name>rulesNames</name> + <value>page</value> + </preference> + <preference> + <name>rulesValues</name> + <value>subsite-by-hostname</value> + </preference> +... +]]> +</source> + <p>You can also set defaults on a per page (PSML) intermediate level:</p> +<source> +<![CDATA[ + <fragment id="example-subsite-1" type="portlet" name="j2-admin::UserRegistrationPortlet"> + <preference name="subsiteRootFolder"> + <value>/__subsite-root/_hostname/localhost</value> + </preference> + <preference name="rulesNames"> + <value>page</value> + </preference> + <preference name="rulesValues"> + <value>subsite-by-hostname</value> + </preference> + </fragment> +]]> +</source> + </section> + </body> +</document> Added: portals/site/jetspeed/jetspeed-2.3/jetspeed-guide-admin/src/site/xdoc/tracking.xml URL: http://svn.apache.org/viewvc/portals/site/jetspeed/jetspeed-2.3/jetspeed-guide-admin/src/site/xdoc/tracking.xml?rev=1691449&view=auto ============================================================================== --- portals/site/jetspeed/jetspeed-2.3/jetspeed-guide-admin/src/site/xdoc/tracking.xml (added) +++ portals/site/jetspeed/jetspeed-2.3/jetspeed-guide-admin/src/site/xdoc/tracking.xml Thu Jul 16 21:01:09 2015 @@ -0,0 +1,33 @@ +<?xml version="1.0"?> +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<document> + <properties> + <title>Portlet Tracking Administration Guide</title> + <subtitle>Guide to Portlet Tracking</subtitle> + <authors> + <person name="David Sean Taylor" email="[email protected]" /> + <person name="Jody McAlister" email="[email protected]" /> + </authors> + </properties> + <body> + <section name="Portlet Tracking Administration Guide"> +<p> +</p> +</section> + </body> +</document> \ No newline at end of file Added: portals/site/jetspeed/jetspeed-2.3/jetspeed-guide-admin/src/site/xdoc/user-attributes.xml URL: http://svn.apache.org/viewvc/portals/site/jetspeed/jetspeed-2.3/jetspeed-guide-admin/src/site/xdoc/user-attributes.xml?rev=1691449&view=auto ============================================================================== --- portals/site/jetspeed/jetspeed-2.3/jetspeed-guide-admin/src/site/xdoc/user-attributes.xml (added) +++ portals/site/jetspeed/jetspeed-2.3/jetspeed-guide-admin/src/site/xdoc/user-attributes.xml Thu Jul 16 21:01:09 2015 @@ -0,0 +1,39 @@ +<?xml version="1.0"?> +<!-- +Licensed to the Apache Software Foundation (ASF) under one or more +contributor license agreements. See the NOTICE file distributed with +this work for additional information regarding copyright ownership. +The ASF licenses this file to You under the Apache License, Version 2.0 +(the "License"); you may not use this file except in compliance with +the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +--> +<document> + <properties> + <title>User Attributes</title> + <subtitle>User Information Configuration</subtitle> + <authors> + <person name="Ate Douma" email="[email protected]"/> + </authors> + </properties> + <body> + <section name="Defining User Attributes in Jetspeed-2"> + <p> + Jetspeed-2 is provided with several Administrative Portlets, including for User Management.<br/> + Using the User Management Portlets, it is very easy to define or modify concrete attributes for a user:</p> + <img src="images/definingUserAttributes.jpg"/> + <p> + The User Info Test demo Portlet, default deployed in Jetspeed-2 and displayed on the start page, uses + the above example User Attribute definitions and displays the values for the logged on user (also showing that + these can be accessed from both the PortletRequest as well as the HttpServletRequest from within a servlet):</p> + <img src="images/usingUserAttributes.jpg"/> + </section> + </body> +</document> Added: portals/site/jetspeed/jetspeed-2.3/jetspeed-guide-admin/src/site/xdoc/user-profiler.xml URL: http://svn.apache.org/viewvc/portals/site/jetspeed/jetspeed-2.3/jetspeed-guide-admin/src/site/xdoc/user-profiler.xml?rev=1691449&view=auto ============================================================================== --- portals/site/jetspeed/jetspeed-2.3/jetspeed-guide-admin/src/site/xdoc/user-profiler.xml (added) +++ portals/site/jetspeed/jetspeed-2.3/jetspeed-guide-admin/src/site/xdoc/user-profiler.xml Thu Jul 16 21:01:09 2015 @@ -0,0 +1,45 @@ +<?xml version="1.0"?> +<!-- +Licensed to the Apache Software Foundation (ASF) under one or more +contributor license agreements. See the NOTICE file distributed with +this work for additional information regarding copyright ownership. +The ASF licenses this file to You under the Apache License, Version 2.0 +(the "License"); you may not use this file except in compliance with +the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +--> +<document> + <properties> + <title>User Attributes</title> + <subtitle>User Information Configuration</subtitle> + <authors> + <person name="David Sean Taylor" email="[email protected]"/> + </authors> + </properties> + <body> +<section name='Principal Rules'> +<p>Each user principal can be mapped to specific profiling rule. This association is stored in the Jetspeed database. +The association is three-way, combining the PRINCIPAL + PROFILING RULE + LOCATOR, where the locator values +currently supported are <quote>menu</quote> or <quote>page</quote>. Thus we can have two different profiling rules +applied for locating resources per user: locate pages and locate menus. When the profiler attempts to locate a page +for the current user, it will apply the profiling rule for the given user. The Jetspeed User Administration portlet +has a tab for editing user profile information: +</p> +<p> +<img src="images/user-profile-locator.jpg" border="1"/> +</p> +<p> +Often, profiling rules are determined and then associated by portal-specific logic during user registration (or self-registration). +A Jetspeed-specific self-registration portlet could handle the registration process of adding a user to the system, granting roles, +setting user attributes, and assigning the profiling rule for the user. +</p> +</section> + </body> +</document> Added: portals/site/jetspeed/jetspeed-2.3/jetspeed-guide-admin/src/site/xdoc/users.xml URL: http://svn.apache.org/viewvc/portals/site/jetspeed/jetspeed-2.3/jetspeed-guide-admin/src/site/xdoc/users.xml?rev=1691449&view=auto ============================================================================== --- portals/site/jetspeed/jetspeed-2.3/jetspeed-guide-admin/src/site/xdoc/users.xml (added) +++ portals/site/jetspeed/jetspeed-2.3/jetspeed-guide-admin/src/site/xdoc/users.xml Thu Jul 16 21:01:09 2015 @@ -0,0 +1,311 @@ +<?xml version="1.0"?> +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<document> + <properties> + <title>User Administration Guide</title> + <subtitle>Guide to Administering Users</subtitle> + <authors> + <person name="David Sean Taylor" email="[email protected]" /> + <person name="Jody McAlister" email="[email protected]" /> + <person name="Niels van Kampenhout" email="[email protected]"/> + <person name="Ate Douma" email="[email protected]"/> + </authors> + </properties> + <body> + <section name="User Administration Guide"> + <p> + User Management is where you manage individual portal users. You can create new users, and edit or remove existing users. + You can set a user's password, and manage a user's attributes, roles, group memberships, and profiling rules. + The User Management page is located inside the Jetspeed Administrative Portlets section. + The User Management page is the first tab on the administrative menu across the top. + Here you see the User Browser. + </p> + </section> + <section name="The User Browser"> + <p> + The User Browser portlet lists all portal users, and allows you to search for + a particular user. + </p> + <p> + <img src="images/userbrowser.png"/> + </p> + <subsection name="Paging"> + <p> + If there are more than 10 users in the system, the user listing is spread over + several pages each displaying 10 users. You can navigate through the pages + using the buttons right below the listing. Clicking on the "Refresh" button + will reset the user listing to the first page. + </p> + <p> + <img src="images/pagingbuttons.png"/> + </p> + </subsection> + <subsection name="Searching"> + <p> + You can search for a particular user by entering the username or part of the username + in the search text box. After clicking on the "Search" button, the user listing + will show the search results, starting with the user that best matched your search + query, followed by the users that normally appear after the matched user in alphabetical order. + </p> + <p> + <img src="images/usersearch.png"/> + </p> + </subsection> + <subsection name="Filtering"> + <p> + To get only exact matches when searching for (or part of) a particular username, check the "filter" + checkbox below the search text box. + </p> + <p> + <img src="images/userfilter.png"/> + </p> + </subsection> + <subsection name="Selecting for Edit"> + <p> + To select one of the users in the listing for editing, click on the username. + A small arrow will appear in front of the username to indicate it is currently + selected, and the user's details will be loaded in the User Details Information + portlet. + </p> + <p> + <img src="images/userselected.png"/> + </p> + </subsection> + </section> + + <section name="User Detail Information"> + <p> + The User Detail Information portlet allows you to manage a particular user's + attributes, credentials, roles, group memberships, and profiles. Each of these + is represented on a different tab in the portlet. + </p> + <p> + <img src="images/userdetailsmall.png"/> + </p> + <subsection name="User Attributes"> + <p> + User attributes are any kind of information you might want to store about your + users in your portal. Examples are first and last name, address, phone number, + or organization dependant attributes such as employee or student number. + Each attribute is a simple name-value pair. You can create as many attributes + as you like. + </p> + <p> + User attributes for a user are managed within the "Attributes" tab. Existing + attributes for the selected user are displayed in a list. The values of the attributes + can be edited directly in the text boxes in the "Value" column. To store your + changes, check the checkbox in front of each attribute you changed, and click + on the "Update" button. To remove attributes, check the checkbox in front of each attribute + you wish to delete, and click on the "Remove" button. + </p> + <p> + To create a new attribute, enter a name and a value in the form directly below the + attribute listing. You can enter anything for the name and value. Click on the "Add" + button to store the new attribute. Note that if you use the name of an + existing attribute, its value will be overwritten. + </p> + <p> + <img src="images/defininguserattributes.png"/> + </p> + </subsection> + <subsection name="Password Credentials"> + <p> + For details on managing user credentials see <a href="credentials.html">Credentials</a>. + </p> + </subsection> + <subsection name="Role"> + <p> + On the "Role" tab you can manage the roles that the currently selected user has been assigned. The roles itself + can be managed on the <a href="roles.html">Role Management</a> page. The roles the selected user + currently has been assigned are listed. You can assign a new role to the user by selecting a role + from the dropdown, and clicking on the "Add" button. The new role will immediately appear in the listing. + To remove a role, check the role's checkbox in the listing and click on the "Remove" button. The role + will disappear from the listing. + </p> + <p> + <img src="images/userdetailrole.png"/> + </p> + </subsection> + <subsection name="Group"> + <p> + On the "Group" tab you can manage the group memberships of the currently selected user. The groups itself + can be managed on the <a href="groups.html">Group Management</a> page. The groups the selected user + currently is a member of are listed. You can add a user to a group by selecting the group + from the dropdown, and clicking on the "Add" button. The group will immediately appear in the listing. + To remove a user from a group, check the group's checkbox in the listing and click on the "Remove" button. The group + will disappear from the listing. + </p> + <p> + <img src="images/userdetailgroup.png"/> + </p> + </subsection> + <subsection name="Profile"> + <p>Each user principal can be mapped to specific profiling rule. This association is stored in the Jetspeed database. +The association is three-way, combining the PRINCIPAL + PROFILING RULE + LOCATOR, where the locator values +currently supported are <quote>menu</quote> or <quote>page</quote>. Thus we can have two different profiling rules +applied for locating resources per user: locate pages and locate menus. When the profiler attempts to locate a page +for the current user, it will apply the profiling rule for the given user. The Jetspeed User Administration portlet +has a tab for editing user profile information: +</p> +<p> +<img src="images/user-profile-locator.png" /> +</p> +<p> +Often, profiling rules are determined and then associated by portal-specific logic during user registration (or self-registration). +A Jetspeed-specific self-registration portlet could handle the registration process of adding a user to the system, granting roles, +setting user attributes, and assigning the profiling rule for the user. +</p> + </subsection> + <subsection name="Deleting a User"> + <p> + To remove a user from the system, click on the "Remove User" button. + This action is permanent. A message indicating that the node has been removed and that the user you just deleted does not exist + will be displayed. + </p> + <p> + <img src="images/usermessage.png"/> + </p> + + </subsection> + <subsection name="User Details Configuration"> + <p> + Configuring a User Details portlet in Edit Mode allows you to customize the view of the User Details administration window. + Each tab can be optionally shown or hidden. Also, default values for roles, new user, required role, profile, user template, + subsite root folder and default subsite new user can be set. + </p> + <p> + <img src="images/userdetailedit.png"/> + </p> + <table> + <tr> + <th>Field</th> + <th>Description</th> + </tr> + <tr> + <td>Show User Tab</td> + <td>Show or hide the User tab.</td> + </tr> + <tr> + <td>Show Attributes Tab</td> + <td>Show or hide the Attributes tab.</td> + </tr> + <tr> + <td>Show Password Tab</td> + <td>Show or hide the Password tab.</td> + </tr> + <tr> + <td>Show Password Expiration</td> + <td>Show the password expiration date on the Password tab, and the options to activate/expire/extend the password.</td> + </tr> + <tr> + <td>Show Role Tab</td> + <td>Show or hide the Role tab.</td> + </tr> + <tr> + <td>Show Group Tab</td> + <td>Show or hide the Group tab.</td> + </tr> + <tr> + <td>Show Profile Tab</td> + <td>Show or hide the Profile tab.</td> + </tr> + <tr> + <td>Show Password on User Tab</td> + <td>Show or hide password information User tab. If enabled, User Tab effectively offers the same functionality as the Password tab.</td> + </tr> + <tr> + <td>Define default "Change Password Required on First Login" for new User</td> + <td>Show or hide the option to set "Change Password Required on First Login" in the Add User form.</td> + </tr> + <tr> + <td>Define default Role for new User</td> + <td>Show or hide the option to define a default role in the Add User form.</td> + </tr> + <tr> + <td>Define default Profile for new User</td> + <td>Show or hide the option to define a default profile in the Add User form.</td> + </tr> + <tr> + <td>Allow assignment of Subsite for new User</td> + <td>Show or hide the option to define a default subsite in the Add User form.</td> + </tr> + <tr> + <td>Default "Change Password Required on First Login"</td> + <td>Check or uncheck the "Change Password Required on First Login" checkbox in the Add User form (if enabled by checking Define + default "Change Password Required on First Login" for new User, see above).</td> + </tr> + <tr> + <td>Default Role for new User</td> + <td>Pre-select a role in the Default Role dropdown in the Add User form.</td> + </tr> + <tr> + <td>Required Role for new User</td> + <td>Sets a required role for new users, that gets assigned to each new user regardless of the Default Role setting.</td> + </tr> + <tr> + <td>Default Profile for new User</td> + <td>Pre-select a profile in the Defaylt Profile dropdown in the Add User form.</td> + </tr> + <tr> + <td>New User Template Directory</td> + <td>TODO</td> + </tr> + <tr> + <td>Subsite Root Folder</td> + <td>TODO</td> + </tr> + <tr> + <td>Default Subsite for new User</td> + <td>TODO</td> + </tr> + </table> + <!-- + <p> + The User Details configuration is useful for delegated security scenarios. For example, setting up a User Management + page for all users with the Developer role. First, setup the User Browser preference to FilterByRole on Developer. + Then you can assign a default role, required role, new user template, and subsite area all for new developers, managed + by a user with the DeveloperManager role. This user then can create only developer type users complete with the correct + roles and user templates. The edit mode of the User Details portlet can be secured so that the global admin can only + edit the configuration, limiting the development manager to only creating or deleting developers. + </p> + --> + </subsection> + </section> + + + <section name="Adding a New User"> + <p> + New users can be entered through the User Details portlet. If you haven't selected any user from the + User Browser yet, the User Details portlet will show the "Add User" form. If you did select a user, + click on the "Add New User" button in the bottom of the portlet to go to the "Add User" form. + </p> + <p> + <img src="images/useradduserbutton.png"/> + </p> + <p> + <img src="images/userdetailnormal.png"/> + </p> + <p> + From here you can create a new user. Choose a unique username with no spaces. Then enter a secure password. + You can require the password to be changed on the first login. You can also select the default role assigned + to this user, as well as a default profiling rule. Last, you can assign this user to a subsite. + </p> + </section> + + </body> +</document> \ No newline at end of file Added: portals/site/jetspeed/jetspeed-2.3/jetspeed-guide-build/pom.xml URL: http://svn.apache.org/viewvc/portals/site/jetspeed/jetspeed-2.3/jetspeed-guide-build/pom.xml?rev=1691449&view=auto ============================================================================== --- portals/site/jetspeed/jetspeed-2.3/jetspeed-guide-build/pom.xml (added) +++ portals/site/jetspeed/jetspeed-2.3/jetspeed-guide-build/pom.xml Thu Jul 16 21:01:09 2015 @@ -0,0 +1,65 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + + $Id: pom.xml 775036 2009-05-15 06:52:14Z taylor $ +--> +<project xmlns="http://maven.apache.org/POM/4.0.0"; xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; + xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd";> + + <modelVersion>4.0.0</modelVersion> + <prerequisites> + <maven>2.0.9</maven> + </prerequisites> + + <artifactId>jetspeed-guide-build</artifactId> + <name>Jetspeed Build Guide</name> + <description>Jetspeed 2.2 Build Guide</description> + <packaging>pom</packaging> + <parent> + <artifactId>jetspeed-site-docs</artifactId> + <groupId>org.apache.portals.site</groupId> + <version>2.2</version> + </parent> + + <!-- this is for a bug Maven, see http://jira.codehaus.org/browse/MSHARED-18 + should be removed once Maven incorporates this bug in an official release--> + <build> + <plugins> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-site-plugin</artifactId> + <version>2.0</version> + </plugin> + </plugins> + </build> + + <reporting> + <plugins> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-project-info-reports-plugin</artifactId> + <reportSets> + <reportSet> + <reports> + </reports> + </reportSet> + </reportSets> + </plugin> + </plugins> + </reporting> + +</project> Added: portals/site/jetspeed/jetspeed-2.3/jetspeed-guide-build/src/site/resources/images/build-guide.png URL: http://svn.apache.org/viewvc/portals/site/jetspeed/jetspeed-2.3/jetspeed-guide-build/src/site/resources/images/build-guide.png?rev=1691449&view=auto ============================================================================== Binary file - no diff available. Propchange: portals/site/jetspeed/jetspeed-2.3/jetspeed-guide-build/src/site/resources/images/build-guide.png ------------------------------------------------------------------------------ svn:mime-type = application/octet-stream Added: portals/site/jetspeed/jetspeed-2.3/jetspeed-guide-build/src/site/site.xml URL: http://svn.apache.org/viewvc/portals/site/jetspeed/jetspeed-2.3/jetspeed-guide-build/src/site/site.xml?rev=1691449&view=auto ============================================================================== --- portals/site/jetspeed/jetspeed-2.3/jetspeed-guide-build/src/site/site.xml (added) +++ portals/site/jetspeed/jetspeed-2.3/jetspeed-guide-build/src/site/site.xml Thu Jul 16 21:01:09 2015 @@ -0,0 +1,66 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<project name="Jetspeed Build Guide"> + <publishDate format="d MMMM yyyy"/> + <bannerLeft> + <name>Jetspeed Build Guide</name> + <src>images/jetspeed-logo.gif</src> + <href>http://portals.apache.org/jetspeed-2/</href> + </bannerLeft> + <bannerRight> + <name>Jetspeed Build Guide</name> + <href>http://portals.apache.org/jetspeed-2/buildguide/</href> + <src>images/build-guide.png</src> + </bannerRight> + + <skin> + <groupId>org.apache.portals.jetspeed-2</groupId> + <artifactId>jetspeed-maven-skin</artifactId> + <version>2.2.2</version> + </skin> + <body> + + <links> + <item name="Home" href="../index.html"/> + <item name="Admin Guide" href="../adminguide/index.html"/> + <item name="Deployers Guide" href="../deployguide/index.html"/> + <item name="Developers Guide" href="../devguide/index.html"/> + <item name="Users Guide" href="../usersguide/index.html" /> + </links> + + <menu name="Build Guide"> + <item name="Overview" href="index.html" /> + <item name="Project Layout" href="project-layout.html" /> + <item name="Portal Resources" href="jetspeed-portal-resources.html" /> + <item name="Custom Maven lifecycles" href="the-need-for-a-custom-lifecycle.html" /> + </menu> + <menu name="Building Jetspeed"> + <item name="From Source" href="maven-2-build.html" /> + <item name="Jetspeed Archetype" href="jetspeed-archetype.html" /> + </menu> + <menu name='Plugins'> + <item name="Plugins Overview" href="jetspeed-maven-plugins.html" /> + <item name="Mvn Plugin" href="jetspeed-mvn-plugin.html" /> + <item name="Unpack Plugin" href="jetspeed-unpack-plugin.html" /> + <item name="DB init Plugin" href="jetspeed-db-init-plugin.html" /> + <item name="DB ddl Plugin" href="jetspeed-db-ddl-plugin.html" /> + <item name="Deploy Plugin" href="jetspeed-deploy-plugin.html" /> + </menu> + + </body> +</project>
