com.magnicomp.sysinfo.v2

Class SysInfo

java.lang.Object

com.magnicomp.sysinfo.v2.core.SysInfoCore2

com.magnicomp.sysinfo.v2.SysInfo

public class SysInfo
extends SysInfoCore2

SysInfo API version 2 main class. This class is the primary class interface for customer's to access SysInfo data.

Field Summary

Fields inherited from class com.magnicomp.sysinfo.v2.core.SysInfoCore2

accounts, appname, appurl, appvendor, appvendorurl, appversion, bios, createtime, createtimenum, devInfos, dhcps, encversion, general, jobs, kernelVars, licenses, mntInfos, netIves, network, partInfos, patches, printers, processes, services, siteInfos, softInfos, sourcehost, storSys, storVols, totaldisk, vmGuests, vmHost

Constructor Summary

Constructors

Constructor and Description
SysInfo() Create a new SysInfo object.
SysInfo(java.lang.String sysInfoDirectory) Create a SysInfo object and set the top level SysInfo directory to be sysInfoDirectory.
SysInfo(java.lang.String sysInfoDirectory, java.util.List<java.lang.String> cmdArgs) Create a SysInfo object and set the top level SysInfo directory to be sysInfoDirectory and the command arguments to run SysInfo to be cmdArgs.
SysInfo(java.lang.String sysInfoDirectory, java.lang.String clientName) Create a SysInfo object and set the top level SysInfo directory or the client to connect to.
SysInfo(java.lang.String sysInfoDirectory, java.lang.String clientName, java.util.List<java.lang.String> cmdArgs) Create a SysInfo object and set the top level SysInfo directory to be sysInfoDirectory and the command arguments to run SysInfo to be cmdArgs.

Method Summary

Modifier and Type	Method and Description
SysInfoCore2	get() Get SysInfo data.
SysInfoCore2	get(java.util.List<java.lang.String> sysInfoCmdArgs) Get SysInfo data.
java.lang.String	getClientName() Get the hostname of the client to retrieve SysInfo data from.
java.util.List<java.lang.String>	getCmd() Get the SysInfo command used to run SysInfo.
java.lang.String	getDataClasses() Get a string separated list of currently set SysInfo Data Classes.
boolean	getDebug() Return true if debugging is enabled or false if not.
SysInfoCore2	getFromFile(java.lang.String sysInfoXmlFile) Get SysInfo data from a SysInfo XML file.
SysInfoCore2	getLocal() Get SysInfo data from the local system.
SysInfoCore2	getRemote() Get SysInfo data from the the remote system specified by clientName (see setClientName()).
java.lang.String	getSysInfoDir() Get the top-level SysInfo directory.
java.lang.String	getSysInfoDirDefault() Get the default top-level directory where SysInfo is installed.
boolean	isValidClassName(java.lang.String name) Determine if name is a valid SysInfo Data Class name.
void	setClientName(java.lang.String hostName) Set the hostname of the client to retrieve SysInfo data from
void	setCmdOptions(java.util.List<java.lang.String> cmdArgs) Set the command options to specify to SysInfo when it is run.
void	setDataClasses(java.lang.String classes) Set the data classes to retrieve to be the names given in classes.
void	setDebug(boolean enabled) Enable or disable debugging.
void	setSysInfoDir(java.lang.String sysInfoDirectory) Set the top level directory containing SysInfo to be sysInfoDirectory.

Methods inherited from class com.magnicomp.sysinfo.v2.core.SysInfoCore2

getAccounts, getAppname, getAppurl, getAppvendor, getAppvendorurl, getAppversion, getBios, getCreatetime, getCreatetimenum, getDevInfos, getDhcps, getEncversion, getGeneral, getJobs, getKernelVars, getLicenses, getMntInfos, getNetIves, getNetwork, getPartInfos, getPatches, getPrinters, getProcesses, getServices, getSiteInfos, getSoftInfos, getSourcehost, getStorSys, getStorVols, getTotaldisk, getVmGuests, getVmHost, setAppname, setAppurl, setAppvendor, setAppvendorurl, setAppversion, setCreatetime, setCreatetimenum, setEncversion, setGeneral, setNetwork, setSourcehost, setTotaldisk, setVmHost

Methods inherited from class java.lang.Object

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

Constructor Detail

SysInfo

public SysInfo()
        throws com.magnicomp.sysinfo.common.SysInfoException

Create a new SysInfo object. If caller wants to call get() method then caller must first set the SysInfo top-level directory via the setSysInfoDir() method.

Throws:

com.magnicomp.sysinfo.common.SysInfoException

SysInfo

public SysInfo(java.lang.String sysInfoDirectory)
        throws com.magnicomp.sysinfo.common.SysInfoException

Create a SysInfo object and set the top level SysInfo directory to be sysInfoDirectory.

Parameters:

sysInfoDirectory -

Throws:

com.magnicomp.sysinfo.common.SysInfoException

SysInfo

public SysInfo(java.lang.String sysInfoDirectory,
               java.lang.String clientName)
        throws com.magnicomp.sysinfo.common.SysInfoException

Create a SysInfo object and set the top level SysInfo directory or the client to connect to. If clientName is given, the sysInfoDirectory argument is ignored.

Parameters:

sysInfoDirectory -

clientName -

Throws:

com.magnicomp.sysinfo.common.SysInfoException

SysInfo

public SysInfo(java.lang.String sysInfoDirectory,
               java.util.List<java.lang.String> cmdArgs)
        throws com.magnicomp.sysinfo.common.SysInfoException

Create a SysInfo object and set the top level SysInfo directory to be sysInfoDirectory and the command arguments to run SysInfo to be cmdArgs.

Parameters:

sysInfoDirectory -

