OCPSoft.com - Simple SolutionsCommunity Documentation

PrettyFaces Reference Guide

URL-rewriting, dynamic parameters, bookmarks, and navigation for Servlet, Java EE, and JSF

by Lincoln Baxter III and Christian Kaltepoth
1. Introduction
1.1. Using this guide
1.2. What PrettyFaces provides
1.3. Business value of URL-rewriting
2. Get Started
2.1. Get PrettyFaces
2.2. Configure PrettyFaces in web.xml
2.3. Create /WEB-INF/pretty-config.xml
2.4. PrettyFaces Development Mode
3. Configure PrettyFaces
3.1. Create your first bookmarkable URL (mapping a URL)
3.2. Add Path-parameters to your mapped URL (REST)
3.2.1. Named path parameters
3.2.2. * EL-injected path parameters
3.2.3. Restrict what Path Parameters will accept (Custom regex patterns)
3.3. Manage Query-parameters in mapped URLs
3.4. Inherit from a parent URL-mapping
3.5. * Dynamic view-IDs (DynaView)
3.6. * Load data when accessing mapped URLs (Page-action methods)
3.6.1. Invoking navigation from a page-action
3.6.2. Invoking during specific JSF Phases
3.6.3. Toggling invocation on postback
3.7. * Parameter validation
3.7.1. Query parameters
3.7.2. Path parameters
3.8. Annotation based configuration
3.8.1. Basic setup
3.8.2. Simple URL mappings
3.8.3. Page actions
3.8.4. Query Parameters
3.8.5. Parameter validation
3.8.6. Bean name resolving
4. Order of Events
4.1. Request processing order
4.2. Configuration processing order
5. Simplify Navigation
5.1. * Integrating with JSF action methods
5.2. * Integrating with JSF commandLink and commandButton
5.3. Redirecting from non-JSF application Java code
5.4. * Preserving FacesMessages across redirects
6. Inbound URL Rewriting
6.1. Common rewriting features
6.2. Rewriting URLs that match a specific pattern
6.3. Rewrite options
7. Outbound URL-rewriting
7.1. Rewriting URLs in Java
7.2. * Rewriting URLs in JSF views
7.3. Disabling outbound-rewriting for a URL-mapping
8. * Rendering HTML links and URLs
8.1. The <pretty:link> component
8.2. The <pretty:urlbuffer> component
8.3. Using JSF standard components
9. Extend PrettyFaces
9.1. com.ocpsoft.pretty.faces.spi.ConfigurationProvider
9.2. com.ocpsoft.pretty.faces.spi.ConfigurationPostProcessor
9.3. com.ocpsoft.pretty.faces.spi.ELBeanNameResolver
9.4. com.ocpsoft.pretty.faces.spi.DevelopmentModeDetector
10. Feedback & Contribution
11. Updating Notes
11.1. Updating to 3.x.y from earlier versions
12. FAQ