[JAVASERVERFACES_SPEC_PUBLIC-1066] JavaDoc for Application#getNavigationHandler() method does not mention the navigation-handler within the application element of faces-config Created: 26/Jan/12  Updated: 04/Sep/15  Resolved: 04/Sep/15

Status: Resolved
Project: javaserverfaces-spec-public
Component/s: Documentation: Javadoc, TLDDoc, RenderkitDoc, PDF
Affects Version/s: 2.0, 2.1, 2.0 Rev a, 2.1 Rev a, 2.2 Sprint 1, 2.2 Sprint 2, 2.2 Sprint 3, 2.2 Sprint 4, 2.2 Sprint 5, 2.2 Sprint 6, 2.2 Sprint 7, 2.2 Sprint 8, 2.2 Sprint 9
Fix Version/s: 2.3

Type: Bug Priority: Critical
Reporter: Neil Griffin Assignee: Neil Griffin
Resolution: Fixed Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Attachments: Text File changebundle.txt    
Issue Links:
is related to JAVASERVERFACES_SPEC_PUBLIC-1072 Add javax.faces.application.Navigatio... Closed


There is a documentation bug/omission in the JSF 2.0/2.1 JavaDoc. Specifically, the omission is that the Application#getNavigationHandler() method [1] is supposed to let you specify a wrappable implementation from the <navigation-handler> within the <application> element of faces-config. The feature is formally specified in the faces-config XML Schema [2]. I just checked and both Mojarra [3] and MyFaces [4] implement this feature.

Please refer to the Application#getResourceHandler() method [5] for an example of how to describe this feature in JavaDoc.

[1] http://javaserverfaces.java.net/nonav/docs/2.0/javadocs/javax/faces/application/Application.html#getNavigationHandler()
[2] http://java.sun.com/xml/ns/javaee/web-facesconfig_2_0.xsd
[3] com.sun.faces.config.processor.ApplicationConfigProcessor
[4] org.apache.myfaces.config.element.Application
[5] http://javaserverfaces.java.net/nonav/docs/2.0/javadocs/javax/faces/application/Application.html#getResourceHandler()

Comment by Ed Burns [ 01/Aug/14 ]

Set priority to baseline ahead of JSF 2.3 triage. Priorities will be assigned accurately after this exercise.

Comment by Neil Griffin [ 03/Sep/15 ]

I recommend that the following language be added to the JavaDoc for Application#getNavigationHandler(), which is based on the JavaDoc found in Application#getResourceHandler():

The NavigationHandler implementation is declared in the application configuration resources by giving the fully qualified class name as the value of the <navigation-handler> element within the <application> element.

The runtime must employ the decorator pattern as for every other pluggable artifact in JSF.

Comment by Manfred Riem [ 04/Sep/15 ]

Applied to 2.3 trunk,

svn commit -m "Fixes https://java.net/jira/browse/JAVASERVERFACES_SPEC_PUBLIC-1066, JavaDoc for Application#getNavigationHandler() method does not mention the navigation-handler within the application element of faces-config"
Sending jsf-api/src/main/java/javax/faces/application/Application.java
Transmitting file data .
Committed revision 15123.

Generated at Thu Feb 23 09:51:36 UTC 2017 using JIRA 6.2.3#6260-sha1:63ef1d6dac3f4f4d7db4c1effd405ba38ccdc558.