cmdArgs -

Throws:

com.magnicomp.sysinfo.common.SysInfoException

SysInfo

public SysInfo(java.lang.String sysInfoDirectory,
               java.lang.String clientName,
               java.util.List<java.lang.String> cmdArgs)
        throws com.magnicomp.sysinfo.common.SysInfoException

Create a SysInfo object and set the top level SysInfo directory to be sysInfoDirectory and the command arguments to run SysInfo to be cmdArgs. If clientName is given then set the hostname of the system to retrieve SysInfo data from to be clientName and ignore the sysInfoDirectory argument.

Parameters:

sysInfoDirectory -

clientName -

cmdArgs -

Throws:

com.magnicomp.sysinfo.common.SysInfoException

Method Detail

setDebug

public void setDebug(boolean enabled)

Enable or disable debugging. When debugging is enabled, debug messages are displayed on stderr output.

Parameters:

enabled -

getDebug

public boolean getDebug()

Return true if debugging is enabled or false if not.

Returns:

boolean

setSysInfoDir

public void setSysInfoDir(java.lang.String sysInfoDirectory)
                   throws com.magnicomp.sysinfo.common.SysInfoException

Set the top level directory containing SysInfo to be sysInfoDirectory.

Parameters:

sysInfoDirectory -

Throws:

com.magnicomp.sysinfo.common.SysInfoException

getSysInfoDir

public java.lang.String getSysInfoDir()

Get the top-level SysInfo directory. Must call setSysInfoDir() prior to calling this method.

Returns:

SysInfoDir

getSysInfoDirDefault

public java.lang.String getSysInfoDirDefault()

Get the default top-level directory where SysInfo is installed. This value is used when the caller does not specify a sysInfoDir value when creating a SysInfo object or via setSysInfoDir().

Returns:

SysInfoDirDefault

setClientName

public void setClientName(java.lang.String hostName)
                   throws com.magnicomp.sysinfo.common.SysInfoException

Set the hostname of the client to retrieve SysInfo data from

Parameters:

hostName - Hostname of client to retrieve data from.

Throws:

com.magnicomp.sysinfo.common.SysInfoException

getClientName

public java.lang.String getClientName()

Get the hostname of the client to retrieve SysInfo data from.

Returns:

hostName

setCmdOptions

public void setCmdOptions(java.util.List<java.lang.String> cmdArgs)
                   throws com.magnicomp.sysinfo.common.SysInfoException

Set the command options to specify to SysInfo when it is run. Most options are not validated until the SysInfo command is run.

Parameters:

cmdArgs -

Throws:

com.magnicomp.sysinfo.common.SysInfoException

getCmd

public java.util.List<java.lang.String> getCmd()

Get the SysInfo command used to run SysInfo. Returns a full List<String> of all arguments. The first member of the returned List is the pathname to SysInfo itself.

Returns:

List<String>

getFromFile

public SysInfoCore2 getFromFile(java.lang.String sysInfoXmlFile)
                         throws com.magnicomp.sysinfo.common.SysInfoException

Get SysInfo data from a SysInfo XML file. Returns a SysInfoCore2 object for the data contained in the file.

Parameters:

sysInfoXmlFile -

Returns:

SysInfoCore2

Throws:

com.magnicomp.sysinfo.common.SysInfoException

get

public SysInfoCore2 get()
                 throws com.magnicomp.sysinfo.common.SysInfoException

Get SysInfo data. This method is a front-end to getLocal() and getRemote() methods. If a clientName is set then the getRemote() method is called. If sysInfoDir is set, then the getLocal() method is called. Otherwise a SysInfoException is thrown.

Returns:

SysInfoCore2

Throws:

com.magnicomp.sysinfo.common.SysInfoException

getLocal

public SysInfoCore2 getLocal()
                      throws com.magnicomp.sysinfo.common.SysInfoException

Get SysInfo data from the local system. This method runs the SysInfo command with the optional options specified when this class was created or via setCmdOptions(). The resulting data is returned as a seperate SysInfoCore2 class object.

Returns:

SysInfoCore2

Throws:

com.magnicomp.sysinfo.common.SysInfoException

getRemote

public SysInfoCore2 getRemote()
                       throws com.magnicomp.sysinfo.common.SysInfoException

Get SysInfo data from the the remote system specified by clientName (see setClientName()). The resulting data is returned as a seperate SysInfoCore2 class object.

Returns:

SysInfoCore2

Throws:

com.magnicomp.sysinfo.common.SysInfoException

java.net.UnknownHostException

get

public SysInfoCore2 get(java.util.List<java.lang.String> sysInfoCmdArgs)
                 throws com.magnicomp.sysinfo.common.SysInfoException

Get SysInfo data. This method calls get() but accepts a List of SysInfo command arguments to pass to SysInfo. It's equivalent to "new SysInfo(..., CmdArgs)" and to "setCmdOptions(...)" followed by a call to "run()".

Parameters:

sysInfoCmdArgs -

Returns:

SysInfoCre2

Throws:

com.magnicomp.sysinfo.common.SysInfoException

isValidClassName

public boolean isValidClassName(java.lang.String name)

Determine if name is a valid SysInfo Data Class name.

Parameters:

name -

Returns:

Boolean if name is a valid SysInfo data class

setDataClasses

public void setDataClasses(java.lang.String classes)
                    throws com.magnicomp.sysinfo.common.SysInfoException

Set the data classes to retrieve to be the names given in classes. Each class name should be separated by a comma.

Parameters:

classes -

Throws:

com.magnicomp.sysinfo.common.SysInfoException

getDataClasses

public java.lang.String getDataClasses()

Get a string separated list of currently set SysInfo Data Classes.

Returns:

classStr