trunk/src/modules-legacy/task/java/src/org/apache/lenya/cms/task/TaskManager.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.
 *
 */

/* $Id$  */

package org.apache.lenya.cms.task;

import java.io.File;
import java.io.IOException;
import java.util.HashMap;
import java.util.Map;

import org.apache.avalon.framework.configuration.Configurable;
import org.apache.avalon.framework.configuration.Configuration;
import org.apache.avalon.framework.configuration.ConfigurationException;
import org.apache.avalon.framework.configuration.DefaultConfigurationBuilder;
import org.apache.avalon.framework.service.ServiceManager;
import org.apache.log4j.Logger;
import org.xml.sax.SAXException;

/**
 * The task manager
 * @deprecated Use the usecase framework instead.
 */
public class TaskManager implements Configurable {
    private static Logger log = Logger.getLogger(TaskManager.class);
    /**
     * <code>TASK_ELEMENT</code> The task element
     */
    public static final String TASK_ELEMENT = "task";
    /**
     * <code>TASK_ID_ATTRIBUTE</code> The task id attribute
     */
    public static final String TASK_ID_ATTRIBUTE = "id";
    /**
     * <code>CONFIGURATION_FILE</code> The path to the configuration file
     */
    public static final String CONFIGURATION_FILE = File.separator + "config" + File.separator
            + "tasks" + File.separator + "tasks.xconf";

    /**
     * <code>EMTPY_TASK</code> Constant for an empty task
     */
    public static final String EMTPY_TASK = "empty";
    /**
     * <code>ANT_TASK</code> Constant for an ant task
     */
    public static final String ANT_TASK = "ant";

    // maps task-ids to tasks
    private Map tasks = new HashMap();

    private ServiceManager manager;

    /**
     * Creates a new TaskManager object.
     * @param manager The service manager to use.
     */
    public TaskManager(ServiceManager manager) {
        this.manager = manager;
    }

    /**
     * Creates a new instance of TaskManager
     * @param publicationPath path to publication
     * @param manager The service manager to use.
     * @throws ConfigurationException if the configuration failed.
     * @throws SAXException when parsing the config file failed.
     * @throws IOException when an I/O error occured.
     */
    public TaskManager(String publicationPath, ServiceManager manager)
            throws ConfigurationException, SAXException, IOException {
        this(manager);

        String configurationFilePath = publicationPath + CONFIGURATION_FILE;
        log.debug("Loading tasks: " + configurationFilePath);

        File configurationFile = new File(configurationFilePath);

        if (configurationFile.isFile()) {
            DefaultConfigurationBuilder builder = new DefaultConfigurationBuilder();
            Configuration configuration = builder.buildFromFile(configurationFile);
            configure(configuration);

        } else {
            log.info("Task configuration not loaded - file [" + configurationFile.getAbsolutePath()
                    + "] does not exist.");
        }

        Task empty = new EmptyTask();
        empty.service(this.manager);
        this.tasks.put(EMTPY_TASK, empty);

        Task ant = new AntTask();
        ant.service(this.manager);
        this.tasks.put(ANT_TASK, ant);
    }

    /**
     * @see org.apache.avalon.framework.configuration.Configurable#configure(org.apache.avalon.framework.configuration.Configuration)
     */
    public void configure(Configuration configuration) throws ConfigurationException {
        log.debug("Creating tasks:");

        // create task list
        Configuration[] taskConfigurations = configuration.getChildren(TASK_ELEMENT);

        // set task IDs
        for (int i = 0; i < taskConfigurations.length; i++) {
            String taskId = taskConfigurations[i].getAttribute(TASK_ID_ATTRIBUTE);
            log.debug("Creating task '" + taskId + "'");

            Task task = TaskFactory.getInstance().createTask(taskConfigurations[i]);
            task.service(this.manager);
            this.tasks.put(taskId, task);
        }
    }

    /**
     * Return all task ids
     * @return The task ids
     */
    public String[] getTaskIds() {
        return (String[]) this.tasks.keySet().toArray(new String[this.tasks.size()]);
    }

    /**
     * Get the task with a given task-id
     * @param taskId the task-id of the requested task
     * @return the task
     * @throws ExecutionException if there is no task with the given task-id.
     */
    public Task getTask(String taskId) throws ExecutionException {
        if (!this.tasks.containsKey(taskId)) {
            throw new ExecutionException("Task with ID '" + taskId + "' not found!");
        }

        return (Task) this.tasks.get(taskId);
    }
}