org.apache.myfaces.cdi.util.CDIUtils Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of myfaces-impl Show documentation
The private implementation classes of the Apache MyFaces Core JSF-2.3-next Implementation
There is a newer version: 4.1.0-RC2
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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.apache.myfaces.cdi.util;

import java.lang.annotation.Annotation;
import java.lang.reflect.Type;
import java.util.Collections;
import java.util.Set;
import javax.enterprise.context.ContextNotActiveException;
import javax.enterprise.context.SessionScoped;
import javax.enterprise.context.spi.Context;

import javax.enterprise.context.spi.CreationalContext;
import javax.enterprise.inject.spi.Bean;
import javax.enterprise.inject.spi.BeanManager;
import javax.faces.context.ExternalContext;
import javax.faces.view.ViewScoped;
import org.apache.myfaces.webapp.AbstractFacesInitializer;

/**
 * Lookup code for Contextual Instances.
 */
public class CDIUtils
{
    public static BeanManager getBeanManager(ExternalContext externalContext)
    {
        return (BeanManager) externalContext.getApplicationMap().get(
            AbstractFacesInitializer.CDI_BEAN_MANAGER_INSTANCE);
    }

    public static  T get(BeanManager bm, Class clazz)
    {
        Set> beans = bm.getBeans(clazz);
        return resolveInstance(bm, beans, clazz);
    }

    public static  T getOptional(BeanManager bm, Class clazz)
    {
        Set> beans = bm.getBeans(clazz);
        if (beans == null || beans.isEmpty())
        {
            return null;
        }
        return resolveInstance(bm, beans, clazz);
    }
    
    private static  T resolveInstance(BeanManager bm, Set> beans, Type type)
    {
        Bean bean = bm.resolve(beans);
        CreationalContext cc = bm.createCreationalContext(bean);
        T instance = (T) bm.getReference(bean, type, cc);
        return instance;

    }
    
    @SuppressWarnings("unchecked")
    public static  Bean get(BeanManager beanManager, Class beanClass, Annotation... qualifiers)
    {
        Set> beans = beanManager.getBeans(beanClass, qualifiers);

        for (Bean bean : beans)
        {
            if (bean.getBeanClass() == beanClass)
            {
                return (Bean) beanManager.resolve(Collections.>singleton(bean));
            }
        }

        return (Bean) beanManager.resolve(beans);
    }

    public static  T get(BeanManager beanManager, Class beanClass, 
            boolean create, Annotation... qualifiers)
    {
        try
        {
            Bean bean = get(beanManager, beanClass, qualifiers);
            return (bean != null) ? get(beanManager, bean, beanClass, create) : null;
        }
        catch (ContextNotActiveException e)
        {
            return null;
        }
    }

    public static  T get(BeanManager beanManager, Type type, boolean create, Annotation... qualifiers)
    {
        try
        {
            Set> beans = beanManager.getBeans(type, qualifiers);
            Bean bean = (Bean) beanManager.resolve(beans);

            return (bean != null) ? get(beanManager, bean, type, create) : null;
        }
        catch (ContextNotActiveException e)
        {
            return null;
        }
    }

    public static  T get(BeanManager beanManager, Bean bean, Type type, boolean create)
    {
        if (create)
        {
            CreationalContext creationalContext = beanManager.createCreationalContext(bean);
            return (T) beanManager.getReference(bean, type, creationalContext);
        }
        else
        {
            Context context = beanManager.getContext(bean.getScope());
            return context.get(bean);
        }
    }
    
    public static boolean isSessionScopeActive(BeanManager beanManager)
    {
        try 
        {
            Context ctx = beanManager.getContext(SessionScoped.class);
            return ctx != null;
        }
        catch (ContextNotActiveException ex)
        {
            //No op
        }
        catch (Exception ex)
        {
            // Sometimes on startup time, since there is no active request context, trying to grab session scope
            // throws NullPointerException.
            //No op
        }
        return false;
    }
    
    public static boolean isViewScopeActive(BeanManager beanManager)
    {
        try 
        {
            Context ctx = beanManager.getContext(ViewScoped.class);
            return ctx != null;
        }
        catch (ContextNotActiveException ex)
        {
            //No op
        }
        catch (Exception ex)
        {
            // Sometimes on startup time, since there is no active request context, trying to grab session scope
            // throws NullPointerException.
            //No op
        }
        return false;
    }
        
}