ATG Portal Development Guide
.
Documentation Home
Feedback
Highlighting
Prev
Up
Next
Portals and Gears
This section provides an overview of portals and gears.
Contents
Search
Introduction
Portals and Gears
What Is a Portal?
What Is a Gear?
Gear Definitions and Gear Instances
PAF Services
PAF Administration Pages
Security Levels
Gear Implementation Overview
Other Resources
Portal Requests and the Filter Chain
Portal Context
GearContext
The Portal Request
HTTP Parameters and Request Headers
Request Path Elements
Gear Servlet Request
Portal Objects
Mapping Hostnames and URLs to Portals
Object Lookup
The Portal Response
Response URIs
GearServletResponse
The Portal Filter Chain
Portal Filter Chain Elements
Portal Server Filter
Gear Filter
Display Filter
Device Filter
DeviceOutput Filter
Portal Filter
Community Filter
Page Filter
Access Filter
Offline Filter
Dynamo 5 Style Attributes
Page Template Dispatch Servlet
The Portal Page Structure
How Gear Rendering Works
Portal Templates
Page Template
Layout Template
Gear Title Template
Wireless Templates
The Shared Deck Template
The Full Deck Template
Gears and the Portal Application Framework
How Portal Pages Are Rendered
How the PAF Processes Page Requests
Tag Libraries and Gear Development
Link URLs
URL Usage
Form Handling
Gear Form Handling
Gear Configuration Form Handling
JSP Form Handling
Configuring Gears to Work with Persistent Data Repositories
Keeping Gears Synchronized with Each Other
Performance Recommendations
Portal Security
Security Roles
Predefined Security Areas
Security Tags
Role Test Tags
Role Test Methods
includeOnly Tag
Include Filter
J2EE Security
Secure Socket Layer Security
Designing a Gear
Gear Modes
Display Modes
Device Outputs
Matrix of Gear Modes, Display Modes, and Device Outputs
User Interface Look and Feel Recommendations
Minimum Gear Sizing Rules
Gear Dimensions
Portal and Gear Roles
Gear Alerts
Gear Administration Considerations
Localization Considerations
Creating Configurable, Localizable Content in Gears
Localized Gear Names and Descriptions
Extending an Existing Gear
Example: A Discussion Forum Gear
Roles
Choosing Display Modes
Creating Gear Page Fragments
HTML Considerations
Layout Considerations
Accessibility Recommendations
Page Elements
Tag Library Declaration
DSP Page Initialization
Gear Environment Initialization
Gear Configuration Page Fragments
Developing Install Configuration Pages
Developing Initial, Instance, or User Configuration Pages
Example: A Document Exchange User Configuration Page
Message Handling in Page Fragments
I18nMessageProcessor
Adding Messages
Message Handling Example
Avoiding Gear Instance Conflicts
Naming Conventions
Wireless Gear Page Fragments
Wireless Markup Language
Wireless Device Emulator
Gear Packaging and Deployment
Gear Manifests
The Gear Manifest File Format
Wireless Gear Deployment Considerations
Gear Assembly
Gear Manifest
Developing and Deploying Portlets
Portlets and Gears
Comparison of Portlets and Gears
Developing a Portlet
Helloworld Portlet
Portlet Class
Portlet Deployment Descriptor File
Web Application Deployment Descriptor
Portlet JSPs
Helloworld Servlet Beans
Portlet Deployment Tool
Running the Portlet Deployment Tool
Portlet Deployment Tool Arguments
Web Services for Remote Portlets
WSRP Overview
Producer Overview
Consumer Overview
Producer Administration
Starting Up the Producer
Producer Database Configuration
Using the Producer Administration UI
Importing Portlet Descriptions
Consumer Administration
Starting Up the Consumer Module
Consumer Database Configuration
Using the Consumer Administration UI
Adding a New Producer to a Consumer
Modifying Producer Information
Deleting a Producer
Configuring a ProxyPortlet Instance
Adding Gear Alerts
Alerts Overview
Alert Services Provided by the PAF and Baseline Gears
Baseline Gear Events
Baseline Gear Scenario Templates
PAF Events
Adding Custom Alert Messages to Gears
Sample GearMessage Extension
Adding GearMessagePublisher to the Gear
Sample Sending Code
Sample dynamoMessagingSystem.xml File
Adding the Alerts Element to the Gear Manifest File
Creating a Resource Bundle Properties File
Creating an E-mail Template File
Creating an Alert Instance Configuration Form
Extending the Scenario User Interface
Configuring a Scenario
Adding Alert Channels
Configuring an AlertChannel Component
AlertHandlerInterface
Registering the New Alert Channel
Configuring Alert Channel Preferences
Source Handlers and Target Handlers
Source Handlers
Target Handlers
Administrative Alerts and Framework Alerts
Creating a Custom Portal
Creating a New Portal
Copying the Portal Template
Editing Portal Framework Files
Setting Up the Portal Database
Starting Up Your Custom Portal Module
Further Customization
Customizing Portal Appearance
Manifest File Formats for Customizing Portal Appearance
Manifest File Headers
Color Palette Manifests
Stylesheet Manifests
Page Template Manifests
Layout Template Manifests
Gear Title Template Manifests
Customizing Portal Authentication
Authentication Pages
Specifying Authentication Page Locations
Portal Manifest Reference
Portal Manifest Elements
<portal-manifest> Element
Gear Manifest Elements
<gear-definitions> Element
<gear-definition> Element
<servlet-context> Element
<gear-modes> Element
<gear-mode> Element
<display-modes> Element
<display-mode> Element
<dimensions> Element
<dimension> Element
<error-handling> Element
<instance-parameters> Element
<user-parameters> Element
<alerts> Element
<alert-message> Element
Page Template Manifest Elements
<page-templates> Element
<page-template> Element
Layout Template Manifest Elements
<layout-templates> Element
<layout-template> Element
Gear Title Template Manifest Elements
<gear-title-templates> Element
<gear-title-template> Element
Color Palette Manifest Elements
<color-palettes> Element
<color-palette> Element
<images> Element
<image> Element
<entity> Element
<color> Element
Color Palette Example
Stylesheet Manifest Elements
<styles> Element
<style> Element
The Portal Manifest DTD
PAF Tag Library Reference
paf:layout
paf:titlebar
paf:hasRole
paf:hasCommunityRole
paf:hasGearRole
paf:renderTab
paf:defaultTab
paf:currentTab
paf:encodeURL
paf:context
paf:include
Index
