com.crystaldecisions.sdk.occa.enadmin
Interface IServerGeneralMetrics

public interface IServerGeneralMetrics

The IServerGeneralMetrics interface provides the metrics for the server's host machine. With this object, you can monitor information on the host's CPU, disk space, memory, and operating system.

Method Summary

java.lang.String	getCPU() Returns the name of the host hardware processor.
int	getCPUCount() Returns the number of processors in the server host.
java.util.Date	getCurrentTime() Returns the local time on the server host.
double	getDiskSpaceAvailable() Returns the available disk space on the host.
double	getDiskSpaceTotal() Returns the total disk space available on the host.
long	getMemory() Returns the maximum memory available in KB.
java.lang.String	getOperatingSystem() Returns the server's operating system name.
java.util.Date	getStartTime() Returns the time that the server was started.
java.lang.String	getVersion() Returns the version number of the server executable/binary.

Method Detail

getVersion

java.lang.String getVersion()
                            throws SDKException

Returns the version number of the server executable/binary.

Returns:

A String specifying the version number of the server executable/binary.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getOperatingSystem

java.lang.String getOperatingSystem()
                                    throws SDKException

Returns the server's operating system name.

Returns:

A String specifying the server's operating system name.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getCPU

java.lang.String getCPU()
                        throws SDKException

Returns the name of the host hardware processor.

Returns:

A String specifying the name of the host hardware processor.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getCPUCount

int getCPUCount()
                throws SDKException

Returns the number of processors in the server host.

Returns:

An int specifying the number of processors in the server host.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getMemory

long getMemory()
               throws SDKException

Returns the maximum memory available in KB.

Returns:

A long specifying the maximum memory available in KB.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getDiskSpaceTotal

double getDiskSpaceTotal()
                         throws SDKException

Returns the total disk space available on the host.

Returns:

A double specifying the total disk space available on the host.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getDiskSpaceAvailable

double getDiskSpaceAvailable()
                             throws SDKException

Returns the available disk space on the host.

Returns:

A double specifying the available disk space on the host.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getStartTime

java.util.Date getStartTime()
                            throws SDKException

Returns the time that the server was started.

Returns:

A Date object specifying the time that the server was started.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getCurrentTime

java.util.Date getCurrentTime()
                              throws SDKException

Returns the local time on the server host.

Returns:

A Date object specifying the local time on the server host.

Throws:

SDKException - This is thrown if the process is unsuccessful.