javax.faces.webapp.FacesServlet Java Examples

/**
 * This bean registers the {@link FacesServlet}.
 * <p>
 * This {@link ServletRegistrationBean} also sets two
 * {@link ServletContext#setAttribute(String, Object) servlet-context attributes} to inform Mojarra and MyFaces about
 * the dynamically added Servlet.
 *
 * @param facesServletProperties The properties for the {@link FacesServlet}-registration.
 *
 * @return A custom {@link ServletRegistrationBean} which registers the {@link FacesServlet}.
 */
@Bean
public ServletRegistrationBean<FacesServlet> facesServletRegistrationBean(
		FacesServletProperties facesServletProperties
) {
	ServletRegistrationBean<FacesServlet> facesServletServletRegistrationBean = new ServletRegistrationBean<FacesServlet>(new FacesServlet()) {
		@Override
		protected ServletRegistration.Dynamic addRegistration(String description, ServletContext servletContext) {
			ServletRegistration.Dynamic servletRegistration = super.addRegistration(description, servletContext);
			if (servletRegistration != null) {
				servletContext.setAttribute("org.apache.myfaces.DYNAMICALLY_ADDED_FACES_SERVLET", true);
				servletContext.setAttribute("com.sun.faces.facesInitializerMappingsAdded", true);
			}
			return servletRegistration;
		}
	};

	facesServletServletRegistrationBean.setName(facesServletProperties.getName());
	facesServletServletRegistrationBean.setUrlMappings(facesServletProperties.getUrlMappings());
	facesServletServletRegistrationBean.setLoadOnStartup(facesServletProperties.getLoadOnStartup());
	facesServletServletRegistrationBean.setEnabled(facesServletProperties.isEnabled());
	facesServletServletRegistrationBean.setAsyncSupported(facesServletProperties.isAsyncSupported());
	facesServletServletRegistrationBean.setOrder(facesServletProperties.getOrder());

	return facesServletServletRegistrationBean;
}
 

public static WebArchive base(final String name) {
    final String webXml = Descriptors.create(WebAppDescriptor.class)
            .version("3.0")
            .createServlet()
                .servletName("jsf")
                .servletClass(FacesServlet.class.getName())
                .loadOnStartup(1)
            .up()
            .createServletMapping()
                .servletName("jsf")
                .urlPattern("*.xhtml") // not the default
            .up()
            .exportAsString();

    return ShrinkWrap.create(WebArchive.class, name)
            .setWebXML(new StringAsset(webXml));
}
 

@Deployment(testable = false)
public static WebArchive getArchive() {

    return ShrinkWrap.create(WebArchive.class, "jsf-jms-test.war")
            .addClasses(DummyManagedBean.class)
            .addAsWebResource(new ClassLoaderAsset(
                    JMSInjectionTest.class.getPackage().getName().replace('.', '/').concat("/").concat("dummy.xhtml")), "dummy.xhtml")
            .setWebXML(new StringAsset(Descriptors.create(WebAppDescriptor.class)
                    .version("3.0")
                    .createServlet()
                        .servletName("jsf")
                        .servletClass(FacesServlet.class.getName())
                        .loadOnStartup(1)
                    .up()
                    .createServletMapping()
                        .servletName("jsf")
                        .urlPattern("*.xhtml") // not the default
                    .up()
                    .exportAsString()));
}
 

@Test
public void testDefaultMapping() {
	this.webApplicationContextRunner
			.run(context -> {
				ServletRegistrationBean<FacesServlet> facesServletRegistrationBean = (ServletRegistrationBean<FacesServlet>) context.getBean("facesServletRegistrationBean");

				assertThat(facesServletRegistrationBean.getUrlMappings()).containsExactlyInAnyOrder("/faces/*", "*.jsf", "*.faces", "*.xhtml");
			});
}
 

@Test
public void testCustomMapping() {
	this.webApplicationContextRunner
			.withPropertyValues("joinfaces.faces-servlet.url-mappings=foo,bar")
			.run(context -> {
				ServletRegistrationBean<FacesServlet> facesServletRegistrationBean = (ServletRegistrationBean<FacesServlet>) context.getBean("facesServletRegistrationBean");

				assertThat(facesServletRegistrationBean.getUrlMappings()).containsExactlyInAnyOrder("foo", "bar");
			});
}
 

