Rio Project 4.2 API Documentation

org.rioproject.system
Class SystemCapabilities

java.lang.Object
  org.rioproject.system.SystemCapabilities

All Implemented Interfaces:

SystemCapabilitiesLoader

public class SystemCapabilities
extends Object
implements SystemCapabilitiesLoader

The SystemCapabilities represents the capabilities of the ComputeResource determined from a capabilities configuration file and default qualitative and quantitative mechanisms.

Author:

Dennis Reedy

Field Summary

static String	CAPABILITY
static String	COMPONENT
static String	J2SE
static String	MEMORY
static String	NATIVE_LIB_CLASS
static String	NATIVE_LIBS
static String	OPSYS
static String	PROCESSOR
static String	RIO
static String	STORAGE
static String	TCPIP

Constructor Summary

SystemCapabilities()

Method Summary

MeasurableCapability[]	getMeasurableCapabilities(Configuration config) Get the MeasurableCapability objects based on a passed in Configuration
PlatformCapability[]	getPlatformCapabilities(Configuration config) Get the PlatformCapability objects
protected PlatformCapability	getPlatformCapability(String className)
Map<String,String>	getPlatformCapabilityNameTable() Get the PlatformCapability name table
String	getPlatformConfigurationDirectory(Configuration config) Get the directory to load platform configuration files from

Methods inherited from class java.lang.Object

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

Field Detail

COMPONENT

public static final String COMPONENT

See Also:

Constant Field Values

CAPABILITY

public static final String CAPABILITY

See Also:

Constant Field Values

NATIVE_LIBS

public static final String NATIVE_LIBS

See Also:

Constant Field Values

PROCESSOR

public static final String PROCESSOR

See Also:

Constant Field Values

OPSYS

public static final String OPSYS

See Also:

Constant Field Values

TCPIP

public static final String TCPIP

See Also:

Constant Field Values

J2SE

public static final String J2SE

See Also:

Constant Field Values

MEMORY

public static final String MEMORY

See Also:

Constant Field Values

STORAGE

public static final String STORAGE

See Also:

Constant Field Values

NATIVE_LIB_CLASS

public static final String NATIVE_LIB_CLASS

See Also:

Constant Field Values

RIO

public static final String RIO

See Also:

Constant Field Values

Constructor Detail

SystemCapabilities

public SystemCapabilities()

Method Detail

getMeasurableCapabilities

public MeasurableCapability[] getMeasurableCapabilities(Configuration config)

Get the MeasurableCapability objects based on a passed in Configuration

Specified by:

getMeasurableCapabilities in interface SystemCapabilitiesLoader

Parameters:

config - A Configuration to use to assist in creating MeasurableCapability objects

Returns:

Return an array of MeasurableCapability objects. This method will create a new array of MeasurableCapability objects each time it is invoked. At a minimum the following MeasurableCapability objects will be returned:

• org.rioproject.system.measurable.cpu.CPU
• org.rioproject.system.measurable.memory.Memory

If the operating system is not a member of the "Windows" family of operating systems, an additional MeasurableCapability is returned :

• org.rioproject.system.measurable.disk.DiskSpace

getPlatformCapabilities

public PlatformCapability[] getPlatformCapabilities(Configuration config)

Get the PlatformCapability objects

Specified by:

getPlatformCapabilities in interface SystemCapabilitiesLoader

Parameters:

config - A Configuration to use to assist in creating MeasurableCapability objects

Returns:

An array of PlatformCapability objects. This method will create a new array of PlatformCapability objects each time it is invoked. If there are no PlatformCapability objects contained within the platforms Collection, a zero-length array will be returned.

getPlatformCapabilityNameTable

public Map<String,String> getPlatformCapabilityNameTable()

Get the PlatformCapability name table

Specified by:

getPlatformCapabilityNameTable in interface SystemCapabilitiesLoader

Returns:

A Map of PlatformCapability names to PlatformCapability classnames

getPlatformConfigurationDirectory

public String getPlatformConfigurationDirectory(Configuration config)

Description copied from interface: SystemCapabilitiesLoader

Get the directory to load platform configuration files from

Specified by:

getPlatformConfigurationDirectory in interface SystemCapabilitiesLoader

Parameters:

config - A Configuration to use to retrieve the location. The following property can be used to set the location:

 org.rioproject.system.platformDirs
 

If this property is not set, the default will be:

RIO_HOME/config/platform

Returns:

The directorty (path) to load plaform configuration files from

getPlatformCapability

protected PlatformCapability getPlatformCapability(String className)
                                            throws Exception

Throws:

Exception