Rio Project 4.2 API Documentation

org.rioproject.system.measurable.memory
Class ProcessMemoryUtilization

java.lang.Object
  org.rioproject.system.MeasuredResource
      org.rioproject.system.measurable.memory.ProcessMemoryUtilization

All Implemented Interfaces:

Serializable

public class ProcessMemoryUtilization
extends MeasuredResource
implements Serializable

Measured process memory utilization

See Also:

Serialized Form

Constructor Summary

ProcessMemoryUtilization(String identifier, double utilization, double vSize, double resident, double shared, double initHeap, double usedHeap, double maxHeap, double committedHeap, double initNonHeap, double usedNonHeap, double maxNonHeap, double committedNonHeap, ThresholdValues tVals)
Construct ProcessMemoryUtilization with parameters

ProcessMemoryUtilization(String identifier, double utilization, double initHeap, double usedHeap, double maxHeap, double committedHeap, double initNonHeap, double usedNonHeap, double maxNonHeap, double committedNonHeap, ThresholdValues tVals)
Construct ProcessMemoryUtilization with parameters

ProcessMemoryUtilization(String identifier, double utilization, double vSize, double resident, double shared, ThresholdValues tVals)
Construct ProcessMemoryUtilization with parameters

ProcessMemoryUtilization(String identifier, double utilization, ThresholdValues tVals)
Construct ProcessMemoryUtilization with parameters

Method Summary

double	getCommittedHeap() Get the amount of memory (in bytes) that is guaranteed to be available for use by the Java virtual machine.
double	getCommittedNonHeap() Get the amount of non-heap memory (in MB) that is guaranteed to be available for use by the Java virtual machine.
double	getInitHeap() Get the amount of heap memory in bytes that the Java virtual machine initially requests from the operating system for memory management.
double	getInitNonHeap() Get the amount of non-heap memory (in MB) that the Java virtual machine initially requests from the operating system for memory management.
double	getMaxHeap() Get the maximum amount of memory (in bytes) that can be used for heap memory management.
double	getMaxNonHeap() Get the maximum amount of memory (in MB) that can be used for non-heap memory management.
double	getResident() Get the Total process resident (real) memory
double	getShared() Get the Total process shared memory
double	getUsedHeap() Returns the current memory usage of the heap that is used for object allocation.
double	getUsedNonHeap() Returns the current memory usage of the non-heap that is used for object allocation.
double	getVirtualMemorySize() Get the Total process virtual memory
String	toString()

Methods inherited from class org.rioproject.system.MeasuredResource

equals, evaluate, getIdentifier, getThresholdValues, getValue, hashCode, thresholdCrossed

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ProcessMemoryUtilization

public ProcessMemoryUtilization(String identifier,
                                double utilization,
                                ThresholdValues tVals)

Construct ProcessMemoryUtilization with parameters

Parameters:

identifier - Identifier for the ProcessMemoryUtilization

utilization - The measured utilization

tVals - ThresholdValues for the ProcessMemoryUtilization

ProcessMemoryUtilization

public ProcessMemoryUtilization(String identifier,
                                double utilization,
                                double initHeap,
                                double usedHeap,
                                double maxHeap,
                                double committedHeap,
                                double initNonHeap,
                                double usedNonHeap,
                                double maxNonHeap,
                                double committedNonHeap,
                                ThresholdValues tVals)

Construct ProcessMemoryUtilization with parameters

Parameters:

identifier - Identifier for the ProcessMemoryUtilization

utilization - The measured utilization, calculated as the used-heap-use/total-heap-use

initHeap - The amount of heap memory (in MB) that the JVM initially requests

usedHeap - The amount of heap memory (in MB) used for the process

maxHeap - The maximum amount of memory (in MB) for the JVM

committedHeap - The amount of committed memory (in MB) for the JVM

initNonHeap - The amount of non-heap memory (in MB) that the JVM initially requests

usedNonHeap - The amount of non-heap memory (in MB) used by the JVM

maxNonHeap - The current non-heap memory size (in MB) that is used by the JVM

committedNonHeap - The amount of non-heap committed memory (in MB) for the JVM

tVals - ThresholdValues for the ProcessMemoryUtilization

ProcessMemoryUtilization

public ProcessMemoryUtilization(String identifier,
                                double utilization,
                                double vSize,
                                double resident,
                                double shared,
                                ThresholdValues tVals)

Construct ProcessMemoryUtilization with parameters

Parameters:

identifier - Identifier for the ProcessMemoryUtilization

