sfi.director.application.autodoc.InfoCollector Class Reference

Handle system information retrieval. More...

Public Member Functions
Options	remoteArguments (String hostname) throws DirectorException
void	setArguments (RemoteJob job) throws DirectorException
void	push (InputStream store) throws DirectorException
	InfoCollector ()
	InfoCollector (RemoteJob job)
	InfoCollector (Options opts)
void	collectInto (OutputStream store) throws DirectorException
void	copyFile (File file) throws DirectorException
void	copyDir (File file) throws DirectorException
void	addObject (DBObject dbo)
String	getArgument (String name)
	get the value of an argument valid for this run.
Options	options ()
	Accessor for attribute options.
void	remoteJob (RemoteJob remoteJob)
	Set options() from a remote job.
void	setupProxy ()
Options	options (Options opts)
	Mutator for attribute options.
SURL	proxy ()
	Accessor for attribute proxy.
SURL	proxy (SURL proxy)
	Mutator for attribute proxy.
Vector	proxyFor ()
	Accessor for attribute proxyFor.
Vector	proxyFor (Vector proxyFor)
	Mutator for attribute proxyFor.

Static Public Member Functions
static void	remoteArguments (RemoteJob job) throws DirectorException
	Hook for CollectSysinfo Scripttask: Set (optional) arguments on remote job that will be made available to collect().
static void	collect (OutputStream store, RemoteJob job) throws DirectorException
	Hook for CollectSysinfo Scripttask: this procedure is called on remote systems, collects information and writes it to the 'store' file.
static void	push (InputStream store, RemoteJob job) throws DirectorException
	Hook for CollectSysinfo Scripttask: this procedure is called on the master and writes the information stored by collect in 'store' file into the repository.

Static Public Attributes
final static String	FileCandidates = "FileCandidates"

Protected Attributes
Options	options = null
	associated Options.
SURL	proxy = null
	proxy URL if running proxied, otherwise null
Vector	proxyFor = null
	list of names of the target host if running proxied

Detailed Description

Handle system information retrieval.

Constructor & Destructor Documentation

sfi.director.application.autodoc.InfoCollector.InfoCollector

(

)

Referenced by sfi.director.application.autodoc.InfoCollector.collect(), sfi.director.application.autodoc.InfoCollector.push(), and sfi.director.application.autodoc.InfoCollector.remoteArguments().

sfi.director.application.autodoc.InfoCollector.InfoCollector

(

RemoteJob

job

)

References sfi.director.application.autodoc.InfoCollector.remoteJob().

sfi.director.application.autodoc.InfoCollector.InfoCollector

(

Options

opts

)

References sfi.director.application.autodoc.InfoCollector.options().

Member Function Documentation

void sfi.director.application.autodoc.InfoCollector.addObject

(

DBObject

dbo

)

References sfi.director.repository.DBSet.replace().

Referenced by sfi.director.application.autodoc.CollectHandler.addObject().

static void sfi.director.application.autodoc.InfoCollector.collect ( OutputStream  store, RemoteJob  job  ) throws DirectorException

static

Hook for CollectSysinfo Scripttask: this procedure is called on remote systems, collects information and writes it to the 'store' file.

References sfi.director.application.autodoc.InfoCollector.InfoCollector().

Referenced by sfi.director.application.scripttask.CollectSysinfo.fetch().

void sfi.director.application.autodoc.InfoCollector.collectInto

(

OutputStream

store

)

throws DirectorException

References sfi.director.util.Archive.close(), sfi.director.application.autodoc.CollectHandler.collect(), sfi.director.application.autodoc.CollectHandler.collector, sfi.director.repository.DBSet.dump(), sfi.director.application.autodoc.CollectHandler.isWilling(), sfi.director.util.Tools.log(), sfi.director.util.Archive.store(), and sfi.director.util.Logger.WARNING.

Referenced by sfi.director.cli.sysinfo.run().

