com.sun.faces.cdi.FlowMapProducer 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

EE4J Compatible Implementation for Jakarta Faces API

The newest version!

/*
 * Copyright (c) 1997, 2020 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.cdi;

import java.lang.reflect.Type;
import java.util.Map;

import jakarta.enterprise.inject.spi.BeanManager;
import jakarta.faces.annotation.FlowMap;
import jakarta.faces.application.Application;
import jakarta.faces.context.FacesContext;
import jakarta.faces.flow.FlowHandler;
import jakarta.faces.flow.FlowScoped;

/**
 * 
 * The Flow map producer is the CDI producer that allows injection of the flow map using @Inject.
 * 
 *
 * @since 2.3
 * @see Application#getFlowHandler()
 * @see FlowHandler#getCurrentFlowScope()
 */
public class FlowMapProducer extends CdiProducer> {

    /**
     * Serialization version
     */
    private static final long serialVersionUID = 1L;

    public FlowMapProducer(BeanManager beanManager) {
        super.name("flowScope")
            .scope(FlowScoped.class)
            .qualifiers(FlowMap.Literal.INSTANCE)
            .beanClass(beanManager, Map.class)
            .types(new ParameterizedTypeImpl(Map.class, new Type[] { Object.class, Object.class }), Map.class, Object.class)
            .create(e -> FacesContext.getCurrentInstance().getApplication().getFlowHandler().getCurrentFlowScope());
    }

}