org.apache.system.SystemUtil Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of system-utils Show documentation
System Utilities for Blazegraph DB
There is a newer version: 2.1.4
/* 
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF 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.apache.system;

import org.apache.log4j.Logger;

/**
 * A set of utility operations that provide necessary information about the
 * architecture of the machine that the system is running on. The values
 * provided are automatically determined at JVM startup. The SystemUtils uses a
 * plugin architecture so that it can be extended for more than just Linux /
 * Windows support.
 * 
 * @author Avalon Development Team
 * @author Bryan Thompson
 * @version $Id$
 */
public final class SystemUtil
{
    private static final int m_processors;
    private static final String m_cpuInfo;
    private static final String m_architecture;
    private static final String m_osName;
    private static final String m_osVersion;
    private static final boolean m_windows;
    private static final boolean m_linux;
    private static final boolean m_osx;

    private static final Logger log = Logger.getLogger(SystemUtil.class);
    
    static
    {
        m_architecture = System.getProperty( "os.arch" );
        m_osName = System.getProperty( "os.name" );
        m_osVersion = System.getProperty( "os.version" );
        int procs = 0;
        String info = "";

        final String prefix = SystemUtil.class.getPackage().getName();

        final String name = prefix + "." + stripWhitespace(m_osName);

        try {
            
            final Class klass = Class.forName( name );
            
            final CPUParser parser = (CPUParser)klass.newInstance();
            
            procs = parser.numProcessors();
            
            info = parser.cpuInfo();
            
        } catch (Throwable e) {
            
            log.warn("No CPUParser for this platform - looking for class: ["
                    + name + "]");

            final String proc = System.getProperty( "os.arch.cpus", "1" );
            
            info = System.getProperty("os.arch.info", m_architecture
                    + " Family n, Model n, Stepping n, Undeterminable");

            procs = Integer.parseInt( proc );
            
        }

        m_processors = procs;
        m_cpuInfo = info;
        m_windows = SystemUtil.operatingSystem().startsWith("Windows");
        m_linux = SystemUtil.operatingSystem().startsWith("Linux");
        m_osx = SystemUtil.operatingSystem().contains("OS X");
        
        if (log.isInfoEnabled()) {
            log.info("architecture: " + m_architecture);
            log.info("operating system: " + m_osName);
            log.info("operation system version: " + m_osVersion);
            log.info("#processors: " + m_processors);
            log.info("cpu info: " + m_cpuInfo);
        }

    }

    /**
     * Utility method to strip whitespace from specified name (unlike trim(),
     * whitespace is stripped at any position in the name).
     * 
     * @param mosname
     *            the name.
     * 
     * @return the whitespace stripped version
     * 
     * @todo This should be more like munge(), which forces the name to have
     *       only legal characters for the file system. For the purposes of this
     *       class, we should force the name of have only legal characters for a
     *       java class name.
     */
    private static String stripWhitespace( final String mosname )
    {
        final StringBuffer sb = new StringBuffer();

        final int size = mosname.length();
        for( int i = 0; i < size; i++ )
        {
            final char ch = mosname.charAt( i );
            if(!Character.isWhitespace(ch))
            {
                sb.append( ch );
            }
        }

        return sb.toString();
    }

    /** keep utility from being instantiated */
    private SystemUtil() {

    }

    /**
     * Return the number of processors available on this machine. This is useful
     * in classes like Thread/Processor thread pool models.
     */
    public static final int numProcessors()
    {
        return m_processors;
    }

    public static final String cpuInfo()
    {
        return m_cpuInfo;
    }

    /**
     * Return the architecture name
     */
    public static final String architecture()
    {
        return m_architecture;
    }

    /**
     * Return the Operating System name
     */
    public static final String operatingSystem()
    {
        return m_osName;
    }

    /**
     * Return the Operating System version
     */
    public static final String osVersion()
    {
        return m_osVersion;
    }

    /**
     * Return true if running on Microsoft Windows.
     */
    public static final boolean isWindows() {

        return m_windows;
        
    }

    /**
     * Return true if running on Linux.
     */
    public static final boolean isLinux() {

        return m_linux;
        
    }

    /**
     * Return true if running on OSX.
     */
    public static final boolean isOSX() {
        
        return m_osx;
        
    }

}