SchedulerInitializer.java

/*
 * ProActive Parallel Suite(TM):
 * The Open Source library for parallel and distributed
 * Workflows & Scheduling, Orchestration, Cloud Automation
 * and Big Data Analysis on Enterprise Grids & Clouds.
 *
 * Copyright (c) 2007 - 2017 ActiveEon
 * Contact: contact@activeeon.com
 *
 * This library is free software: you can redistribute it and/or
 * modify it under the terms of the GNU Affero General Public License
 * as published by the Free Software Foundation: version 3 of
 * the License.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 *
 * If needed, contact us to obtain a release under GPL Version 2 or 3
 * or a different license than the AGPL.
 */
package org.ow2.proactive.scheduler;

import java.io.File;

import org.ow2.proactive.scheduler.core.properties.PASchedulerProperties;


/**
 * SchedulerInitializer is used to initialize property for the Scheduler start up.
 *
 * @author The ProActive Team
 * @since ProActive Scheduling 2.0
 */
public class SchedulerInitializer {

    private String paConfiguration;

    private String security;

    private String log4j;

    private String schedulerHome;

    private String schedulerProperties;

    private String policy;

    /**
     * Set the ProActive configuration file to be used.
     * This file is used to define the behavior of ProActive.
     *
     * @see org.objectweb.proactive.core.config.PAProperties for more details.
     *
     * @param filePath the absolute file path to the PA configuration file to use.
     */
    public void setProActiveConfiguration(String filePath) {
        if (filePath == null || !new File(filePath).exists()) {
            throw new RuntimeException("File " + filePath + " does not exist !");
        }
        paConfiguration = filePath;
    }

    /**
     * Set the java security policy file to be used.
     * This is exactly what you would put in the "java.security.policy" property.
     *
     * @param filePath the absolute file path to the java security policy file to use.
     */
    public void setJavaSecurityPolicy(String filePath) {
        if (filePath == null || !new File(filePath).exists()) {
            throw new RuntimeException("File " + filePath + " does not exist !");
        }
        System.setProperty("java.security.policy", filePath);
        security = filePath;
    }

    /**
     * Set the log4j configuration file to be used on this instance.
     *
     * @see org.objectweb.proactive.core.config.PAProperties for more details.
     *
     * @param filePath the absolute file path to the log4j configuration file to use.
     */
    public void setLog4jConfiguration(String filePath) {
        if (filePath == null || !new File(filePath).exists()) {
            throw new RuntimeException("File " + filePath + " does not exist !");
        }
        System.setProperty("log4j.configuration", filePath.startsWith("file:") ? filePath : "file:" + filePath);
        log4j = filePath;
    }

    /**
     * Set the home directory for the Scheduler.
     * This property is used to resolve every relative paths in the configuration file.
     * You can leave this property without value if every specified paths are absolute in the configuration file.
     * The default value is the current directory.
     *
     * @param homeDir the home directory of Scheduler. (used to resolve relative path)
     */
    public void setSchedulerHomePath(String homeDir) {
        if (homeDir == null || !new File(homeDir).exists()) {
            throw new RuntimeException("Directory " + homeDir + " does not exist !");
        }
        if (!new File(homeDir).isDirectory()) {
            throw new RuntimeException("Scheduler Home path must be a directory !");
        }
        System.setProperty(PASchedulerProperties.SCHEDULER_HOME.getKey(), homeDir);
        schedulerHome = homeDir;
    }

    /**
     * Set the Scheduler Property configuration file.
     * This is the main file that contains every Scheduler properties.
     * THIS PROPERTY MUST BE SET.
     *
     * @param filePath the absolute file path to Scheduler properties file.
     */
    public void setSchedulerPropertiesConfiguration(String filePath) {
        if (filePath == null || !new File(filePath).exists()) {
            throw new RuntimeException("File " + filePath + " does not exist !");
        }
        schedulerProperties = filePath;
    }

    /**
     * Set the Scheduling policy full class name.
     * This value is mandatory to start the scheduler.
     *
     * @param policy the full class name of the scheduling policy to be used.
     */
    public void setPolicyFullClassName(String policy) {
        if (policy == null || policy.length() == 0) {
            throw new RuntimeException("Bad policy file");
        }
        this.policy = policy;
    }

    /**
     * Get the ProActive configuration file
     *
     * @return the ProActive configuration file
     */
    public String getProActiveConfiguration() {
        return paConfiguration;
    }

    /**
     * Get the absolute file path to the java security policy file
     *
     * @return the absolute file path to the java security policy file
     */
    public String getJavaSecurityPolicy() {
        return security;
    }

    /**
     * Get the log4j configuration file
     *
     * @return the log4j configuration file
     */
    public String getLog4jConfiguration() {
        return log4j;
    }

    /**
     * Get the home directory of Scheduler.
     *
     * @return the home directory of Scheduler.
     */
    public String getSchedulerHomePath() {
        return schedulerHome;
    }

    /**
     * Get the Scheduler Property configuration file.
     *
     * @return the Scheduler Property configuration file.
     */
    public String getSchedulerPropertiesConfiguration() {
        return schedulerProperties;
    }

    /**
     * Get the scheduling policy full class name.
     *
     * @return the scheduling policy full class name.
     */
    public String getPolicyFullClassName() {
        return policy;
    }
}