All Downloads are FREE. Search and download functionalities are using the official Maven repository.

jakarta.faces.FactoryFinderInstance Maven / Gradle / Ivy

Go to download

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 jakarta.faces;

import static com.sun.faces.util.Util.generateCreatedBy;
import static com.sun.faces.util.Util.getContextClassLoader2;
import static com.sun.faces.util.Util.isAnyNull;
import static com.sun.faces.util.Util.isOneOf;
import static jakarta.faces.FactoryFinder.APPLICATION_FACTORY;
import static jakarta.faces.FactoryFinder.CLIENT_WINDOW_FACTORY;
import static jakarta.faces.FactoryFinder.EXCEPTION_HANDLER_FACTORY;
import static jakarta.faces.FactoryFinder.EXTERNAL_CONTEXT_FACTORY;
import static jakarta.faces.FactoryFinder.FACELET_CACHE_FACTORY;
import static jakarta.faces.FactoryFinder.FACES_CONTEXT_FACTORY;
import static jakarta.faces.FactoryFinder.FACTORIES_CACHE;
import static jakarta.faces.FactoryFinder.FLASH_FACTORY;
import static jakarta.faces.FactoryFinder.FLOW_HANDLER_FACTORY;
import static jakarta.faces.FactoryFinder.LIFECYCLE_FACTORY;
import static jakarta.faces.FactoryFinder.PARTIAL_VIEW_CONTEXT_FACTORY;
import static jakarta.faces.FactoryFinder.RENDER_KIT_FACTORY;
import static jakarta.faces.FactoryFinder.SEARCH_EXPRESSION_CONTEXT_FACTORY;
import static jakarta.faces.FactoryFinder.TAG_HANDLER_DELEGATE_FACTORY;
import static jakarta.faces.FactoryFinder.VIEW_DECLARATION_LANGUAGE_FACTORY;
import static jakarta.faces.FactoryFinder.VISIT_CONTEXT_FACTORY;
import static jakarta.faces.ServletContextFacesContextFactory.SERVLET_CONTEXT_FINDER_NAME;
import static jakarta.faces.ServletContextFacesContextFactory.SERVLET_CONTEXT_FINDER_REMOVAL_NAME;
import static java.nio.charset.StandardCharsets.UTF_8;
import static java.text.MessageFormat.format;
import static java.util.Collections.binarySearch;
import static java.util.Map.entry;
import static java.util.logging.Level.SEVERE;

import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.UnsupportedEncodingException;
import java.lang.reflect.InvocationTargetException;
import java.net.URL;
import java.net.URLConnection;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Enumeration;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.locks.ReentrantReadWriteLock;
import java.util.logging.Logger;
import java.util.stream.Collectors;

import com.sun.faces.config.ConfigManager;
import com.sun.faces.spi.InjectionProvider;

import jakarta.faces.context.FacesContext;

final class FactoryFinderInstance {

    private static final Logger LOGGER = Logger.getLogger("jakarta.faces", "jakarta.faces.LogStrings");

    private static final String INJECTION_PROVIDER_KEY = FactoryFinder.class.getPackage().getName() + "INJECTION_PROVIDER_KEY";

    private final Map factories = new ConcurrentHashMap<>();
    private final Map> savedFactoryNames = new ConcurrentHashMap<>();
    private final ReentrantReadWriteLock lock = new ReentrantReadWriteLock(true);
    private final String createdBy;

    private ServletContextFacesContextFactory servletContextFinder = new ServletContextFacesContextFactory();

    /**
     * 

     * The set of Jakarta Faces factory classes for which the factory discovery mechanism is supported. The entries
     * in this list must be alphabetically ordered according to the entire string of the *value* of each of the literals,
     * not just the last part of the literal!
     * 

     */
    private static final List factoryNames = asSortedList(APPLICATION_FACTORY, VISIT_CONTEXT_FACTORY, EXCEPTION_HANDLER_FACTORY, EXTERNAL_CONTEXT_FACTORY,
            FACES_CONTEXT_FACTORY, FLASH_FACTORY, FLOW_HANDLER_FACTORY, PARTIAL_VIEW_CONTEXT_FACTORY, CLIENT_WINDOW_FACTORY, LIFECYCLE_FACTORY,
            RENDER_KIT_FACTORY, VIEW_DECLARATION_LANGUAGE_FACTORY, FACELET_CACHE_FACTORY, TAG_HANDLER_DELEGATE_FACTORY, SEARCH_EXPRESSION_CONTEXT_FACTORY);

