Rio Project 4.2 API Documentation

Package org.rioproject.system

Provides classes that interact with lower level operating system and infrastructure elements, providing an abstract notion of a compute resource with qualitative and quantitative capabilities.

See:
Description

Interface Summary

ComputeResourceAdmin	The ComputeResourceAdmin provides an administrative interface for a ComputeResource
SystemCapabilitiesLoader	The SystemCapabilitiesLoader defines the semantics to load PlatformCapability and MeasurableCapability instances
SystemWatchID	Defines system based watch ids.

Class Summary

ComputeResource	The ComputeResource represents an abstract notion of a compute resource that offers computational resources which can be measured using Quality of Service mechanisms which correlate to qualitative and quantitative capabilities such as CPU, Memory, and others
ComputeResourceObserver	The ComputeResourceObserver observes the ComputeResource object associated with a ServiceBean.
ComputeResourceUtilization	The ComputeResourceUtilization provides a mechanism to represent the utilization of a ComputeResource.
MeasuredResource	The MeasuredResource represents a quantitative value of a resource that has been measured
OperatingSystemType	Utilities to help determine operating system type
ResourceCapability	Represents the capabilities of a compute resource.
SystemCapabilities	The SystemCapabilities represents the capabilities of the ComputeResource determined from a capabilities configuration file and default qualitative and quantitative mechanisms.

Package org.rioproject.system Description

Provides classes that interact with lower level operating system and infrastructure elements, providing an abstract notion of a compute resource with qualitative and quantitative capabilities.

Configuring System Attributes
The Rio boot environment supports the following configuration entries; where each configuration entry name is associated with the component name org.rioproject.system

• address

  Type:	InetAddress
  Default:	InetAddress.getLocalHost()
  Description:	The network adapter address being used. This property is read at initialization, and defaults to the localhost.

• description

  Type:	String
  Default:	The hostname concatenated with the operating system name, architecture and version
  Description:	This property is read at initialization, and provides a human readable description of the compute resource

• reportInterval

  Type:	long
  Default:	1000
  Description:	This property is read at initialization, and controls how often the ComputeResource will inform registered Observers of a state change. A state change is determined if any of the MeasurableCapability components contained within this ComputeResource provide an update in the interval specified by the reportIntervalProperty. The value is in milliseconds.

• systemCapabilitiesLoader

  Type:	SystemCapabilitiesLoader
  Default:	new SystemCapabilities
  Description:	This property is read at initialization, and is used to load PlatformCapability and MeasurableCapability instances. The default implementation loads the capabilities of the ComputeResource determined from a configured capabilities configuration file, as well as default qualitative and quantitative mechanisms.

• systemThreshold

  Type:	double
  Default:	Runtime.getRuntime().availableProcessors();
  Description:	This property is read at initialization, and defines the upper limit of the mean of all depletion oriented resources. If this threshold is crossed, an SLAThresholdEvent is sent by a Cybernode. Additionally services may declare a utilization SLA as part of their service requirements. If this value is breached, a service may choose to relocate to a differenet host, or simply not be allocated to this machine.