com.buildforge.services.common.dbo
Enum CollectorPropertyDBO.BuiltIn

java.lang.Object
  extended by java.lang.Enum<CollectorPropertyDBO.BuiltIn>
      extended by com.buildforge.services.common.dbo.CollectorPropertyDBO.BuiltIn
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<CollectorPropertyDBO.BuiltIn>
Enclosing class:
CollectorPropertyDBO

public static enum CollectorPropertyDBO.BuiltIn
extends java.lang.Enum<CollectorPropertyDBO.BuiltIn>

The built-in collector property names.


Enum Constant Summary
CPU_ARCH
          The CPU's system architecture.
CPU_LOAD
          The overall load of this system, as determined by taking the ratio of system idle time to clock time, as an integer percentage, and subtracting it from 100.
CPU_LOAD1
          The one-minute load average of the system.
CPU_LOAD15
          The fifteen-minute load average of the system.
CPU_LOAD5
          The five-minute load average of the system.
CPU_MANUFACTURER
          The manufacturer of the system's CPU.
CPU_MHZ
          The estimated CPU clock frequency in MHz.
CPU_MODEL
          The CPU instruction set level.
CPU_SERIAL
          The serial number of either the machine or its processor.
DISK_FREE
          The approximate amount of free disk space for the server's configured directory.
DISK_TOTAL
          The approximate amount of total disk space for the server's configured directory.
MEM_FREE
          The amount of physical memory that is available, in megabytes, as reported by the operating system.
MEM_LOAD
          The percentage of physical memory that is allocated.
MEM_PAGESIZE
          This is the size that a virtual memory page contains on this architecture.
MEM_TOTAL
          The total amount of physical memory, in megabytes, as reported by the operating system.
NET_FQDN
          The Fully-Qualified Domain Name of this system.
NET_HWADDR
          The hardware address of the network interface, if any.
NET_IFACE
          The name of the network interface over which the agent is communicating.
NET_IPV
          Reports the IP version over which the agent is communicating.
NET_IPV4
          Reports the IPv4 address over which the agent is communicating.
NET_IPV6
          Reports the IPv6 address over which the agent is communicating.
NET_SPEED
          The nominal speed of the network interface, in megabits per second.
NUM_CPU
          The number of processors on this system.
OS_HOSTID
          The return value of the gethostid() system call.
OS_MACHINE
          The operating system's machine identifier, as reported by its kernel.
OS_RELEASE
          The operating system release identifier, as reported by its kernel.
OS_SYSNAME
          The operating system, as reported by its kernel.
OS_VERSION
          The operating system version identifier, as reported by its kernel.
WIN_SERVICEPACK
          For Windows machines, this reports the current service pack level of the machine.
 
Field Summary
static java.lang.Class<CollectorPropertyDBO.BuiltIn> CLASS
           
 
Method Summary
 CollectorPropertyDBO.BuiltIn fromObject(java.lang.Object o)
           
static CollectorPropertyDBO.BuiltIn valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static CollectorPropertyDBO.BuiltIn[] values()
          Returns an array containing the constants of this enum type, in the order they're declared.
 
Methods inherited from class java.lang.Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

CPU_ARCH

public static final CollectorPropertyDBO.BuiltIn CPU_ARCH
The CPU's system architecture. This value should give a fair indication of the basic instruction set architecture that is used by the system's processors. Some example values include X86, IA64, HP/PA, and SPARC.


CPU_LOAD

public static final CollectorPropertyDBO.BuiltIn CPU_LOAD
The overall load of this system, as determined by taking the ratio of system idle time to clock time, as an integer percentage, and subtracting it from 100. This value is only reported by Windows agents. As an example, if the Windows Task Manager reports that the system is 58% idle, then CPU_LOAD will be 42. See CPU_LOAD1 for the limitations of the agent in reporting this information.


CPU_LOAD1

public static final CollectorPropertyDBO.BuiltIn CPU_LOAD1
The one-minute load average of the system. A load average is a time-decaying average of the number of processes on the system that are actively using system resources, as determined by those that are currently runnable or running. The averages decay over time such that when the system is idle, all three will trend towards 0. The load averages decay at different rates so that they will be representative of different time intervals.

