com.sun.faces.application.view.ViewScopeExtension Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jakarta.faces Show documentation
Show all versions of jakarta.faces Show documentation
EE4J Compatible Implementation for Jakarta Faces API
/*
* Copyright (c) 1997, 2018 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0, which is available at
* http://www.eclipse.org/legal/epl-2.0.
*
* This Source Code may also be made available under the following Secondary
* Licenses when the conditions for such availability set forth in the
* Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
* version 2 with the GNU Classpath Exception, which is available at
* https://www.gnu.org/software/classpath/license.html.
*
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
*/
package com.sun.faces.application.view;
import com.sun.faces.util.FacesLogger;
import com.sun.faces.util.Util;
import com.sun.faces.util.cdi11.CDIUtil;
import java.util.ServiceLoader;
import java.util.logging.Level;
import java.util.logging.Logger;
import javax.enterprise.event.Observes;
import javax.enterprise.inject.spi.AfterBeanDiscovery;
import javax.enterprise.inject.spi.Bean;
import javax.enterprise.inject.spi.BeanManager;
import javax.enterprise.inject.spi.BeforeBeanDiscovery;
import javax.enterprise.inject.spi.Extension;
import javax.enterprise.inject.spi.ProcessBean;
import javax.faces.view.ViewScoped;
/**
* The CDI extension that makes ViewScoped beans work in a CDI context.
*/
public class ViewScopeExtension implements Extension {
private boolean isCdiOneOneOrGreater = false;
private CDIUtil cdiUtil = null;
/**
* Stores the logger.
*/
private static final Logger LOGGER = FacesLogger.APPLICATION_VIEW.getLogger();
/**
* Constructor.
*/
public ViewScopeExtension() {
if (LOGGER.isLoggable(Level.FINEST)) {
LOGGER.finest("Constructor @ViewScoped CDI Extension called");
}
isCdiOneOneOrGreater = Util.isCdiOneOneOrLater(null);
}
/**
* Processing bean.
*
* @param event the event.
*/
public void processBean(@Observes ProcessBean event) {
ViewScoped viewScoped = event.getAnnotated().getAnnotation(ViewScoped.class);
if (viewScoped != null && LOGGER.isLoggable(Level.FINEST)) {
LOGGER.finest("Processing occurrence of @ViewScoped");
}
}
public void beforeBeanDiscovery(@Observes final BeforeBeanDiscovery event, BeanManager beanManager) {
event.addScope(ViewScoped.class, true, true);
}
/**
* After bean discovery.
*
* @param event the event.
*/
public void afterBeanDiscovery(@Observes final AfterBeanDiscovery event, BeanManager beanManager) {
if (LOGGER.isLoggable(Level.FINEST)) {
LOGGER.finest("Adding @ViewScoped context to CDI runtime");
}
event.addContext(new ViewScopeContext());
if (isCdiOneOneOrGreater) {
Class clazz = null;
try {
clazz = Class.forName("com.sun.faces.application.view.ViewScopedCDIEventFireHelperImpl");
} catch (ClassNotFoundException ex) {
if (LOGGER.isLoggable(Level.SEVERE)) {
LOGGER.log(Level.SEVERE, "CDI 1.1 events not enabled", ex);
}
return;
}
if (null == cdiUtil) {
ServiceLoader oneCdiUtil = ServiceLoader.load(CDIUtil.class);
for (CDIUtil oneAndOnly : oneCdiUtil) {
if (null != cdiUtil) {
String message = "Must only have one implementation of CDIUtil available";
if (LOGGER.isLoggable(Level.SEVERE)) {
LOGGER.log(Level.SEVERE, message);
}
throw new IllegalStateException(message);
}
cdiUtil = oneAndOnly;
}
}
if (null != cdiUtil) {
Bean bean = cdiUtil.createHelperBean(beanManager, clazz);
event.addBean(bean);
} else if (LOGGER.isLoggable(Level.SEVERE)) {
LOGGER.log(Level.SEVERE, "Unable to obtain CDI 1.1 utilities for Mojarra");
}
}
}
}