Class UnixExtendedOperatingSystem

java.lang.Object

com.ibm.lang.management.internal.ExtendedOperatingSystemMXBeanImpl

com.ibm.lang.management.internal.UnixExtendedOperatingSystem

All Implemented Interfaces:

OperatingSystemMXBean, UnixOperatingSystemMXBean, OperatingSystemMXBean, UnixOperatingSystemMXBean, OperatingSystemMXBean, PlatformManagedObject, NotificationBroadcaster, NotificationEmitter

public final class UnixExtendedOperatingSystem
extends ExtendedOperatingSystemMXBeanImpl
implements UnixOperatingSystemMXBean

Method Summary

Modifier and Type	Method	Description
void	addNotificationListener(NotificationListener listener, NotificationFilter filter, Object handback)	Adds a listener to this MBean.
final String	getArch()	Returns the operating system architecture.
final int	getAvailableProcessors()	Returns the number of processors available to the Java virtual machine.
static UnixExtendedOperatingSystem	getInstance()
long	getMaxFileDescriptorCount()	Returns the maximum number of file descriptors that can be opened in a process.
final String	getName()	Returns the operating system name.
final ObjectName	getObjectName()	Returns an ObjectName instance representing the object name of this platform managed object.
long	getOpenFileDescriptorCount()	Returns the current number of file descriptors that are in opened state.
final double	getSystemLoadAverage()	Returns the system load average for the last minute.
final String	getVersion()	Returns the operating system version.
final void	removeNotificationListener(NotificationListener listener)	Removes a listener from this MBean.
final void	removeNotificationListener(NotificationListener listener, NotificationFilter filter, Object handback)	Removes a listener from this MBean.
final void	sendNotification(Notification notification)	Send notifications to registered listeners.

Methods declared in class ExtendedOperatingSystemMXBeanImpl

getCommittedVirtualMemorySize, getCpuLoad, getFreeMemorySize, getFreeSwapSpaceSize, getHardwareModel, getNotificationInfo, getProcessCpuLoad, getProcessCpuTime, getProcessingCapacity, getProcessPhysicalMemorySize, getProcessPrivateMemorySize, getTotalMemorySize, getTotalSwapSpaceSize, isHardwareEmulated, isProcessRunning, retrieveMemoryUsage, retrieveMemoryUsage, retrieveProcessorUsage, retrieveProcessorUsage, retrieveTotalProcessorUsage, retrieveTotalProcessorUsage

Modifier and Type	Method	Description
long	getCommittedVirtualMemorySize()	Returns the amount of virtual memory used by the process in bytes.
final double	getCpuLoad()	Returns the "recent CPU usage" for the operating environment.
long	getFreeMemorySize()	Returns the amount of free memory in bytes.
final long	getFreeSwapSpaceSize()	Returns the amount of free swap space in bytes.
final String	getHardwareModel()	Retrieve hardware model
final MBeanNotificationInfo[]	getNotificationInfo()	Returns an array indicating, for each notification this MBean may send, the name of the Java class of the notification and the notification type.
final double	getProcessCpuLoad()	Returns the recent CPU usage for the Java Virtual Machine process.
final long	getProcessCpuTime()	Returns total amount of time the process has been scheduled or executed so far in both kernel and user modes.
final int	getProcessingCapacity()	Returns the collective capacity of the virtual processors in the partition the VM is running in.
final long	getProcessPhysicalMemorySize()	Returns the amount of physical memory being used by the process in bytes.
final long	getProcessPrivateMemorySize()	Returns the amount of private memory used by the process in bytes.
long	getTotalMemorySize()	Returns the total amount of memory in bytes.
final long	getTotalSwapSpaceSize()	Returns the total amount of swap space in bytes.
final boolean	isHardwareEmulated()	Identify whether the underlying hardware is being emulated
boolean	isProcessRunning(long pid)	Indicates if the specified process is running
final MemoryUsage	retrieveMemoryUsage()	Instantiates and returns an instance of MemoryUsage object that represents the current snapshot of Memory usage statistics.
final MemoryUsage	retrieveMemoryUsage(MemoryUsage memoryUsageObj)	Returns an updated MemoryUsage object that represents the current snapshot of Memory usage statistics.
final ProcessorUsage[]	retrieveProcessorUsage()	Instantiates and returns an array of ProcessorUsage objects that represent the current snapshot of individual Processor usage times.
final ProcessorUsage[]	retrieveProcessorUsage(ProcessorUsage[] procUsageArr)	Returns an updated array of ProcessorUsage objects that represent the current snapshot of individual Processor usage times.
final ProcessorUsage	retrieveTotalProcessorUsage()	Instantiate and return a new ProcessorUsage object that represents the current snapshot of Processor usage statistics.
final ProcessorUsage	retrieveTotalProcessorUsage(ProcessorUsage procUsageObj)	Returns an updated ProcessorUsage object that represents the current snapshot of Processor usage statistics.

Methods declared in class Object

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

Methods declared in interface OperatingSystemMXBean

getFreePhysicalMemorySize, getSystemCpuLoad, getTotalPhysicalMemorySize

Method Details

