com.hivemq.spi.util.PathUtils Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of hivemq-spi Show documentation
The Service Provider Interfaces for developing HiveMQ plugins.
There is a newer version: 3.4.4
/*
 * Copyright 2014 dc-square GmbH
 *
 * 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 com.hivemq.spi.util;

import com.google.common.io.Files;
import com.hivemq.spi.config.SystemInformation;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.io.File;

/**
 * Useful utilities when dealing with paths and folders
 *
 * @author Dominik Obermaier
 * @author Christoph Schäbel
 * @since 1.4
 * @deprecated Use  {@link SystemInformation} instead
 */
public class PathUtils {

    private static Logger log = LoggerFactory.getLogger(PathUtils.class);

    /**
     * @return the home folder of HiveMQ
     * @deprecated since version 3.0. Please inject {@link SystemInformation} instead
     */
    @Deprecated
    public static File getHiveMQHomeFolder() {

        final String homeFolder = System.getProperty("hivemq.home");

        if (homeFolder == null) {
            final File tempDir = Files.createTempDir();
            log.warn("No hivemq.home property was set. Using a temporary directory ({}) HiveMQ will behave unexpectedly!", tempDir.getAbsolutePath());
            return tempDir;
        }
        return new File(homeFolder);
    }

    /**
     * @return the plugin folder of HiveMQ
     * @deprecated since version 3.0. Please inject {@link SystemInformation} instead
     */
    @Deprecated
    public static File getPluginFolder() {
        throw new RuntimeException("Not yet implemented");
    }

    /**
     * @return the config folder of HiveMQ
     * @deprecated since version 3.0. Please inject {@link SystemInformation} instead
     */
    @Deprecated
    public static File getHiveMQConfigFolder() {
        return findAbsoluteAndRelative("conf");
    }

    /**
     * @return the log folder of HiveMQ
     * @deprecated since version 3.0. Please inject {@link SystemInformation} instead
     */
    @Deprecated
    public static File getHiveMQLogFolder() {
        return new File(getHiveMQHomeFolder(), "log");
    }

    /**
     * Tries to find a file in the given absolute path or
     * relative to the HiveMQ home folder
     *
     * @param fileLocation the absolute or relative path
     * @return a file
     */
    public static File findAbsoluteAndRelative(final String fileLocation) {
        final File file = new File(fileLocation);
        if (file.isAbsolute()) {
            return file;
        } else {
            return new File(getHiveMQHomeFolder(), fileLocation);
        }
    }
}