Openwings API Documentation (v1.0)

net.openwings.container.utilities
Interface PlatformPerformance


public interface PlatformPerformance

This interface describes a plug-in that reports performance statistics for a platform. This data is useful for load balancing algorithms.

Since:
0.9.1

Field Summary
static java.lang.String DISK
          The name of PerformanceReports for disk usage
static java.lang.String MEMORY
          The name of PerformanceReports for memory usage.
static java.lang.String NETWORK
          The name of PerformanceReports for network interfaces
static java.lang.String PROCESSOR
          The name of PerformanceReports for CPU usage
 
Method Summary
 PerformanceReport[] getPerformanceReports()
          This method returns the current set of performance reports for this platform.
 java.lang.String[] getReportTypes()
          This method returns the names of PerformanceReports generated by this object.
 void setPerformanceThresholds(PerformanceThreshold[] performanceThresholds)
          Sets the thresholds to calculate GREEN/YELLOW/RED performance flags for various types of performance reports.
 void shutdown()
          Tells the performance monitor to shut down and release any resources
 

Field Detail

NETWORK

public static final java.lang.String NETWORK
The name of PerformanceReports for network interfaces

See Also:
Constant Field Values

DISK

public static final java.lang.String DISK
The name of PerformanceReports for disk usage

See Also:
Constant Field Values

PROCESSOR

public static final java.lang.String PROCESSOR
The name of PerformanceReports for CPU usage

See Also:
Constant Field Values

MEMORY

public static final java.lang.String MEMORY
The name of PerformanceReports for memory usage. This refers to virtual memory, not physical memory

See Also:
Constant Field Values
Method Detail

getReportTypes

public java.lang.String[] getReportTypes()
This method returns the names of PerformanceReports generated by this object.

Returns:
array of PerformanceReport names

getPerformanceReports

public PerformanceReport[] getPerformanceReports()
This method returns the current set of performance reports for this platform.

Returns:
array containing the latest performance reports for the platform

setPerformanceThresholds

public void setPerformanceThresholds(PerformanceThreshold[] performanceThresholds)
Sets the thresholds to calculate GREEN/YELLOW/RED performance flags for various types of performance reports.

See Also:
PerfomanceThreshold

shutdown

public void shutdown()
Tells the performance monitor to shut down and release any resources


Openwings API Documentation (v1.0)