org.primefaces.context.ApplicationContext Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of primefaces Show documentation

PrimeFaces is one of the most popular UI libraries in Java EE Ecosystem and widely used by software companies, world renowned brands, banks, financial institutions, insurance companies, universities and more.

There is a newer version: 14.0.0-RC3

Show newest version

/**
 * Copyright 2009-2018 PrimeTek.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.primefaces.context;

import java.util.Map;
import javax.faces.context.FacesContext;
import javax.servlet.ServletContext;
import javax.validation.Validator;
import javax.validation.ValidatorFactory;
import org.primefaces.cache.CacheProvider;

import org.primefaces.config.PrimeConfiguration;

/**
 * A {@link ApplicationContext} is a contextual store, similar to {@link RequestContext}. Only one {@link ApplicationContext} should be available in
 * the application.
 *
 * It can be accessed via:
 * 
 * RequestContext.getCurrentInstance(context).getApplicationContext();
 * 
 */
public abstract class ApplicationContext {

    public static final String INSTANCE_KEY = ApplicationContext.class.getName();

    public static ApplicationContext getCurrentInstance(FacesContext facesContext) {
        if (facesContext == null || facesContext.getExternalContext() == null) {
            return null;
        }

        return (ApplicationContext) facesContext.getExternalContext().getApplicationMap().get(INSTANCE_KEY);
    }
    
    public static ApplicationContext getCurrentInstance(ServletContext context) {
        return (ApplicationContext) context.getAttribute(INSTANCE_KEY);
    }

    public static void setCurrentInstance(final ApplicationContext context, final FacesContext facesContext) {
        facesContext.getExternalContext().getApplicationMap().put(INSTANCE_KEY, context);
        
        if (facesContext.getExternalContext().getContext() instanceof ServletContext) {
            ((ServletContext) facesContext.getExternalContext().getContext()).setAttribute(INSTANCE_KEY, context);
        }
    }

    public abstract PrimeConfiguration getConfig();

    public abstract ValidatorFactory getValidatorFactory();

    public abstract CacheProvider getCacheProvider();

    public abstract Map, Map> getEnumCacheMap();

    public abstract Map, Map> getConstantsCacheMap();

    public abstract Validator getValidator();

    public abstract void release();
}