io.hekate.cluster.ClusterNodeRuntime Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of hekate-all Show documentation
Java library for cluster communications and computing.
There is a newer version: 4.1.3
/*
 * Copyright 2020 The Hekate Project
 *
 * The Hekate Project 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 io.hekate.cluster;

/**
 * Information about the JVM process of the {@link ClusterNode}.
 *
 * @see ClusterNode#runtime()
 */
public interface ClusterNodeRuntime {
    /**
     * Returns the number of CPUs that are available to the Java virtual machine.
     *
     * @return Number of CPUs that are available to the Java virtual machine.
     *
     * @see Runtime#availableProcessors()
     */
    int cpus();

    /**
     * Returns the maximum amount of memory as provided by {@link Runtime#maxMemory()}.
     *
     * @return Maximum amount of memory.
     *
     * @see Runtime#maxMemory()
     */
    long maxMemory();

    /**
     * Returns the name of an operating system ('os.name' {@link System#getProperty(String) system property}).
     *
     * @return Operating system name or an empty string if such information is not available.
     */
    String osName();

    /**
     * Returns the operating system architecture ('os.arch' {@link System#getProperty(String) system property}).
     *
     * @return Operating system architecture or an empty string if such information is not available.
     */
    String osArch();

    /**
     * Returns the operating system version ('os.version' {@link System#getProperty(String) system property}).
     *
     * @return Operating system version or an empty string if such information is not available.
     */
    String osVersion();

    /**
     * Returns the Java runtime environment version ('java.version' {@link System#getProperty(String) system property}).
     *
     * @return Java runtime environment version or an empty string if such information is not available.
     */
    String jvmVersion();

    /**
     * Returns the Java virtual machine implementation name ('java.vm.name' {@link System#getProperty(String) system property}).
     *
     * @return Java virtual machine implementation name or an empty string if such information is not available.
     */
    String jvmName();

    /**
     * Returns the Java virtual machine implementation vendor ('java.vm.vendor' {@link System#getProperty(String) system property}).
     *
     * @return Java virtual machine implementation name or an empty string if such information is not available.
     */
    String jvmVendor();

    /**
     * Returns PID of a Java virtual machine system process.
     *
     * @return PID of a Java virtual machine system process.
     */
    String pid();
}