Rio Project 4.2 API Documentation

org.rioproject.system
Interface SystemCapabilitiesLoader

All Known Implementing Classes:

SystemCapabilities

public interface SystemCapabilitiesLoader

The SystemCapabilitiesLoader defines the semantics to load PlatformCapability and MeasurableCapability instances

Author:

Dennis Reedy

Method Summary

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

Method Detail

getMeasurableCapabilities

MeasurableCapability[] getMeasurableCapabilities(Configuration config)

Get the MeasurableCapability objects based on a passed in Configuration

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.

getPlatformCapabilities

PlatformCapability[] getPlatformCapabilities(Configuration config)

Get the PlatformCapability objects

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

Map<String,String> getPlatformCapabilityNameTable()

Get the PlatformCapability name table

Returns:

A Map of PlatformCapability names to PlatformCapability classnames

getPlatformConfigurationDirectory

String getPlatformConfigurationDirectory(Configuration config)

Get the directory to load platform configuration files from

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