org.elasticsearch.hadoop.util.OsUtil Maven / Gradle / Ivy

/*
 * Licensed to Elasticsearch under one or more contributor
 * license agreements. See the NOTICE file distributed with
 * this work for additional information regarding copyright
 * ownership. Elasticsearch 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.
 */

package org.elasticsearch.hadoop.util;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

/**
 * Utility to detect different OS runtime environments
 */
public final class OsUtil {

    private static final Log LOG = LogFactory.getLog(OsUtil.class);

    /**
     * Name of the current operating system configured in the 'os.name' system property, or null if the property
     * could not be read.
     */
    public static final String OS_NAME;
    static {
        String osName;
        try {
            osName = System.getProperty("os.name");
        } catch (SecurityException ex) {
            // For whatever reason we cannot get this property
            LOG.error("Caught SecurityException reading 'os.name' system property. Defaulting to null.", ex);
            osName = null;
        }
        OS_NAME = osName;
    }

    private static final String WINDOWS_PREFIX = "Windows";

    /**
     * True if the underlying operating system is part of the Windows Family
     */
    public static final boolean IS_OS_WINDOWS = osMatches(WINDOWS_PREFIX);

    private static boolean osMatches(String osPrefix) {
        return OS_NAME != null && OS_NAME.startsWith(osPrefix);
    }

    private OsUtil() { /* No instance */ }
}