[OmniFaces utilities (2.0)] Get the HTTP request path info

---

[OmniFaces utilities] The getRequestPathInfo() method returns the HTTP request path info. If JSF is prefix mapped (e.g. /faces/*), then this returns the whole part after the prefix mapping, with a leading slash. If JSF is suffix mapped (e.g. *.xhtml), then this returns null.

---

Method:

See also: Faces#getContext()

Usage:

Prefix mapped:

<?xml version="1.0" encoding="UTF-8"?>

<web-app version="3.1" xmlns="http://xmlns.jcp.org/xml/ns/javaee" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_3_1.xsd">

 <context-param>

  <param-name>javax.faces.PROJECT_STAGE</param-name>

  <param-value>Development</param-value>

 </context-param>

<servlet>

  <servlet-name>Faces Servlet</servlet-name>

  <servlet-class>javax.faces.webapp.FacesServlet</servlet-class>

  <load-on-startup>1</load-on-startup>

 </servlet>

 <servlet-mapping>

  <servlet-name>Faces Servlet</servlet-name>

  <url-pattern>/faces/*</url-pattern>

 </servlet-mapping>

 <session-config>

  <session-timeout>

   30

  </session-timeout>

 </session-config>

 <welcome-file-list>

  <welcome-file>faces/index.xhtml</welcome-file>

 </welcome-file-list>

</web-app>

import org.omnifaces.util.Faces;

...

// requestPathInfo may be /index.xhtml

String requestPathInfo = Faces.getRequestPathInfo();

Suffix mapped:

<?xml version="1.0" encoding="UTF-8"?>

<web-app version="3.1" xmlns="http://xmlns.jcp.org/xml/ns/javaee" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_3_1.xsd">

 <context-param>

  <param-name>javax.faces.PROJECT_STAGE</param-name>

  <param-value>Development</param-value>

 </context-param>

<servlet>

  <servlet-name>Faces Servlet</servlet-name>

  <servlet-class>javax.faces.webapp.FacesServlet</servlet-class>

  <load-on-startup>1</load-on-startup>

 </servlet>

 <servlet-mapping>

  <servlet-name>Faces Servlet</servlet-name>

  <url-pattern>*.xhtml</url-pattern>

 </servlet-mapping>

 <session-config>

  <session-timeout>

   30

  </session-timeout>

 </session-config>

 <welcome-file-list>

  <welcome-file>index.xhtml</welcome-file>

 </welcome-file-list>

</web-app>

import org.omnifaces.util.Faces;

...

// requestPathInfo will be null

String requestPathInfo = Faces.getRequestPathInfo();

API GH