    /**
     * 

     * Map of Class instances for our factory names.
     * 

     */
    private static final Map> factoryClasses = buildFactoryClassesMap();

    // -------------------------------------------------------- Constructors

    FactoryFinderInstance(FacesContext facesContext) {
        for (String name : factoryNames) {
            factories.put(name, new ArrayList<>(4)); // NOPMD
        }
        copyInjectionProviderFromFacesContext(facesContext);
        createdBy = generateCreatedBy(facesContext);
    }

    FactoryFinderInstance(FacesContext facesContext, FactoryFinderInstance toCopy) {
        factories.putAll(toCopy.savedFactoryNames);
        copyInjectionProviderFromFacesContext(facesContext);
        createdBy = generateCreatedBy(facesContext);
    }

    @Override
    public String toString() {
        return super.toString() + " created by" + createdBy;
    }

    // ------------------------------------------------------ Package Private Methods

    void addFactory(String factoryName, String implementationClassName) {
        validateFactoryName(factoryName);

        Object result = factories.get(factoryName);
        lock.writeLock().lock();
        try {
            if (result instanceof List) {
                TypedCollections.dynamicallyCastList((List) result, String.class).add(0, implementationClassName);
            }
        } finally {
            lock.writeLock().unlock();
        }
    }

    @SuppressWarnings("unchecked")
    Object getFactory(String factoryName) {
        validateFactoryName(factoryName);

        if (factoryName.equals(SERVLET_CONTEXT_FINDER_NAME)) {
            return servletContextFinder;
        }

        if (factoryName.equals(SERVLET_CONTEXT_FINDER_REMOVAL_NAME)) {
            try {
                lock.writeLock().lock();
                servletContextFinder = null;
                return null;
            } finally {
                lock.writeLock().unlock();
            }
        }

        Object factoryOrList;
        lock.readLock().lock();
        try {
            factoryOrList = factories.get(factoryName);
            if (!(factoryOrList instanceof List)) {
                return factoryOrList;
            }
        } finally {
            lock.readLock().unlock();
        }

        // Factory hasn't been constructed
        lock.writeLock().lock();
        try {

            // Double check the current value. Another thread
            // may have completed the initialization by the time
            // this thread entered this block
            factoryOrList = factories.get(factoryName);
            if (!(factoryOrList instanceof List)) {
                return factoryOrList;
            }

            savedFactoryNames.put(factoryName, new ArrayList<>((List) factoryOrList));

            Object factory = getImplementationInstance(getContextClassLoader2(), factoryName, (List) factoryOrList);

            if (factory == null) {
                logNoFactory(factoryName);

                factory = FACTORIES_CACHE.getFallbackFactory(this, factoryName);

                notNullFactory(factoryName, factory);
            }

            // Record and return the new instance
            factories.put(factoryName, factory);

            return factory;
        } finally {
            lock.writeLock().unlock();
        }
    }

    InjectionProvider getInjectionProvider() {
        return (InjectionProvider) factories.get(INJECTION_PROVIDER_KEY);
    }

    void clearInjectionProvider() {
        factories.remove(INJECTION_PROVIDER_KEY);
    }

