com.sun.faces.application.view.ViewScopeContext Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of javax.faces Show documentation
Show all versions of javax.faces Show documentation
This is the master POM file for Oracle's Implementation of the JSF 2.2 Specification.
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2013 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package com.sun.faces.application.view;
import java.io.Serializable;
import java.lang.annotation.Annotation;
import java.util.logging.Level;
import java.util.logging.Logger;
import javax.enterprise.context.ContextNotActiveException;
import javax.enterprise.context.spi.Context;
import javax.enterprise.context.spi.Contextual;
import javax.enterprise.context.spi.CreationalContext;
import javax.faces.component.UIViewRoot;
import javax.faces.context.FacesContext;
import javax.faces.view.ViewScoped;
/**
* The CDI context for CDI ViewScoped beans.
*/
public class ViewScopeContext implements Context, Serializable {
/**
* Stores the logger.
*/
private static final Logger LOGGER = Logger.getLogger(ViewScopeContext.class.getName());
/**
* Stores the serial version UID.
*/
private static final long serialVersionUID = -6245899073989073951L;
/**
* Constructor.
*/
public ViewScopeContext() {
if (LOGGER.isLoggable(Level.FINEST)) {
LOGGER.log(Level.FINEST, "Creating ViewScope CDI context");
}
}
/**
* Assert the context is active, otherwise throw ContextNotActiveException.
*/
@SuppressWarnings({"FinalPrivateMethod"})
private final void assertNotReleased() {
if (!isActive()) {
if (LOGGER.isLoggable(Level.SEVERE)) {
LOGGER.log(Level.SEVERE, "Trying to access ViewScope CDI context while it is not active");
}
throw new ContextNotActiveException();
}
}
/**
* Get the ViewScoped bean for the given contextual.
*
* @param the type.
* @param contextual the contextual.
* @return the view scoped bean, or null if not found.
*/
@Override
public T get(Contextual contextual) {
assertNotReleased();
T result = null;
FacesContext facesContext = FacesContext.getCurrentInstance();
if (facesContext != null) {
ViewScopeManager manager = ViewScopeManager.getInstance(facesContext);
if (manager != null) {
result = manager.getContextManager().getBean(facesContext, contextual);
}
}
return result;
}
/**
* Get the existing instance of the ViewScoped bean for the given contextual
* or create a new one.
*
* @param the type.
* @param contextual the contextual.
* @param creational the creational.
* @return the instance.
* @throws ContextNotActiveException when the context is not active.
*/
@Override
public T get(Contextual contextual, CreationalContext creational) {
assertNotReleased();
T result = get(contextual);
if (result == null) {
FacesContext facesContext = FacesContext.getCurrentInstance();
if (facesContext != null) {
ViewScopeManager manager = ViewScopeManager.getInstance(facesContext);
result = (T) manager.getContextManager().getBean(facesContext, contextual);
if (result == null) {
result = (T) manager.getContextManager().createBean(facesContext, contextual, creational);
}
}
}
return result;
}
/**
* Get the class of the scope object.
*
* @return the class.
*/
@Override
public Class getScope() {
return ViewScoped.class;
}
/**
* Determine if the context is active.
*
* @return true if there is a view root, false otherwise.
*/
@Override
public boolean isActive() {
boolean result = false;
FacesContext facesContext = FacesContext.getCurrentInstance();
if (facesContext != null) {
UIViewRoot viewRoot = facesContext.getViewRoot();
if (viewRoot != null) {
result = true;
}
}
return result;
}
}