com.sun.faces.config.manager.tasks.FindConfigResourceURIsTask Maven / Gradle / Ivy

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
There is a newer version: 4.1.1
/*
 * Copyright (c) 1997, 2018 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.config.manager.tasks;

import static java.util.Collections.emptyList;

import java.net.URI;
import java.net.URL;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Iterator;
import java.util.concurrent.Callable;

import javax.servlet.ServletContext;

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


/**
 * 
 *  This Callable will be used by {@link ConfigManager#getXMLDocuments(javax.servlet.ServletContext, java.util.List, java.util.concurrent.ExecutorService, boolean)}.
 *  It represents one or more URIs to configuration resources that require processing.
 * 
 */
public class FindConfigResourceURIsTask implements Callable> {

    private ConfigurationResourceProvider provider;
    private ServletContext servletContext;


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


    /**
     * Constructs a new URITask instance.
     * @param provider the ConfigurationResourceProvider from
     *  which zero or more URLs will be returned
     * @param servletContext the ServletContext of the current application
     */
    public FindConfigResourceURIsTask(ConfigurationResourceProvider provider, ServletContext servletContext) {
        this.provider = provider;
        this.servletContext = servletContext;
    }


    // ----------------------------------------------- Methods from Callable


    /**
     * @return zero or more URL instances
     * @throws Exception if an Exception is thrown by the underlying
     *  ConfigurationResourceProvider 
     */
    @SuppressWarnings("unchecked")
    @Override
    public Collection call() throws Exception {
        Collection untypedCollection = provider.getResources(servletContext);
        Iterator untypedCollectionIterator = untypedCollection.iterator();
        
        Collection result = emptyList();
        
        if (untypedCollectionIterator.hasNext()) {
            Object cur = untypedCollectionIterator.next();
            
            // Account for older versions of the provider that return Collection.
            if (cur instanceof URL) {
                result = new ArrayList<>(untypedCollection.size());
                result.add(new URI(((URL)cur).toExternalForm()));
                while (untypedCollectionIterator.hasNext()) {
                    cur = untypedCollectionIterator.next();
                    result.add(new URI(((URL)cur).toExternalForm()));
                }
            } else {
                result = (Collection) untypedCollection;
            }
        }

        return result;
    }

}