JavaDoc for Application#getNavigationHandler() method does not mention the navigation-handler within the application element of faces-config

[eclipse-faces-bot]

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 within the 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(

Affected Versions

[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]

[eclipse-faces-bot]

@glassfishrobot Commented
Reported by ngriffin7a

[eclipse-faces-bot]

@glassfishrobot Commented
Issue-Links:
is related to
JAVASERVERFACES_SPEC_PUBLIC-1072

[eclipse-faces-bot]

@glassfishrobot Commented
Was assigned to ngriffin7a

[eclipse-faces-bot]

@glassfishrobot Commented
@edburns said:
Set priority to baseline ahead of JSF 2.3 triage. Priorities will be assigned accurately after this exercise.

[eclipse-faces-bot]

@glassfishrobot Commented
ngriffin7a said:
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 element within the element.

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

[eclipse-faces-bot]

@glassfishrobot Commented
File: changebundle.txt
Attached By: @manfredriem

[eclipse-faces-bot]

@glassfishrobot Commented
@manfredriem said:
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.

[eclipse-faces-bot]

@glassfishrobot Commented
Marked as fixed on Friday, September 4th 2015, 7:03:24 am

[eclipse-faces-bot]

@glassfishrobot Commented
This issue was imported from java.net JIRA JAVASERVERFACES_SPEC_PUBLIC-1066

[eclipse-faces-bot]

• Issue Imported From: JavaDoc for Application#getNavigationHandler() method does not mention the navigation-handler within the application element of faces-config javaee/javaserverfaces-spec#1066
• Original Issue Raised By:@glassfishrobot
• Original Issue Assigned To: @glassfishrobot
• Original Issue Closed By:@glassfishrobot