    void releaseFactories() {
        InjectionProvider provider = getInjectionProvider();

        if (provider != null) {
            lock.writeLock().lock();
            try {
                for (Entry entry : factories.entrySet()) {
                    Object curFactory = entry.getValue();

                    // If the current entry is not the injectionProvider itself
                    // and the current entry has a non-null value
                    // and the value is not a string...
                    if (!INJECTION_PROVIDER_KEY.equals(entry.getKey()) && curFactory != null && !(curFactory instanceof String)) {
                        try {
                            provider.invokePreDestroy(curFactory);
                        } catch (Exception ex) {
                            logPreDestroyFail(entry.getValue(), ex);
                        }
                    }
                }
            } finally {
                factories.clear();
                lock.writeLock().unlock();
            }

        } else {
            LOGGER.log(SEVERE,
                    "Unable to call @PreDestroy annotated methods because no InjectionProvider can be found. Does this container implement the Mojarra Injection SPI?");
        }
    }

    Collection getFactories() {
        return factories.values();
    }

    // -------------------------------------------------------- Private methods

    private void copyInjectionProviderFromFacesContext(FacesContext facesContext) {
        InjectionProvider injectionProvider = null;
        if (facesContext != null) {
            injectionProvider = (InjectionProvider) facesContext.getAttributes().get(ConfigManager.INJECTION_PROVIDER_KEY);
        }

        if (injectionProvider != null) {
            factories.put(INJECTION_PROVIDER_KEY, injectionProvider);
        } else {
            LOGGER.log(SEVERE, "Unable to obtain InjectionProvider from init time FacesContext. Does this container implement the Mojarra Injection SPI?");
        }
    }

    /**
     * 

     * Load and return an instance of the specified implementation class using the following algorithm.
     * 

     * 
     * 
    
     * 
     * 
  1. 
     * 
    
     * If the argument implementations list has more than one element, or exactly one element, interpret the
     * last element in the list to be the fully qualified class name of a class implementing factoryName.
     * Instantiate that class and save it for return. If the implementations list has only one element, skip
     * this step.
     * 
    
     * 
    2. 
     * 
     * 
  2. 
     * 
    
     * Look for a resource called /META-INF/services/<factoryName>. If found, interpret it as a
     * properties file, and read out the first entry. Interpret the first entry as a fully qualify class name of a class
     * that implements factoryName. If we have an instantiated factory from the previous step and the
     * implementing class has a one arg constructor of the type for factoryName, instantiate it, passing the
     * instantiated factory from the previous step. If there is no one arg constructor, just instantiate the zero arg
     * constructor. Save the newly instantiated factory for return, replacing the instantiated factory from the previous
     * step.
     * 
    
     * 
    3. 
     * 
     * 
  3. 
     * 
    
     * Treat each remaining element in the implementations list as a fully qualified class name of a class
     * implementing factoryName. If the currentKeyrent element has a one arg constructor of the type for
     * factoryName, instantiate it, passing the instantiated factory from the previous or step iteration. If
     * there is no one arg constructor, just instantiate the zero arg constructor, replacing the instantiated factory from
     * the previous step or iteration.
     * 
    
     * 
    4. 
     * 
     * 
  4. 
     * 
    
     * Return the saved factory
     * 
    
     * 
    5. 
     * 
     * 

     *
     * @param classLoader Class loader for the web application that will be loading the implementation class
     * @param implementations A List of implementations for a given factory class.
     * @throws FacesException if the specified implementation class cannot be loaded
     * @throws FacesException if an instance of the specified implementation class cannot be instantiated
     */
    private Object getImplementationInstance(ClassLoader classLoader, String factoryName, List implementations) throws FacesException {

        Object implementation = null;
        String curImplClass;
        int len;

        // step 1.
        if (implementations != null && (1 < (len = implementations.size()) || 1 == len)) {
            curImplClass = implementations.remove(len - 1);
            // since this is the hard coded implementation default,
            // there is no preceding implementation, so don't bother
            // with a non-zero-argument ctor.
            implementation = getImplGivenPreviousImpl(classLoader, factoryName, curImplClass, null);
        }

        // step 2.
        List fromServices = getImplNameFromServices(classLoader, factoryName);
        if (fromServices != null) {
            for (String name : fromServices) {
                implementation = getImplGivenPreviousImpl(classLoader, factoryName, name, implementation);
            }
        }

        // step 3.
        if (implementations != null) {
            for (len = implementations.size() - 1; 0 <= len; len--) {
                curImplClass = implementations.remove(len);
                implementation = getImplGivenPreviousImpl(classLoader, factoryName, curImplClass, implementation);
            }
        }

        return implementation;
    }