getInstance

public static UnixExtendedOperatingSystem getInstance()

getMaxFileDescriptorCount

public long getMaxFileDescriptorCount()

Returns the maximum number of file descriptors that can be opened in a process.

Specified by:

getMaxFileDescriptorCount in interface UnixOperatingSystemMXBean

Specified by:

getMaxFileDescriptorCount in interface UnixOperatingSystemMXBean

Returns:

The maximum number of file descriptors that can be opened in a process or -1, if an error occurred while obtaining this. If the operating system doesn't have any limits configured, Long.MAX_VALUE is returned.

getOpenFileDescriptorCount

public long getOpenFileDescriptorCount()

Returns the current number of file descriptors that are in opened state.

Specified by:

getOpenFileDescriptorCount in interface UnixOperatingSystemMXBean

Specified by:

getOpenFileDescriptorCount in interface UnixOperatingSystemMXBean

Returns:

The current number of file descriptors that are in opened state or -1, if an error occurred while obtaining this.

getArch

public final String getArch()

Returns the operating system architecture. This method is equivalent to System.getProperty("os.arch").

Specified by:

getArch in interface OperatingSystemMXBean

Returns:

the operating system architecture.

See Also:

• System.getProperty(String)

getAvailableProcessors

public final int getAvailableProcessors()

Returns the number of processors available to the Java virtual machine. This method is equivalent to the Runtime.availableProcessors() method.

This value may change during a particular invocation of the virtual machine.

Specified by:

getAvailableProcessors in interface OperatingSystemMXBean

Returns:

the number of processors available to the virtual machine; never smaller than one.

getName

public final String getName()

Returns the operating system name. This method is equivalent to System.getProperty("os.name").

Specified by:

getName in interface OperatingSystemMXBean

Returns:

the operating system name.

See Also:

• System.getProperty(String)

getObjectName

public final ObjectName getObjectName()

Returns an ObjectName instance representing the object name of this platform managed object.

Specified by:

getObjectName in interface PlatformManagedObject

Returns:

an ObjectName instance representing the object name of this platform managed object.

getSystemLoadAverage

public final double getSystemLoadAverage()

Returns the system load average for the last minute. The system load average is the sum of the number of runnable entities queued to the available processors and the number of runnable entities running on the available processors averaged over a period of time. The way in which the load average is calculated is operating system specific but is typically a damped time-dependent average.

If the load average is not available, a negative value is returned.

This method is designed to provide a hint about the system load and may be queried frequently. The load average may be unavailable on some platform where it is expensive to implement this method.

Specified by:

getSystemLoadAverage in interface OperatingSystemMXBean

Returns:

the system load average; or a negative value if not available.

getVersion

public final String getVersion()

Returns the operating system version. This method is equivalent to System.getProperty("os.version").

Specified by:

getVersion in interface OperatingSystemMXBean

Returns:

the operating system version.

See Also:

• System.getProperty(String)

addNotificationListener

public void addNotificationListener(NotificationListener listener,
 NotificationFilter filter,
 Object handback)
                             throws IllegalArgumentException

Adds a listener to this MBean.

Specified by:

addNotificationListener in interface NotificationBroadcaster

Parameters:

listener - The listener object which will handle the notifications emitted by the broadcaster.

filter - The filter object. If filter is null, no filtering will be performed before handling notifications.

handback - An opaque object to be sent back to the listener when a notification is emitted. This object cannot be used by the Notification broadcaster object. It should be resent unchanged with the notification to the listener.

Throws:

IllegalArgumentException - Listener parameter is null.

See Also:

• NotificationBroadcaster.removeNotificationListener(NotificationListener)

removeNotificationListener

public final void removeNotificationListener(NotificationListener listener)
                                      throws ListenerNotFoundException

Removes a listener from this MBean. If the listener has been registered with different handback objects or notification filters, all entries corresponding to the listener will be removed.

Specified by:

removeNotificationListener in interface NotificationBroadcaster

Parameters:

listener - A listener that was previously added to this MBean.

Throws:

ListenerNotFoundException - The listener is not registered with the MBean.

See Also:

• NotificationBroadcaster.addNotificationListener(NotificationListener, NotificationFilter, Object)
• NotificationEmitter.removeNotificationListener(NotificationListener, NotificationFilter, Object)

removeNotificationListener

public final void removeNotificationListener(NotificationListener listener,
 NotificationFilter filter,
 Object handback)
                                      throws ListenerNotFoundException

Removes a listener from this MBean. The MBean must have a listener that exactly matches the given listener, filter, and handback parameters. If there is more than one such listener, only one is removed.

The filter and handback parameters may be null if and only if they are null in a listener to be removed.

Specified by:

removeNotificationListener in interface NotificationEmitter

Parameters:

listener - A listener that was previously added to this MBean.

filter - The filter that was specified when the listener was added.

handback - The handback that was specified when the listener was added.

Throws:

ListenerNotFoundException - The listener is not registered with the MBean, or it is not registered with the given filter and handback.

sendNotification

public final void sendNotification(Notification notification)

Send notifications to registered listeners.

Parameters:

notification - a notification to be sent