Chapter 1. JBoss Portal Basics - JBoss Portal 2.6 User Guide 英文版用户使用指南文档

JBoss Portal supports mutliple portal instances running within one container. A portal instance can be viewed as a 'bucket', containing portal objects such as, Portal Pages, Themes, Layouts, and Portlet Windows. It also manages the relationship between the user and the portal itself. The hierarchy of portal objects is depicted as follows:

A portal instance is reachable by the url format http://[domain]/[context]/portal/[portal_name] . In a default/local install, the default portal instance can be reach by http://localhost:8080/portal/portal/default .

A Portal Page is an aggregator of Portlet Windows. It is generated by the portal, during the reponse phase. During this phase, the portal aggregates all of the HTML markup created the individual portlets, decorates them with window controls, and presents them to the user as a consolidated page.

A portal page is reachable by the url format http://[domain]/[context]/portal/[portal_name]/[page_name] . In a default/local install, the default page can be reach by http://localhost:8080/portal/portal/default/default . Likewise, the News Page in a default install can be reached by http://localhost:8080/portal/portal/default/News .

More, on navigating the portal pages and what they contain can be found in, Section 1.2, “The Portal Pages”

Portlet Windows are found on Portal Pages and contain the HTML markup for a specific portlet instance.

The diagram above, shows the default JBoss Portal page with certain window-related items highlited (in red). Lets look at these items:

Navigating the portal pages is normally performed either by typing in a specific URL ( Section 1.1.2, “Portal Pages” ), or using the Navigation Tabs at the top of the page.

Altervatively, once logged in, you are able to navigate to your Dashboard or the Admin Portal by using the navigation elements, located in the top-right of the main portal page.

Each page, in the default installation of JBoss Portal is explained in the following sections, along with the portlets found within them.

Logging in to the portal is accomplished by clicking the Login link at the top-right of the portal page. You can login, using the following credentials:

               
user/user
admin/admin
               
            

Once logged in, the top-right menu will change so you can then navigate to your personal dashboard and other functionality that is included therein.

The default page contains the following portlets:

1.2.3.1. Greetings Portlet

Displays hard-coded links to downloading JBoss Portal, downloading portlets from PortletSwap.com, and the live online JBoss Portal demo. It also contains default authentication information on loging in.

1.2.3.2. User Portlet

Note

Administrators should view, Section 4.1, “Managing Users” , for managing the portal Userbase. Only user operations are covered in this section...

Once successfully logged in, the user will have additional functionality at his disposal, that is covered in the following sections.

The User Portlet allows a user to:

• Create a new account

  Create a new account by clicking on the Create link in the portlet. A User can then fill in the necessary information to create an account on the system:

• Edit personal information.

  A user has the ability to edit his personal information at any time by clicking on the Edit Info link.

1.2.3.3. CMS Portlet

Renders data from the Content Management System embedded with the Portal. Users are able to navigate the content, view images, binary files, etc.. via this portlet.

Displaying content is done by the portal using a path mapper. For example, if we wanted to display a zip file, located in /default/foo/bar.zip , we would type in the URL http://localhost:8080/content/default/foo/bar.zip . Notice how the path to the content, is prefixed with the '/content' term. Although in this example we are describing binary content retrieval, the same is to be said for text/html files. Keep in mind, however, that binary files are displayed outside of the portal pages, but text/html are displayed inside the CMSPortlet Window.

Serving Logic: The CMS Portlet now serves content based on the user's locale setting. For example: if a user's locale is set to Spanish in his browser, and he requests URL: default/index.html , the CMSPortlet will first try and retrieve the Spanish version of that file. If a Spanish version is not found, it will then try and retrieve the default language version set for the CMSPortlet (set to English, by default).

Note

Administrators should view, Chapter 3, Administration - Content Management System , for managing the data in the CMS.

1.2.3.4. Navigation Portlet

The News Page contains customizable weather and news displays from common internet feeds. An open internet connection on the server-side is therefore required for them to operate. ;-)

This page contains the following portlets:

1.2.4.1. Weather Portlet

The Weather Portlet retrieves an RSS weather feed, based on a key (commonly a US Postal Code), and displays it as HTML to the user.

Additionally, a user is able to modify his preference in location by going in to the Portlet's Edit Mode (click ). Any valid US Postal Code can be inputted here. Once the form is submitted, this property will be saved in the user's preference, so he will always see the same weather data for his location, when logged in.

Not in the United States? Follow these steps to configure the Weather portlet to display information for your area.

1. Go to http://weather.yahoo.com/

2. Enter your city name in the location field, found on the page:

3. Find your location on the list under the form and click on it (In this case, its Marseille, France ):

4. Copy the location digits from the address bar in your browser (In this case, its FRXX0059 ):

5. Paste these numbers in to the weather portlet edit form (In this case, its FRXX0059 ):

   Hit submit ...

1.2.4.2. News Portlet

The News Portlet retrieves an RSS news feed, based on a url, and displays it as HTML to the user.

Additionally, a user is able to modify his preference in RSS feed source by going in to the Portlet's Edit Mode (click ). Once the form is submitted, this property will be saved in the user's preference, so he will always see the same news source, when logged in.

Note

This portlet is capable of handling most RSS 1.0 and RSS 2.0 feeds.

Items in this test page change frequently. They are used mainly by the JBoss Portal Development team to debug and test new functionality. For that reason, these items are not covered in this document. It is recommended that Portal Administrators remove this page for that reason.