@Test
public void testDisableFacesservletToXhtmlDefaultMapping_false() {
	this.webApplicationContextRunner
			.withPropertyValues("joinfaces.jsf.disable-facesservlet-to-xhtml=false")
			.run(context -> {
				ServletRegistrationBean<FacesServlet> facesServletRegistrationBean = (ServletRegistrationBean<FacesServlet>) context.getBean("facesServletRegistrationBean");

				assertThat(facesServletRegistrationBean.getUrlMappings()).containsExactlyInAnyOrder("/faces/*", "*.jsf", "*.faces", "*.xhtml");
			});
}
 

@Test
public void testDisableFacesservletToXhtmlDefaultMapping_true() {
	this.webApplicationContextRunner
			.withPropertyValues("joinfaces.jsf.disable-facesservlet-to-xhtml=true")
			.run(context -> {
				ServletRegistrationBean<FacesServlet> facesServletRegistrationBean = (ServletRegistrationBean<FacesServlet>) context.getBean("facesServletRegistrationBean");

				assertThat(facesServletRegistrationBean.getUrlMappings()).containsExactlyInAnyOrder("/faces/*", "*.jsf", "*.faces");
			});
}
 

@Test
public void testDisableFacesservletToXhtmlCustomMapping() {
	this.webApplicationContextRunner
			.withPropertyValues("joinfaces.jsf.disable-facesservlet-to-xhtml=true", "joinfaces.faces-servlet.url-mappings=*.xhtml")
			.run(context -> {
				ServletRegistrationBean<FacesServlet> facesServletRegistrationBean = (ServletRegistrationBean<FacesServlet>) context.getBean("facesServletRegistrationBean");

				assertThat(facesServletRegistrationBean.getUrlMappings()).containsExactly("*.xhtml");
			});
}
 

@Test
public void testServletContextAttributes_added() {
	this.webApplicationContextRunner
			.run(context -> {
				ServletRegistrationBean<FacesServlet> facesServletRegistrationBean = (ServletRegistrationBean<FacesServlet>) context.getBean("facesServletRegistrationBean");

				ServletContext servletContext = mock(ServletContext.class);

				when(servletContext.addServlet(anyString(), any(Servlet.class))).thenReturn(mock(ServletRegistration.Dynamic.class));

				facesServletRegistrationBean.onStartup(servletContext);

				verify(servletContext, times(2)).setAttribute(any(), any());
			});
}
 

@Test
public void testServletContextAttributes_notAdded() {
	this.webApplicationContextRunner
			.run(context -> {
				ServletRegistrationBean<FacesServlet> facesServletRegistrationBean = (ServletRegistrationBean<FacesServlet>) context.getBean("facesServletRegistrationBean");

				ServletContext servletContext = mock(ServletContext.class);

				when(servletContext.addServlet(anyString(), any(Servlet.class))).thenReturn(null);

				facesServletRegistrationBean.onStartup(servletContext);

				verify(servletContext, times(0)).setAttribute(any(), any());
			});
}
 

private boolean isFacesConfigPresent(final ServletContext servletContext) {
    try {
        if (servletContext.getResource("/WEB-INF/faces-config.xml") != null) {
            return true;
        }

        final String configFilesAttrValue = servletContext.getInitParameter(FacesServlet.CONFIG_FILES_ATTR);
        if (configFilesAttrValue != null) {
            final String[] configFiles = configFilesAttrValue.split(",");
            for (final String file : configFiles) {
                if (servletContext.getResource(file.trim()) != null) {
                    return true;
                }
            }
        }

        final Collection<URL> metaInfFacesConfigUrls =  new TomEEFacesConfigResourceProvider().getMetaInfConfigurationResources(null);
        if (metaInfFacesConfigUrls == null) {
            return false;
        }

        // remove our internal faces-config.xml
        final Iterator<URL> it = metaInfFacesConfigUrls.iterator();
        while (it.hasNext()) {
            final URL next = it.next();
            if (isOwb(next)) {
                it.remove();
            }
        }

        return !metaInfFacesConfigUrls.isEmpty();
    } catch (final Exception e) {
        return false;
    }
}
 

@Bean
public ServletRegistrationBean servletRegistrationBean() {
    FacesServlet servlet = new FacesServlet();
    return new ServletRegistrationBean(servlet, "*.xhtml");
}
 

public FenixFacesServlet() {
    super();
    facesServlet = new FacesServlet();

}