    /**
     * 

     * Perform the logic to get the implementation class for the second step of
     * {@link FactoryFinder#getImplementationInstance(ClassLoader, String, java.util.List)}.
     * 

     */
    private List getImplNameFromServices(ClassLoader classLoader, String factoryName) {

        // Check for a services definition
        List implementationNames = new ArrayList<>();
        String resourceName = "META-INF/services/" + factoryName;

        try {
            Enumeration resources = classLoader.getResources(resourceName);
            while (resources.hasMoreElements()) {
                URL url = resources.nextElement();
                URLConnection connection = url.openConnection();
                connection.setUseCaches(false);

                try (InputStream stream = connection.getInputStream()) {
                    if (stream != null) {
                        implementationNames.add(readLineFromStream(stream));
                    }
                }
            }
        } catch (IOException | SecurityException e) {
            if (LOGGER.isLoggable(SEVERE)) {
                LOGGER.log(SEVERE, e.toString(), e);
            }
        }

        return implementationNames;
    }

    /**
     * 

     * Implement the decorator pattern for the factory implementation.
     * 

     * 
     * 

     * If previousImpl is non-null and the class named by the argument implName has a
     * one arg contstructor of type factoryName, instantiate it, passing previousImpl to the constructor.
     * 

     * 
     * 

     * Otherwise, we just instantiate and return implName.
     * 

     *
     * @param classLoader the ClassLoader from which to load the class
     * @param factoryName the fully qualified class name of the factory.
     * @param factoryImplClassName the fully qualified class name of a class that implements the factory.
     * @param previousFactoryImplementation if non-null, the factory instance to be passed to the constructor
     * of the new factory.
     */
    private Object getImplGivenPreviousImpl(ClassLoader classLoader, String factoryName, String factoryImplClassName, Object previousFactoryImplementation) {

        Object factoryImplementation = null;

        Class factoryClass = getFactoryClass(factoryName);

        if (!isAnyNull(previousFactoryImplementation, factoryClass)) {

            // We have a previous factory implementation AND the appropriate one argument ctor.

            try {
                factoryImplementation = Class.forName(factoryImplClassName, false, classLoader).getConstructor(factoryClass)
                        .newInstance(previousFactoryImplementation);

            } catch (NoSuchMethodException nsme) {
                // fall through to "zero-arg-ctor" case
                factoryClass = null;
            } catch (ClassNotFoundException | SecurityException | InstantiationException | IllegalAccessException | IllegalArgumentException
                    | InvocationTargetException e) {
                throw new FacesException(factoryImplClassName, e);
            }
        }

        if (isAnyNull(previousFactoryImplementation, factoryClass)) {

            // We have either no previous factory implementation or no appropriate one argument ctor.

            try {

                // Since this is the hard coded implementation default, there is no preceding implementation,
                // so don't bother with a non-zero-argument ctor.

                factoryImplementation = Class.forName(factoryImplClassName, false, classLoader).getDeclaredConstructor()
                        .newInstance();

            } catch (IllegalArgumentException | ReflectiveOperationException | SecurityException e) {
                throw new FacesException(factoryImplClassName, e);
            }
        }

        injectImplementation(factoryImplClassName, factoryImplementation);

        return factoryImplementation;
    }

    /**
     * @return the java.lang.Class for the argument factory.
     */
    private Class getFactoryClass(String factoryClassName) {
        return factoryClasses.get(factoryClassName);
    }

    private String readLineFromStream(InputStream stream) throws IOException {
        // Deal with systems whose native encoding is possibly
        // different from the way that the services entry was created
        try (BufferedReader reader = new BufferedReader(new InputStreamReader(stream, UTF_8))) {
            return reader.readLine();
        } catch (UnsupportedEncodingException uee) {
            // The DM_DEFAULT_ENCODING warning is acceptable here
            // because we explicitly *want* to use the Java runtime's
            // default encoding.
            try (BufferedReader reader = new BufferedReader(new InputStreamReader(stream))) {
                return reader.readLine();
            }
        }
    }

