impl/src/main/java/org/apache/myfaces/spi/StateCacheProviderFactory.java

/*
 * 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.spi;

import java.security.AccessController;
import java.security.PrivilegedActionException;
import java.security.PrivilegedExceptionAction;
import javax.faces.FacesException;
import javax.faces.FacesWrapper;
import javax.faces.context.ExternalContext;
import org.apache.myfaces.spi.impl.DefaultStateCacheProviderFactory;
import org.apache.myfaces.spi.impl.SpiUtils;

/**
 *
 */
public abstract class StateCacheProviderFactory implements FacesWrapper<StateCacheProviderFactory>
{
    private static final String FACTORY_KEY = StateCacheProviderFactory.class.getName();
    
    public static StateCacheProviderFactory getStateCacheProviderFactory(ExternalContext ctx)
    {
        StateCacheProviderFactory instance
                = (StateCacheProviderFactory) ctx.getApplicationMap().get(FACTORY_KEY);
        if (instance != null)
        {
            return instance;
        }
        StateCacheProviderFactory lpf = null;
        try
        {

            if (System.getSecurityManager() != null)
            {
                final ExternalContext ectx = ctx;
                lpf = (StateCacheProviderFactory) AccessController.doPrivileged(
                        (PrivilegedExceptionAction) () -> SpiUtils.build(ectx,
                                StateCacheProviderFactory.class,
                                DefaultStateCacheProviderFactory.class));
            }
            else
            {
                lpf = (StateCacheProviderFactory)
                        SpiUtils.build(ctx, StateCacheProviderFactory.class,
                                DefaultStateCacheProviderFactory.class);
            }
        }
        catch (PrivilegedActionException pae)
        {
            throw new FacesException(pae);
        }
        if (lpf != null)
        {
            setStateCacheProviderFactory(ctx, lpf);
        }
        return lpf;
    }

    public static void setStateCacheProviderFactory(ExternalContext ctx,
                                                             StateCacheProviderFactory instance)
    {
        ctx.getApplicationMap().put(FACTORY_KEY, instance);
    }    
    
    public StateCacheProvider getStateCacheProvider(ExternalContext ctx)
    {
        return createStateCacheProvider(ctx);
    }
    
    public abstract StateCacheProvider createStateCacheProvider(ExternalContext externalContext);
    
    @Override
    public StateCacheProviderFactory getWrapped()
    {
        return null;
    }
    
}