org.jppf.management

Class JPPFSystemInformation

java.lang.Object

org.jppf.management.JPPFSystemInformation

All Implemented Interfaces:

Serializable, PropertiesCollection<String>

public class JPPFSystemInformation
extends Object
implements PropertiesCollection<String>

This class encapsulates the system information for a node.
It includes:

• System properties, including -D flags
• Runtime information such as available processors and memory usage
• Environment variables
• JPPF configuration properties
• IPV4 and IPV6 addresses assigned to the JVM host
• Disk space information (JDK 1.6 or later only)

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JPPFSystemInformation.HostIP Instances of this class represent a hostname / ip address pair.

Constructor Summary

Constructors

Constructor and Description
JPPFSystemInformation(String uuid, boolean local, boolean resolveInetAddressesNow) Initialize this system information object with the specified uuid.

Method Summary

Methods

Modifier and Type	Method and Description
void	addProperties(String key, TypedProperties properties) Add the psecified properties with the specified keys.
TypedProperties	getEnv() Get the map holding the environment variables.
TypedProperties	getJppf() Get the map holding the JPPF configuration properties.
TypedProperties	getNetwork() Get the map of the network configuration.
TypedProperties	getProperties(String key) Add the specified properties with the specified key.
TypedProperties[]	getPropertiesArray() Get all the properties as an array.
TypedProperties	getRuntime() Get the map holding the runtime information.
TypedProperties	getStorage() Get the map holding the host storage information.
TypedProperties	getSystem() Get the map holding the system properties.
TypedProperties	getUuid() Get the properties object holding the JPPF uuid and evrsion information.
JPPFSystemInformation	populate() Populate this system information object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JPPFSystemInformation

public JPPFSystemInformation(String uuid,
                     boolean local,
                     boolean resolveInetAddressesNow)

Initialize this system information object with the specified uuid.

Parameters:

uuid - the uuid of the corresponding JPPF component.

local - true if the JPPF component is local (local node or local client executor), false otherwise.

resolveInetAddressesNow - if true, then name resolution for InetAddresses should occur immediately, otherwise it is different and executed in a separate thread.

Method Detail

getSystem

public TypedProperties getSystem()

Get the map holding the system properties.

Returns:

a TypedProperties instance.

See Also:

SystemUtils.getSystemProperties()

getRuntime

public TypedProperties getRuntime()

Get the map holding the runtime information.

The resulting map will contain the following properties:

• availableProcessors = number of processors available to the JVM
• freeMemory = current free heap size in bytes
• totalMemory = current total heap size in bytes
• maxMemory = maximum heap size in bytes (i.e. as specified by -Xmx JVM option)

Some or all of these properties may be missing if a security manager is installed that does not grant access to the related Runtime APIs.

Returns:

a TypedProperties instance.

See Also:

SystemUtils.getRuntimeInformation()

getEnv

public TypedProperties getEnv()

Get the map holding the environment variables.

Returns:

a TypedProperties instance.

See Also:

SystemUtils.getEnvironment()

getNetwork

public TypedProperties getNetwork()

Get the map of the network configuration.

The resulting map will contain the following properties:

• ipv4.addresses = hostname_1|ipv4_address_1 ... hostname_n|ipv4_address_n
• ipv6.addresses = hostname_1|ipv6_address_1 ... hostname_p|ipv6_address_p

Each property is a space-separated list of hostname|ip_address pairs, the hostname and ip address being separated by a pipe symbol "|".

Returns:

a TypedProperties instance.

See Also:

SystemUtils.getNetwork()

getJppf

public TypedProperties getJppf()

Get the map holding the JPPF configuration properties.

Returns:

a TypedProperties instance.

See Also:

JPPFConfiguration

getStorage

public TypedProperties getStorage()

Get the map holding the host storage information.

The map will contain the following information:

• host.roots.names = root_name_0 ... root_name_n-1 : the names of all accessible file system roots
• host.roots.number = n : the number of accessible file system roots
• For each root i:
• root.i.name = root_name : for instance "C:\" on Windows or "/" on Unix
• root.i.space.free = space_in_bytes : current free space for the root
• root.i.space.total = space_in_bytes : total space for the root
• root.i.space.usable = space_in_bytes : space available to the user the JVM is running under

If the JVM version is prior to 1.6, the space information will not be available.

Returns:

a TypedProperties instance.

See Also:

SystemUtils.getStorageInformation()

populate

public JPPFSystemInformation populate()

Populate this system information object.

Returns:

this JPPFSystemInformation object.

getUuid

public TypedProperties getUuid()

Get the properties object holding the JPPF uuid and evrsion information. The following properties are provided:

• "jppf.uuid" : the uuid of the node or driver
• "jppf.version.number" : the current JPPF version number
• "jppf.build.number" : the current build number
• "jppf.build.date" : the build date, including the time zone, in the format "yyyy-MM-dd hh:mm z"

Returns:

a TypedProperties wrapper for the uuid and version information of the corresponding JPPF component.

getPropertiesArray

public TypedProperties[] getPropertiesArray()

Get all the properties as an array.

Specified by:

getPropertiesArray in interface PropertiesCollection<String>

Returns:

an array of all the sets of properties.

addProperties

public void addProperties(String key,
                 TypedProperties properties)

Description copied from interface: PropertiesCollection

Add the psecified properties with the specified keys.

Specified by:

addProperties in interface PropertiesCollection<String>

Parameters:

key - the key to use.

properties - the properties to add.

getProperties

public TypedProperties getProperties(String key)

Description copied from interface: PropertiesCollection

Add the specified properties with the specified key.

Specified by:

getProperties in interface PropertiesCollection<String>

Parameters:

key - the key to use to retrieve the properties.

Returns:

the properties to correponding to the key, or null if the key could not be found.