    private void injectImplementation(String implementationName, Object implementation) {
        if (implementation != null) {
            InjectionProvider provider = getInjectionProvider();
            if (provider != null) {
                try {
                    provider.inject(implementation);
                    provider.invokePostConstruct(implementation);
                } catch (Exception e) {
                    throw new FacesException(implementationName, e);
                }
            } else {
                LOGGER.log(SEVERE, "Unable to inject {0} because no InjectionProvider can be found. Does this container implement the Mojarra Injection SPI?",
                        implementation);
            }
        }
    }

    private void logNoFactory(String factoryName) {
        if (LOGGER.isLoggable(SEVERE)) {
            LOGGER.log(SEVERE, format(LOGGER.getResourceBundle().getString("severe.no_factory"), factoryName));
        }
    }

    private void logPreDestroyFail(Object factory, Exception ex) {
        if (LOGGER.isLoggable(SEVERE)) {
            LOGGER.log(SEVERE, format("Unable to invoke @PreDestroy annotated methods on {0}.", factory), ex);
        }
    }

    private void notNullFactory(String factoryName, Object factory) {
        if (factory == null) {
            throw new IllegalStateException(format(LOGGER.getResourceBundle().getString("severe.no_factory_backup_failed"), factoryName));
        }
    }

    private void validateFactoryName(String factoryName) {

        if (factoryName == null) {
            throw new NullPointerException();
        }

        if (isOneOf(factoryName, SERVLET_CONTEXT_FINDER_NAME, SERVLET_CONTEXT_FINDER_REMOVAL_NAME)) {
            return;
        }

        if (binarySearch(factoryNames, factoryName) < 0) {
            throw new IllegalArgumentException(factoryName);
        }
    }

    private static Map> buildFactoryClassesMap() {
        return Map.ofEntries(
            entry(APPLICATION_FACTORY, jakarta.faces.application.ApplicationFactory.class),
            entry(VISIT_CONTEXT_FACTORY, jakarta.faces.component.visit.VisitContextFactory.class),
            entry(EXCEPTION_HANDLER_FACTORY, jakarta.faces.context.ExceptionHandlerFactory.class),
            entry(EXTERNAL_CONTEXT_FACTORY, jakarta.faces.context.ExternalContextFactory.class),
            entry(FACES_CONTEXT_FACTORY, jakarta.faces.context.FacesContextFactory.class),
            entry(FLASH_FACTORY, jakarta.faces.context.FlashFactory.class),
            entry(PARTIAL_VIEW_CONTEXT_FACTORY, jakarta.faces.context.PartialViewContextFactory.class),
            entry(LIFECYCLE_FACTORY, jakarta.faces.lifecycle.LifecycleFactory.class),
            entry(CLIENT_WINDOW_FACTORY, jakarta.faces.lifecycle.ClientWindowFactory.class),
            entry(RENDER_KIT_FACTORY, jakarta.faces.render.RenderKitFactory.class),
            entry(VIEW_DECLARATION_LANGUAGE_FACTORY, jakarta.faces.view.ViewDeclarationLanguageFactory.class),
            entry(FACELET_CACHE_FACTORY, jakarta.faces.view.facelets.FaceletCacheFactory.class),
            entry(TAG_HANDLER_DELEGATE_FACTORY, jakarta.faces.view.facelets.TagHandlerDelegateFactory.class),
            entry(FLOW_HANDLER_FACTORY, jakarta.faces.flow.FlowHandlerFactory.class),
            entry(SEARCH_EXPRESSION_CONTEXT_FACTORY, jakarta.faces.component.search.SearchExpressionContextFactory.class)
        );
    }

    @SafeVarargs // todo: move to CollectionUtil
    private static > List asSortedList(T... elements) {
        return Arrays.stream(elements).sorted().collect(Collectors.toList());
    }

}
    

    

    

            

    

            



    
    






    
© 2015 - 2024 Weber Informatics LLC | Privacy Policy