Linux: On Linux systems, this count also includes processes that are in the uninterruptable wait state, which is intended to take into account the load generated by disk I/O, but may also give misleading information if the "disk" is a network drive that has become unavailable. This behavior is the result of a design decision that was made by the Linux kernel developers, and it can not be controlled by the agent.

Windows: On Windows systems, there is no system call to return the load average information. Instead, the agent's dispatcher monitors system activity to report how the number of processes on the system changes over time. The agent has no convenient means of determining which processes are running and which ones are idle, so all processes on the system are assumed to be runnable, and a simple process count is used. This results in much larger load averages than are generally reported by other systems (commonly 30 or more), so load average is not a fair basis of comparison when used between non-Windows and Windows machines.


CPU_LOAD5

public static final CollectorPropertyDBO.BuiltIn CPU_LOAD5
The five-minute load average of the system. See CPU_LOAD1 for more information.


CPU_LOAD15

public static final CollectorPropertyDBO.BuiltIn CPU_LOAD15
The fifteen-minute load average of the system. See CPU_LOAD1 for more information.


CPU_MHZ

public static final CollectorPropertyDBO.BuiltIn CPU_MHZ
The estimated CPU clock frequency in MHz.


CPU_MANUFACTURER

public static final CollectorPropertyDBO.BuiltIn CPU_MANUFACTURER
The manufacturer of the system's CPU. Common examples include AMD, Intel, HP, IBM, and Sun. This information may not be available on all platforms.


CPU_MODEL

public static final CollectorPropertyDBO.BuiltIn CPU_MODEL
The CPU instruction set level. In the X86 architecture, the processor can be at the 386, 486, 586, 686, or X86_64 level. Not that X86_64 is not related to the IA-64 architecture. This information may not be available on all platforms.


CPU_SERIAL

public static final CollectorPropertyDBO.BuiltIn CPU_SERIAL
The serial number of either the machine or its processor. This information may not be available on all platforms.


DISK_FREE

public static final CollectorPropertyDBO.BuiltIn DISK_FREE
The approximate amount of free disk space for the server's configured directory. The value is reported in megabytes, and will not generally take other limiting factors (such as the user's disk quota) into account.


DISK_TOTAL

public static final CollectorPropertyDBO.BuiltIn DISK_TOTAL
The approximate amount of total disk space for the server's configured directory. The value is reported in megabytes, and will not generally take other limiting factors (such as the user's disk quota) into account. However, on operating systems that reserve a portion of the disk for use by privileged users only, the reported value will reflect the restricted size if the account the agent is using is not privileged.


MEM_FREE

public static final CollectorPropertyDBO.BuiltIn MEM_FREE
The amount of physical memory that is available, in megabytes, as reported by the operating system.


MEM_LOAD

public static final CollectorPropertyDBO.BuiltIn MEM_LOAD
The percentage of physical memory that is allocated. The reported value should be equal to int((1 - (MEM_FREE / MEM_TOTAL)) * 100).


MEM_PAGESIZE

public static final CollectorPropertyDBO.BuiltIn MEM_PAGESIZE
This is the size that a virtual memory page contains on this architecture. 4096 is by far the most common value.


MEM_TOTAL

public static final CollectorPropertyDBO.BuiltIn MEM_TOTAL
The total amount of physical memory, in megabytes, as reported by the operating system.


NET_FQDN

public static final CollectorPropertyDBO.BuiltIn NET_FQDN
The Fully-Qualified Domain Name of this system. This value is obtained by performing a reverse DNS lookup on the IP address over which the agent is communicating. As the agent may have a special DNS configuration, there is no guarantee that the FQDN it reports will be usable by others.


NET_IFACE

public static final CollectorPropertyDBO.BuiltIn NET_IFACE
The name of the network interface over which the agent is communicating. On Windows systems, this is the name that is reported by the ipconfig command. On other systems, it is the short interface name as reported by ifconfig.


NET_IPV

public static final CollectorPropertyDBO.BuiltIn NET_IPV
Reports the IP version over which the agent is communicating. At this time, only IPv4 is supported, so this value will always be 4.


NET_IPV4