void sfi.director.application.autodoc.InfoCollector.copyDir

(

File

file

)

throws DirectorException

References sfi.director.application.autodoc.InfoCollector.copyFile(), sfi.director.system.FileStats.isDirectory(), and sfi.director.system.Files.lstat().

Referenced by sfi.director.application.autodoc.InfoCollector.copyFile().

void sfi.director.application.autodoc.InfoCollector.copyFile

(

File

file

)

throws DirectorException

References sfi.director.application.autodoc.InfoCollector.copyDir().

Referenced by sfi.director.application.autodoc.InfoCollector.copyDir(), and sfi.director.application.autodoc.CollectHandler.copyFile().

String sfi.director.application.autodoc.InfoCollector.getArgument

(

String

name

)

get the value of an argument valid for this run.

Usually, arguments are passed on via remoteJob() and thus getArgument() is a wrapper for job arguments.

Returns

argument value or null

References sfi.director.util.Options.getOption(), and sfi.director.application.autodoc.InfoCollector.options().

Referenced by sfi.director.application.autodoc.CollectHandler.getArgument(), and sfi.director.application.autodoc.InfoCollector.push().

Options sfi.director.application.autodoc.InfoCollector.options

(

)

Accessor for attribute options.

associated Options.

Referenced by sfi.director.application.autodoc.InfoCollector.getArgument(), sfi.director.application.autodoc.InfoCollector.InfoCollector(), sfi.director.application.autodoc.InfoCollector.options(), sfi.director.application.autodoc.InfoCollector.remoteJob(), and sfi.director.application.autodoc.InfoCollector.setupProxy().

Options sfi.director.application.autodoc.InfoCollector.options

(

Options

opts

)

Mutator for attribute options.

associated Options.

References sfi.director.application.autodoc.InfoCollector.options(), and sfi.director.application.autodoc.InfoCollector.setupProxy().

SURL sfi.director.application.autodoc.InfoCollector.proxy

(

)

Accessor for attribute proxy.

proxy URL if running proxied, otherwise null

Referenced by sfi.director.application.autodoc.InfoCollector.proxy(), and sfi.director.application.autodoc.InfoCollector.setupProxy().

SURL sfi.director.application.autodoc.InfoCollector.proxy

(

SURL

proxy

)

Mutator for attribute proxy.

proxy URL if running proxied, otherwise null

References sfi.director.application.autodoc.InfoCollector.proxy().

Vector sfi.director.application.autodoc.InfoCollector.proxyFor

(

)

Accessor for attribute proxyFor.

list of names of the target host if running proxied

Referenced by sfi.director.application.autodoc.InfoCollector.proxyFor(), and sfi.director.application.autodoc.InfoCollector.setupProxy().

Vector sfi.director.application.autodoc.InfoCollector.proxyFor

(

Vector

proxyFor

)

Mutator for attribute proxyFor.

list of names of the target host if running proxied

References sfi.director.application.autodoc.InfoCollector.proxyFor().

static void sfi.director.application.autodoc.InfoCollector.push ( InputStream  store, RemoteJob  job  ) throws DirectorException

static

Hook for CollectSysinfo Scripttask: this procedure is called on the master and writes the information stored by collect in 'store' file into the repository.

References sfi.director.application.autodoc.InfoCollector.InfoCollector().

Referenced by sfi.director.cli.sysinfo.infoImport(), and sfi.director.application.scripttask.CollectSysinfo.push().

void sfi.director.application.autodoc.InfoCollector.push

(

InputStream

store

)

throws DirectorException

