eu.peppol.util.OxalisHomeDirectory Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of oxalis-api Show documentation
Holds the stuff required by external components, which may be hooked into Oxalis. Classes and resources in this module should be made available to oxalis-inbound by placing it into a shared library in the web container.
There is a newer version: 4.1.2
Show newest version
/*
 * Copyright (c) 2010 - 2015 Norwegian Agency for Pupblic Government and eGovernment (Difi)
 *
 * This file is part of Oxalis.
 *
 * Licensed under the EUPL, Version 1.1 or – as soon they will be approved by the European Commission
 * - subsequent versions of the EUPL (the "Licence"); You may not use this work except in compliance with the Licence.
 *
 * You may obtain a copy of the Licence at:
 *
 * https://joinup.ec.europa.eu/software/page/eupl5
 *
 *  Unless required by applicable law or agreed to in writing, software distributed under the Licence
 *  is distributed on an "AS IS" basis,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the Licence for the specific language governing permissions and limitations under the Licence.
 *
 */

package eu.peppol.util;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import javax.naming.InitialContext;
import javax.naming.NamingException;
import java.io.File;

/**
 * Represents the Oxalis Home directory, which is located by inspecting various
 * places in the system in this order:
 *
 * 
 * Directory referenced by Local JNDI Context java:comp/env/OXALIS_HOME
 * Directory referenced by Java System Property -D OXALIS_HOME
 * Directory referenced by Environment Variable OXALIS_HOME
 * Directory .oxalis inside the home directory of the user
 * 
 *
 * @author steinar
 * @author thore
 */
class OxalisHomeDirectory {

    public static final Logger log = LoggerFactory.getLogger(OxalisHomeDirectory.class);

    static final String OXALIS_HOME_VAR_NAME = "OXALIS_HOME";
    static final String OXALIS_HOME_JNDI_PATH =  "java:comp/env/OXALIS_HOME";

    public File locateDirectory() {

        log.info("Attempting to locate home dir ....");

        File oxalisHomeDir = null;

        if (oxalisHomeDir == null) oxalisHomeDir = locateOxalisHomeFromLocalJndiContext();
        if (oxalisHomeDir == null) oxalisHomeDir = locateOxalisHomeFromJavaSystemProperty();
        if (oxalisHomeDir == null) oxalisHomeDir = locateOxalisHomeFromEnvironmentVariable();
        if (oxalisHomeDir == null) oxalisHomeDir = computeOxalisHomeRelativeToUserHome();

        try {
            oxalisHomeDir = validateOxalisHomeDirectory(oxalisHomeDir);
        } catch (IllegalStateException ex) {
            log.error(ex.getMessage());
            throw ex;
        }

        return oxalisHomeDir;

    }

    File locateOxalisHomeFromLocalJndiContext() {
        File result = null;
        try {
            String oxalis_home = (String) new InitialContext().lookup(OXALIS_HOME_JNDI_PATH);
            if (oxalis_home != null && oxalis_home.length() > 0) {
                log.info("Using OXALIS_HOME specified as JNDI path " + OXALIS_HOME_JNDI_PATH + " as " + oxalis_home);
                result = new File(oxalis_home);
            }
        } catch (NamingException ex) {
            log.info("Unable to locate JNDI path " + OXALIS_HOME_JNDI_PATH + " ");
        }
        return result;
    }

    File locateOxalisHomeFromJavaSystemProperty() {
        File result = null;
        String oxalis_home = System.getProperty(OXALIS_HOME_VAR_NAME);
        if (oxalis_home != null && oxalis_home.length() > 0) {
            log.info("Using OXALIS_HOME specified as Java System Property -D " + OXALIS_HOME_VAR_NAME + " as " + oxalis_home);
            result = new File(oxalis_home);
        }
        return result;
    }

    File locateOxalisHomeFromEnvironmentVariable() {
        File result = null;
        String oxalis_home = System.getenv(OXALIS_HOME_VAR_NAME);
        if (oxalis_home != null && oxalis_home.length() > 0) {
            log.info("Using OXALIS_HOME specified as Environment Variable $" + OXALIS_HOME_VAR_NAME + " as " + oxalis_home);
            result = new File(oxalis_home);
        }
        return result;
    }

    File computeOxalisHomeRelativeToUserHome() {
        String userHome = System.getProperty("user.home");
        File userHomeDir = new File(userHome);
        if (!userHomeDir.isDirectory()) {
            throw new IllegalStateException(userHome + " is not a directory");
        }
        File result;
        String relative_home = "/.oxalis";
        result =  new File(userHomeDir, relative_home);
        if (result.exists()) {
            log.info("Using OXALIS_HOME relative to user.home " + relative_home + " as " + result);
        } else {
            result = null;
        }
        return result;
    }

    private File validateOxalisHomeDirectory(File oxalisHomeDirectory) {
        if (oxalisHomeDirectory == null) {
            throw new IllegalStateException("No " + OXALIS_HOME_VAR_NAME + " directory was found, Oxalis will probably cause major problems.");
        }
        if (!oxalisHomeDirectory.exists()) {
            throw new IllegalStateException(oxalisHomeDirectory + " does not exist!");
        } else if (!oxalisHomeDirectory.isDirectory()) {
            throw new IllegalStateException(oxalisHomeDirectory + " is not a directory");
        } else if (!oxalisHomeDirectory.canRead()) {
            throw new IllegalStateException(oxalisHomeDirectory + " exists, is a directory but can not be read");
        }
        return oxalisHomeDirectory;
    }

}