com.netrics.likeit

Class NetricsServerStats

java.lang.Object

com.netrics.likeit.NetricsServerStats

All Implemented Interfaces:

java.io.Serializable

public class NetricsServerStats
extends java.lang.Object
implements java.io.Serializable

This class contains status information on the server process.

The server will return information on itself, including such things as its product name, version number and enabled features. An object of this class holds a complete report on this server status information returned by the server.

Objects of this class are generated as the results of a NetricsServerInterface.svr_info call, they can not be created directly.

See Also:

NetricsServerInterface.server_info(), Serialized Form

Constructor Summary

Constructors

Constructor and Description
NetricsServerStats() To keep Java happy, never use this constructor

Method Summary

Methods

Modifier and Type	Method and Description
boolean	autorestore() Return whether auto-restore feature is enabled.
java.lang.String	build_date() Return the build date of the server.
java.lang.String	checkpoint_dir() Return the directory used for checkpoint/restore.
java.lang.String	devkit_info() Return the Devkit Build Information.
java.lang.String	gateway_cfg() Return the gateway configuration file name.
boolean	gip_enabled() Return true if GIP prefilter is enabled.
boolean	learn_engine() Return true if this engine support Learn features.
int	max_threads() Return maximum number of worker threads.
int	maxmem_kb() Return memory limit for table data.
int	port() Return the listen port for the server.
java.lang.String	product_name() Return the official product name.
boolean	psi_enabled() Return true if PSI prefilter is enabled.
java.lang.String	server_info() Return the server status string.
boolean	sort_enabled() Return true if Sort prefilter is enabled.
java.lang.String	toString() Return report as a string.
java.lang.String	version() Return the release version.
java.lang.String	who_built() Return who built the server.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

NetricsServerStats

public NetricsServerStats()

To keep Java happy, never use this constructor

Method Detail

toString

public java.lang.String toString()

Return report as a string. This formats the report into a six line human readable report.

Overrides:

toString in class java.lang.Object

Returns:

human readable report as a string.

devkit_info

public java.lang.String devkit_info()

Return the Devkit Build Information. This returns the raw Devkit build and configuration string, the special value "(unknown)" if no Devkit information was received.

server_info

public java.lang.String server_info()

Return the server status string. Returns the raw server status string, the special value "(unknown)" if no Server information was received. The server status string is an XML snippet of the form:
<server_info>
<product_name>product name string</product_name>
<version>full version number</version>
<build_date>date of build</build_date>
<who_built>ID of who ran build</who_built>


product_name

public java.lang.String product_name()

Return the official product name. Returns the official product name for the server, the special value "(unknown)" if no product name was received.

version

public java.lang.String version()

Return the release version. Returns the full 3 digit release version of the server, the special value "(unknown)" if no version info was received.

build_date

public java.lang.String build_date()

Return the build date of the server. Returns the time and date the server was built in the default date(1) format for the platform, the special value "(unknown)" if no build date information was received.

who_built

public java.lang.String who_built()

Return who built the server. Returns the login ID of who ran the build of this server, the special value "(unknown)" if no who built information was received.

port

public int port()

Return the listen port for the server. This returns the port number the server is listening on, the special value -1 indicates no port number information was received.

max_threads

public int max_threads()

Return maximum number of worker threads. This returns the maximum number of simultaneous command processing threads this server will employ, the special value -1 indicates no thread limit information was received.

checkpoint_dir

public java.lang.String checkpoint_dir()

Return the directory used for checkpoint/restore. Returns the directory used to hold checkpointed tables. The special value "Not Enabled" is returned if checkpointing is not enabled on this server. The special value "(unknown)" is returned if no directory information was received.

autorestore

public boolean autorestore()

Return whether auto-restore feature is enabled. If the server was started with auto-restore feature this is true, if no information was received or the server was not started with auto-restore this returns false.

gateway_cfg

public java.lang.String gateway_cfg()

Return the gateway configuration file name. Returns the name of the file holding the gateway configuration. The special value "Not a Gateway" is returned if this server is not acting as a gateway. The special value "(unknown)" is returned if no gateway information was received.

maxmem_kb

public int maxmem_kb()

Return memory limit for table data. This returns the combined memory limit for all tables. The value is given in Kilo-Bytes. This is a combined limit for all tables, not an individual table limit. Once this limit is reached attempts to add data to tables will receive a MEMORY_EXCEEDED error. The value 0 indicates there is no limit, the server will continue to allocate memory until the process limit is exceeded, at which point it will abort. The special value -1 indicates no memory limit information was returned.

gip_enabled

public boolean gip_enabled()

Return true if GIP prefilter is enabled. If use of the GIP prefilter is supported this returns true, if no information was received on the GIP status, or the GIP prefilter is not enabled this returns false.

sort_enabled

public boolean sort_enabled()

Return true if Sort prefilter is enabled. If use of the Sort prefilter is supported this returns true, if no information was received on the Sort status, or the Sort prefilter is not enabled this returns false.

psi_enabled

public boolean psi_enabled()

Return true if PSI prefilter is enabled. If use of the PSI prefilter is supported this returns true, if no information was received on the PSI status, or the PSI prefilter is not enabled this returns false.

learn_engine

public boolean learn_engine()

Return true if this engine support Learn features. If use of the Learn features are supported this returns true, if no information was received on the learn status, or Learn is not enabled this returns false.