References sfi.director.repository.DBObject.clone(), sfi.director.repository.DN.clone(), sfi.director.util.Archive.close(), sfi.director.repository.DBObject.completeDN(), sfi.director.util.TempFile.create(), sfi.director.repository.DBSet.elementsVector(), sfi.director.util.Archive.extract(), sfi.director.application.autodoc.ConfigFile.fileRoot, sfi.director.repository.DBSet.get(), sfi.director.repository.config.DirectoryAccess.get(), sfi.director.application.autodoc.InfoCollector.getArgument(), sfi.director.repository.DBObject.getDN(), sfi.director.repository.DBObject.getValue(), sfi.director.util.Setup.hostsdb, sfi.director.util.Setup.hostsdir, sfi.director.repository.DBObject.isMember(), sfi.director.util.Tools.md5sum(), sfi.director.util.Archive.nextFileName(), sfi.director.util.Tools.readEntire(), sfi.director.repository.DBConnection.remove(), sfi.director.repository.DBConnection.replace(), sfi.director.application.autodoc.ConfigFile.rotate(), sfi.director.repository.DBConnection.search(), sfi.director.repository.DN.strip(), and sfi.director.repository.DBConnection.unwrap().

static void sfi.director.application.autodoc.InfoCollector.remoteArguments ( RemoteJob  job ) throws DirectorException

static

Hook for CollectSysinfo Scripttask: Set (optional) arguments on remote job that will be made available to collect().

References sfi.director.application.autodoc.InfoCollector.InfoCollector().

Referenced by sfi.director.application.scripttask.CollectSysinfo.create(), sfi.director.cli.sysinfo.genCmdline(), and sfi.director.application.autodoc.InfoCollector.setArguments().

Options sfi.director.application.autodoc.InfoCollector.remoteArguments

(

String

hostname

)

throws DirectorException

References sfi.director.application.autodoc.DocInfo.configFileSpecs(), sfi.director.application.autodoc.InfoCollector.FileCandidates, sfi.director.repository.config.DirectoryAccess.get(), sfi.director.util.Setup.hostsdir, and sfi.director.util.Options.setOption().

void sfi.director.application.autodoc.InfoCollector.remoteJob

(

RemoteJob

remoteJob

)

Set options() from a remote job.

associated Options.

References sfi.director.jobs.RemoteJob.argumentsAsOptions(), sfi.director.application.autodoc.InfoCollector.options(), and sfi.director.application.autodoc.InfoCollector.setupProxy().

Referenced by sfi.director.application.autodoc.InfoCollector.InfoCollector().

void sfi.director.application.autodoc.InfoCollector.setArguments

(

RemoteJob

job

)

throws DirectorException

References sfi.director.application.autodoc.InfoCollector.remoteArguments().

void sfi.director.application.autodoc.InfoCollector.setupProxy

(

)

References sfi.director.util.Options.getOption(), sfi.director.application.autodoc.InfoCollector.options(), sfi.director.application.autodoc.InfoCollector.proxy(), sfi.director.application.autodoc.InfoCollector.proxyFor(), and sfi.director.util.Tools.split().

Referenced by sfi.director.application.autodoc.InfoCollector.options(), and sfi.director.application.autodoc.InfoCollector.remoteJob().

Member Data Documentation

final static String sfi.director.application.autodoc.InfoCollector.FileCandidates = "FileCandidates"

static

Referenced by sfi.director.application.autodoc.CollectConfigFiles.collect(), and sfi.director.application.autodoc.InfoCollector.remoteArguments().

Options sfi.director.application.autodoc.InfoCollector.options = null

protected

associated Options.

SURL sfi.director.application.autodoc.InfoCollector.proxy = null

protected

proxy URL if running proxied, otherwise null

Referenced by sfi.director.application.autodoc.CollectWinProxy.isWilling(), and sfi.director.application.autodoc.CollectWinProxy.wmiData().

Vector sfi.director.application.autodoc.InfoCollector.proxyFor = null

protected

list of names of the target host if running proxied

Referenced by sfi.director.application.autodoc.CollectWinProxy.wmiData().

---

The documentation for this class was generated from the following file:

• director/src/sfi/director/application/autodoc/InfoCollector.java