org.apache.cocoon.ProcessingUtil Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2006 The Apache Software Foundation.
 *
 * Licensed 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.cocoon;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;

import org.apache.avalon.framework.service.ServiceManager;
import org.apache.cocoon.environment.internal.EnvironmentHelper;
import org.apache.excalibur.source.SourceResolver;
import org.springframework.beans.factory.config.ConfigurableListableBeanFactory;

/**
 * This is an utility class for processing Cocoon requests.
 *
 * $Id: ProcessingUtil.java 418569 2006-07-02 11:03:28Z cziegeler $
 */
public class ProcessingUtil {

    /** Servlet context attribute name for getting the root container. */
    public static final String CONTAINER_CONTEXT_ATTR_NAME = "org.apache.cocoon.Cocoon";

    /** Bean name for the Avalon context. */
    public static final String CONTEXT_ROLE = "org.apache.avalon.framework.context.Context";

    /** Bean name for the logger. */
    public static final String LOGGER_ROLE = "org.apache.avalon.framework.logger.Logger";

    /** Bean name for the service manager. */
    public static final String SERVICE_MANAGER_ROLE = "org.apache.avalon.framework.service.ServiceManager";

    /** Bean name for local source resolver. (TODO) */
    public static final String LOCAL_SOURCE_RESOLVER_ROLE = SourceResolver.ROLE + "/local";

    /**
     * Avoid construction.
     */
    private ProcessingUtil() {}

    /**
     * The cleanup threads that are invoked after the processing of a
     * request is finished.
     */
    private static final ThreadLocal cleanup = new ThreadLocal();

    /**
     * Add a cleanup task.
     * A cleanup task is run after a request is processed.
     * @param task The task to run.
     */
    public static void addCleanupTask(CleanupTask task) {
        List l = (List)cleanup.get();
        if ( l == null ) {
            l = new ArrayList();
            cleanup.set(l);
        }
        l.add(task);
    }

    /**
     * Invoke all registered cleanup tasks for the current process.
     * This method should not be called directly!
     */
    public static void cleanup() {
        List l = (List)cleanup.get();
        if ( l != null ) {
            final Iterator i = l.iterator();
            while ( i.hasNext() ) {
                final CleanupTask t = (CleanupTask)i.next();
                t.invoke();
            }
            l.clear();
            cleanup.set(null);
        }
    }

    /**
     * The interface for the cleanup task.
     * A cleanup task can be run after a request has been processed.
     */
    public static interface CleanupTask {

        /**
         * Start the cleanup.
         * This method should never raise any exception!
         */
        void invoke();
    }

    /**
     * Get the current sitemap component manager.
     * This method returns the current sitemap component manager. This
     * is the manager that holds all the components of the currently
     * processed (sub)sitemap.
     */
    static public ServiceManager getSitemapServiceManager() {
        return EnvironmentHelper.getSitemapServiceManager(); 
    }

    final static protected Map processors = new HashMap();

    static public void register(Processor processor) {
        ProcessorInfo pi = new ProcessorInfo();
        if ( processor.getParent() != null ) {
            pi.beanFactory = getBeanFactory(processor.getParent());
        }
        processors.put(processor, pi);
    }

    static public void unregister(Processor processor) {
        processors.remove(processor);
    }

    static public void setBeanFactory(Processor processor, ConfigurableListableBeanFactory beanFactory) {
        ProcessorInfo pi = (ProcessorInfo)processors.get(processor);
        if ( pi != null ) {
            pi.beanFactory = beanFactory;
        }
        throw new IllegalStateException("Processor has not been registered. " + processor);        
    }

    static public ConfigurableListableBeanFactory getBeanFactory(Processor processor) {
        ProcessorInfo pi = (ProcessorInfo)processors.get(processor);
        if ( pi != null ) {
            return pi.beanFactory;
        }
        throw new IllegalStateException("Processor has not been registered. " + processor);
    }

    protected static final class ProcessorInfo {
        public ConfigurableListableBeanFactory beanFactory;
    }
}