utilization - The measured utilization, calculated as the used-heap-use/total-heap-use

vSize - Total process virtual memory

resident - Total process resident memory

shared - Total process shared memory

tVals - ThresholdValues for the ProcessMemoryUtilization

ProcessMemoryUtilization

public ProcessMemoryUtilization(String identifier,
                                double utilization,
                                double vSize,
                                double resident,
                                double shared,
                                double initHeap,
                                double usedHeap,
                                double maxHeap,
                                double committedHeap,
                                double initNonHeap,
                                double usedNonHeap,
                                double maxNonHeap,
                                double committedNonHeap,
                                ThresholdValues tVals)

Construct ProcessMemoryUtilization with parameters

Parameters:

identifier - Identifier for the ProcessMemoryUtilization

utilization - The measured utilization

vSize - Total process virtual memory

resident - Total process resident memory

shared - Total process shared memory

initHeap - The amount of heap memory (in MB) that the JVM initially requests

usedHeap - The amount of heap memory (in MB) used for the process

maxHeap - The maximum amount of memory (in MB) for the JVM

committedHeap - The amount of committed memory (in MB) for the JVM

initNonHeap - The amount of non-heap memory (in MB) that the JVM initially requests

usedNonHeap - The amount of non-heap memory (in MB) used by the JVM

maxNonHeap - The current non-heap memory size (in MB) that is used by the JVM

committedNonHeap - The amount of non-heap committed memory (in MB) for the JVM

tVals - ThresholdValues for the ProcessMemoryUtilization

Method Detail

getVirtualMemorySize

public double getVirtualMemorySize()

Get the Total process virtual memory

Returns:

Total process virtual memory (in MB), if undefined return -1

getResident

public double getResident()

Get the Total process resident (real) memory

Returns:

Total process resident (real) memory (in MB), if undefined return -1

getShared

public double getShared()

Get the Total process shared memory

Returns:

Total process shared memory (in MB), if undefined return -1

getUsedHeap

public double getUsedHeap()

Returns the current memory usage of the heap that is used for object allocation. The heap consists of one or more memory pools.

The amount of used memory in the returned memory usage is the amount of memory occupied by both live objects and garbage objects that have not been collected, if any.

Returns:

The sum of all used values across all heap memory pools (in MB) .

See Also:

MemoryMXBean.getHeapMemoryUsage()

getMaxHeap

public double getMaxHeap()

Get the maximum amount of memory (in bytes) that can be used for heap memory management. Its value may be undefined. The maximum amount of memory may change over time if defined.

Returns:

The maximum amount of memory (in MB) that can be allocated. If undefined return -1

See Also:

MemoryMXBean.getHeapMemoryUsage()

getCommittedHeap

public double getCommittedHeap()

Get the amount of memory (in bytes) that is guaranteed to be available for use by the Java virtual machine.

Returns:

The amount of committed memory (in MB).

See Also:

MemoryMXBean.getHeapMemoryUsage()

getInitHeap

public double getInitHeap()

Get the amount of heap memory in bytes that the Java virtual machine initially requests from the operating system for memory management.

Returns:

The initial size of memory (in MB). If undefined return -1

See Also:

MemoryMXBean.getHeapMemoryUsage()

getUsedNonHeap

public double getUsedNonHeap()

Returns the current memory usage of the non-heap that is used for object allocation. The heap consists of one or more memory pools.

Returns:

The sum of all used values (in MB) across all non-heap memory pools.

See Also:

MemoryMXBean.getNonHeapMemoryUsage()

getMaxNonHeap

public double getMaxNonHeap()

Get the maximum amount of memory (in MB) that can be used for non-heap memory management.

Returns:

The maximum amount of memory (in MB) that can be allocated for non-heap memory management. If undefined return -1

See Also:

MemoryMXBean.getNonHeapMemoryUsage()

getCommittedNonHeap

public double getCommittedNonHeap()

Get the amount of non-heap memory (in MB) that is guaranteed to be available for use by the Java virtual machine.

Returns:

The amount of committed non-heap memory (in MB).

See Also:

MemoryMXBean.getNonHeapMemoryUsage()

getInitNonHeap

public double getInitNonHeap()

Get the amount of non-heap memory (in MB) that the Java virtual machine initially requests from the operating system for memory management.

Returns:

The initial size of non-heap memory (in MB). If undefined return -1

See Also:

MemoryMXBean.getHeapMemoryUsage()

toString

public String toString()

Overrides:

toString in class MeasuredResource