JBoss Portal 2.4

Reference Guide

Thomas Heute

Roy Russo

Boleslaw Dawidowicz

Release 2.4 "Devil"

July 2006


Table of Contents

JBoss Portal - Overview
Feature List
Target Audience
Acknowledgements
1. System Requirements
1.1. Minimum System Requirements
1.2. Supported Operating Systems
1.3. JBoss Application Server
1.4. Database
1.5. Source building
2. Installation
2.1. Installing from Bundled Download
2.1.1. Installing the Bundle
2.2. Installing from Binary Download
2.2.1. Setting up your environment
2.2.1.1. Getting the Binary
2.2.1.2. Application Server Setup
2.2.1.3. Database Setup
2.2.1.4. DataSource Configuration
2.2.2. Deploying JBoss Portal
2.3. Installing from Sources
2.3.1. Getting the Sources
2.3.2. Setting up your environment
2.3.2.1. Application Server Setup
2.3.2.2. Operating System Environment Setting
2.3.2.3. Database Setup
2.3.2.4. DataSource Configuration
2.3.3. Building/Deploying from Sources
3. Customizing your installation
3.1. Changing the port
3.2. Changing the context path
3.3. Forcing the DB dialect
3.3.1. DB Dialect settings for the portal core
3.3.2. DB Dialect settings for the CMS component
4. Upgrading 2.2 - 2.4
4.1. Migrating the Database
4.1.1. Database Requirements/Preparation
4.1.2. DataSource Requirements/Preparation
4.1.3. Obtaining the Migration Application
4.1.3.1. Downloading binary
4.1.3.2. Building from source
4.1.4. Deploying the Migration Application
4.1.5. Running the Migration Application
4.1.6. Final steps
4.2. Migrating Portlet Descriptors
4.2.1. Car Demo Portlet example
4.2.2. Updating Car Demo Portlet descriptors
5. Portlet Primer
5.1. JSR 168 Overview
5.1.1. Portal Pages
5.1.2. Rendering Modes
5.1.3. Window States
5.1.4. Section Status
5.2. Tutorials
5.2.1. Deploying your first portlet
5.2.1.1. Introduction
5.2.1.2. Package Structure
5.2.1.3. The Portlet Class
5.2.1.4. The Application Descriptors
5.2.1.5. Building your portlet
5.2.1.6. Deploying your portlet
5.2.2. A Simple JSP Portlet
5.2.2.1. Introduction
5.2.2.2. Package Structure
5.2.2.3. The Portlet Class
5.2.2.4. The Application Descriptors
5.2.2.5. JSP files and the portlet taglib
5.2.2.6. Building your portlet
5.2.2.7. Deploying your portlet
5.2.3. A Simple JSF Portlet
5.2.3.1. Introduction
5.2.3.2. Package Structure
5.2.3.3. The Application Descriptors
5.2.3.4. The JSP files
5.2.3.5. Building your portlet
5.2.3.6. Deploying your portlet
6. XML Descriptors
6.1. Portlet Descriptors
6.1.1. *-object.xml
6.1.2. portlet-instances.xml
6.1.3. jboss-portlet.xml
6.1.3.1. Injecting Header Content
6.1.3.2. Injecting Services in the portlet context
6.1.3.3. Portlet Session Replication in a Clustered Environment
6.1.4. portlet.xml
6.2. JBoss Portal Descriptors
6.2.1. Datasource Descriptor (portal-*-ds.xml)
6.2.1.1. Obtaining Datasource Descriptors Binary releases
6.2.1.2. Building Datasource Descriptors from Source
6.2.2. Portlet Debugging (jboss-portal.sar/conf/config.xml)
6.3. Descriptor Examples
6.3.1. Defining a new portal page
6.3.2. Defining a new portal instance
7. Portal urls
7.1. Introduction
7.2. Acessing a portal
7.3. Accessing a page
7.4. Accessing CMS Content
8. Clustering Configuration
8.1. Introduction
8.2. Considerations
8.3. JBoss Portal Clustered Services
8.3.1. Portal Session Replication
8.3.2. Hibernate clustering
8.3.3. Identity clustering
8.3.4. CMS clustering
8.4. Setup
8.5. Portlet Session Replication
8.5.1. JBoss Portal configuration
8.5.2. Portlet configuration
8.5.3. Limitations
9. Web Services for Remote Portlets (WSRP)
9.1. Introduction
9.2. Deploying JBoss Portal's WSRP services
9.3. Making a portlet remotable
9.4. Accessing JBoss Portal's WSRP Producer from a remote Consumer
9.5. Consuming remote WSRP portlets in JBoss Portal
9.5.1. Overview
9.5.2. Required configuration information
9.5.3. Optional configuration
9.5.4. Examples
10. Security
10.1. Securing Portal Objects
11. CMS Portlet
11.1. Introduction
11.2. Features
11.3. CMS Configuration
11.3.1. Welcome page
11.3.2. Service Configuration
11.3.2.1. Tuning Jackrabbit
11.3.2.2. Changing the url under which the content should be accessible
11.3.3. Configuring the Content Store Location
11.3.3.1. 100% Filesystem Storage
11.3.3.2. 100% Database Storage
11.3.3.3. Mixed Storage
11.4. Localization Support
11.5. CMS Service
11.5.1. CMS Interceptors
11.5.2. CMS Cache
12. Layouts and Themes
12.1. Overview
12.2. Layouts
12.2.1. How to define a Layout
12.2.2. How to use a Layout
12.2.2.1. Declarative use
12.2.2.2. Programatic use
12.2.3. Where to place the Descriptor files
12.2.4. How to connect a Layout to a Layout Strategy
12.2.5. Layout JSP-tags
12.3. Layout Strategy
12.3.1. What is a Layout Strategy
12.3.2. How can I use a Layout Strategy
12.3.2.1. Define a Strategy
12.3.2.2. Specify the Strategy to use
12.3.3. Linking the Strategy and the Layout
12.4. RenderSets
12.4.1. What is a RenderSet
12.4.2. How is a RenderSet defined
12.4.3. How to specify what RenderSet to use
12.5. Themes
12.5.1. What is a Theme
12.5.2. How to define a Theme
12.5.3. How to use a Theme
12.5.4. How to write your own Theme
12.6. Other Theme Functionalities and Features
12.6.1. Content Rewriting and Header Content Injection
12.6.2. Declarative CSS Style injection
12.6.3. Disabling Portlet Decoration
12.7. Theme Style Guide (based on the Industrial theme)
12.7.1. Overview
12.7.2. Main Screen Shot
12.7.3. List of CSS Selectors
13. Troubleshooting and FAQ
13.1. Troubleshooting and FAQ

Release 2.4 "Devil"

July 2006