com.tc.config.Directories.java Source code

Introduction

Here is the source code for com.tc.config.Directories.java

Source

/*
 * All content copyright Terracotta, Inc., unless otherwise indicated. All rights reserved.
 */
package com.tc.config;

import org.apache.commons.lang.StringUtils;

import java.io.File;
import java.io.FileNotFoundException;

/**
 * Knows how to find certain directories. You should try <em>everything</em> you can to avoid using this class; using it
 * requires the user to set various system properties when running Terracotta, and we try to avoid that if at all
 * possible.
 */
public class Directories {

    /**
     * The property name is "tc.install-root".
     */
    public static final String TC_INSTALL_ROOT_PROPERTY_NAME = "tc.install-root";

    /**
     * The property "tc.install-root.ignore-checks", which is used for testing to ignore checks for the installation root
     * directory.
     */
    public static final String TC_INSTALL_ROOT_IGNORE_CHECKS_PROPERTY_NAME = "tc.install-root.ignore-checks";

    /**
     * Get installation root directory.
     * 
     * @return Installation root directory or null if TC_INSTALL_ROOT_IGNORE_CHECKS_PROPERTY_NAME is set and
     *         TC_INSTALL_ROOT_PROPERTY_NAME is not.
     * @throws FileNotFoundException If {@link #TC_INSTALL_ROOT_PROPERTY_NAME} has not been set. If
     *         {@link #TC_INSTALL_ROOT_IGNORE_CHECKS_PROPERTY_NAME} has not been set, this exception may be thrown if the
     *         installation root directory has not been set, is not a directory
     */
    public static File getInstallationRoot() throws FileNotFoundException {
        boolean ignoreCheck = Boolean.getBoolean(TC_INSTALL_ROOT_IGNORE_CHECKS_PROPERTY_NAME);
        if (ignoreCheck) {
            // XXX hack to have enterprise system tests to find license key under <ee-branch>/code/base
            String baseDir = System.getProperty("tc.base-dir");
            return new File(baseDir != null ? baseDir : ".", "../../../code/base");
        } else {
            String path = System.getProperty(TC_INSTALL_ROOT_PROPERTY_NAME);
            if (StringUtils.isBlank(path)) {
                // formatting
                throw new FileNotFoundException("The system property '" + TC_INSTALL_ROOT_PROPERTY_NAME
                        + "' has not been set. As such, the Terracotta installation directory cannot be located.");
            }

            File rootPath = new File(path).getAbsoluteFile();
            if (!rootPath.isDirectory()) {
                // formatting
                throw new FileNotFoundException("The specified Terracotta installation directory, '" + rootPath
                        + "', located via the value of the system property '" + TC_INSTALL_ROOT_PROPERTY_NAME
                        + "', does not actually exist.");
            }
            return rootPath;
        }
    }

    public static File getServerLibFolder() throws FileNotFoundException {
        return new File(getInstallationRoot(), "server/lib");
    }

    public static boolean tcInstallRootDefined() {
        String path = System.getProperty(TC_INSTALL_ROOT_PROPERTY_NAME);
        return !StringUtils.isBlank(path);
    }

}