public static final CollectorPropertyDBO.BuiltIn NET_IPV4
Reports the IPv4 address over which the agent is communicating. If IPv6 was used, but the agent is able to find an IPv4 address on the same interface, then that address is reported.


NET_IPV6

public static final CollectorPropertyDBO.BuiltIn NET_IPV6
Reports the IPv6 address over which the agent is communicating. If IPv4 was used, but the agent is able to find an IPv6 address on the same interface, then that address is reported.


NET_HWADDR

public static final CollectorPropertyDBO.BuiltIn NET_HWADDR
The hardware address of the network interface, if any. For ethernet and related devices, this is often called the Media Access Control (MAC) address.


NET_SPEED

public static final CollectorPropertyDBO.BuiltIn NET_SPEED
The nominal speed of the network interface, in megabits per second. For example, gigabit ethernet would be reported as 1000. This information may not be available for all platforms.


NUM_CPU

public static final CollectorPropertyDBO.BuiltIn NUM_CPU
The number of processors on this system. The number of CPUs that are reported depends on the number reported by the operating system. Multiple-core CPUs should always show up properly. A hyperthreaded single-core CPU should really only show up as one CPU, but many architectures will report this as two CPUs.


OS_HOSTID

public static final CollectorPropertyDBO.BuiltIn OS_HOSTID
The return value of the gethostid() system call. This value is changable by the system administrator on most platforms. For example, on Linux the value can be set by writing a 32-bit integer value (in binary form) to /etc/hostid. This function may not be available for all platforms.


OS_MACHINE

public static final CollectorPropertyDBO.BuiltIn OS_MACHINE
The operating system's machine identifier, as reported by its kernel. See OS_SYSNAME for more information.


OS_RELEASE

public static final CollectorPropertyDBO.BuiltIn OS_RELEASE
The operating system release identifier, as reported by its kernel. See OS_SYSNAME for more information.


OS_SYSNAME

public static final CollectorPropertyDBO.BuiltIn OS_SYSNAME
The operating system, as reported by its kernel. On Unix and other fully POSIX-compliant systems, the uname(2) system call is used to obtain this information. On Windows, similar values are obtained using GetVersionEx. Some example values of OS_SYSNAME, OS_MACHINE, OS_RELEASE, and OS_VERSION taken from real systems are given in the table below. Note that different vendors have varied interpretations of the meanings of these fields.
Operating System OS_SYSNAME OS_RELEASE OS_VERSION OS_MACHINE
AIX 5.3 AIX 3 5 000179DAD300
HP-UX 11.11 HP-UX B.11.11 U 9000/800
Linux Kubuntu Edgy Eft Linux 2.6.17-11-generic #2 SMP Thu Feb 1 19:52:28 UTC 2007 i686
MacOS/X 10.4.8 Darwin 8.8.0 Darwin Kernel Version 8.8.0: Fri Sep  8 17:18:57 PDT 2006; root:xnu-792.12.6.obj~1/RELEASE_PPC Power Macintosh
Solaris 2.10 (x86) SunOS 5.10 Generic_118844-26 i86pc
Windows XP Windows XP 5 1 x86
z/OS 1.5 OS/390 15.00 3 2066


OS_VERSION

public static final CollectorPropertyDBO.BuiltIn OS_VERSION
The operating system version identifier, as reported by its kernel. See OS_SYSNAME for more information.


WIN_SERVICEPACK

public static final CollectorPropertyDBO.BuiltIn WIN_SERVICEPACK
For Windows machines, this reports the current service pack level of the machine. For example, Windows XP Professional SP2 returns 2 for this property. This value is left undefined on systems that run a non-Windows operating system.

Field Detail

CLASS

public static final java.lang.Class<CollectorPropertyDBO.BuiltIn> CLASS
Method Detail

values

public static final CollectorPropertyDBO.BuiltIn[] values()
Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:
for(CollectorPropertyDBO.BuiltIn c : CollectorPropertyDBO.BuiltIn.values())
        System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they're declared

valueOf

public static CollectorPropertyDBO.BuiltIn valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

fromObject

public CollectorPropertyDBO.BuiltIn fromObject(java.lang.Object o)
                                        throws APIException
Throws:
APIException