sfi.director.cli.CLICommand Class Reference

Inheritance diagram for sfi.director.cli.CLICommand:

List of all members.

---

Detailed Description

Every CLI command must implement the CLICommand interface.

Public Member Functions
abstract void	run (Hashtable optargs) throws DirectorException
	run the command with the (pre-parsed) options optargs
abstract String	usage ()
	return a one-line usage string
abstract String	help ()
	return a more verbose usage string (aka.
abstract String[]	getOptDefinitions ()
	return option definitions as used by Tools.getOpt()
void	setOptions (Hashtable opts)
	sets options from a hash as returned by Tools.getOpts().
Options	getOptions ()
Hashtable	getOptionsHash ()

---

Member Function Documentation

abstract String [] sfi.director.cli.CLICommand.getOptDefinitions (   )  [pure virtual]

return option definitions as used by Tools.getOpt() Implemented in sfi.director.cli.agent, sfi.director.cli.app_dist, sfi.director.cli.app_extract, sfi.director.cli.app_freeze, sfi.director.cli.app_import, sfi.director.cli.app_subscribe, sfi.director.cli.archive, sfi.director.cli.build, sfi.director.cli.copy, sfi.director.cli.create, sfi.director.cli.debug, sfi.director.cli.delete, sfi.director.cli.docclean, sfi.director.cli.docrefetch, sfi.director.cli.docu, sfi.director.cli.event, sfi.director.cli.frinterface, sfi.director.cli.help, sfi.director.cli.init, sfi.director.cli.list, sfi.director.cli.listconfig, sfi.director.cli.listdirectories, sfi.director.cli.listevents, sfi.director.cli.mkdepend, sfi.director.cli.modify, sfi.director.cli.monitor, sfi.director.cli.passwd, sfi.director.cli.queuestat, sfi.director.cli.queueworker, sfi.director.cli.replay, sfi.director.cli.restoreconfig, sfi.director.cli.saveconfig, sfi.director.cli.schema, sfi.director.cli.serverstatus, sfi.director.cli.setguipasswd, sfi.director.cli.shutdown, sfi.director.cli.storepassword, sfi.director.cli.sysinfo, sfi.director.cli.test, and sfi.director.cli.version.

Options sfi.director.cli.CLICommand.getOptions (   )

Hashtable sfi.director.cli.CLICommand.getOptionsHash (   )

abstract String sfi.director.cli.CLICommand.help (   )  [pure virtual]

return a more verbose usage string (aka. help) Implemented in sfi.director.cli.agent, sfi.director.cli.app_dist, sfi.director.cli.app_extract, sfi.director.cli.app_freeze, sfi.director.cli.app_import, sfi.director.cli.app_subscribe, sfi.director.cli.archive, sfi.director.cli.build, sfi.director.cli.copy, sfi.director.cli.create, sfi.director.cli.debug, sfi.director.cli.delete, sfi.director.cli.docclean, sfi.director.cli.docrefetch, sfi.director.cli.docu, sfi.director.cli.event, sfi.director.cli.frinterface, sfi.director.cli.help, sfi.director.cli.init, sfi.director.cli.list, sfi.director.cli.listconfig, sfi.director.cli.listdirectories, sfi.director.cli.listevents, sfi.director.cli.mkdepend, sfi.director.cli.modify, sfi.director.cli.monitor, sfi.director.cli.passwd, sfi.director.cli.queuestat, sfi.director.cli.queueworker, sfi.director.cli.replay, sfi.director.cli.restoreconfig, sfi.director.cli.saveconfig, sfi.director.cli.schema, sfi.director.cli.serverstatus, sfi.director.cli.setguipasswd, sfi.director.cli.shutdown, sfi.director.cli.storepassword, sfi.director.cli.sysinfo, sfi.director.cli.test, and sfi.director.cli.version.

abstract void sfi.director.cli.CLICommand.run (  Hashtable  optargs  )  throws DirectorException [pure virtual]

run the command with the (pre-parsed) options optargs Implemented in sfi.director.cli.agent, sfi.director.cli.app_dist, sfi.director.cli.app_extract, sfi.director.cli.app_freeze, sfi.director.cli.app_import, sfi.director.cli.app_subscribe, sfi.director.cli.archive, sfi.director.cli.build, sfi.director.cli.copy, sfi.director.cli.create, sfi.director.cli.debug, sfi.director.cli.delete, sfi.director.cli.docclean, sfi.director.cli.docrefetch, sfi.director.cli.docu, sfi.director.cli.event, sfi.director.cli.frinterface, sfi.director.cli.help, sfi.director.cli.init, sfi.director.cli.list, sfi.director.cli.listconfig, sfi.director.cli.listdirectories, sfi.director.cli.listevents, sfi.director.cli.mkdepend, sfi.director.cli.modify, sfi.director.cli.monitor, sfi.director.cli.passwd, sfi.director.cli.queuestat, sfi.director.cli.queueworker, sfi.director.cli.replay, sfi.director.cli.restoreconfig, sfi.director.cli.saveconfig, sfi.director.cli.schema, sfi.director.cli.serverstatus, sfi.director.cli.setguipasswd, sfi.director.cli.shutdown, sfi.director.cli.storepassword, sfi.director.cli.sysinfo, sfi.director.cli.test, and sfi.director.cli.version.

void sfi.director.cli.CLICommand.setOptions (  Hashtable  opts  )

sets options from a hash as returned by Tools.getOpts().

abstract String sfi.director.cli.CLICommand.usage (   )  [pure virtual]

return a one-line usage string Implemented in sfi.director.cli.agent, sfi.director.cli.app_dist, sfi.director.cli.app_extract, sfi.director.cli.app_freeze, sfi.director.cli.app_import, sfi.director.cli.app_subscribe, sfi.director.cli.archive, sfi.director.cli.build, sfi.director.cli.copy, sfi.director.cli.create, sfi.director.cli.debug, sfi.director.cli.delete, sfi.director.cli.docclean, sfi.director.cli.docrefetch, sfi.director.cli.docu, sfi.director.cli.event, sfi.director.cli.frinterface, sfi.director.cli.help, sfi.director.cli.init, sfi.director.cli.list, sfi.director.cli.listconfig, sfi.director.cli.listdirectories, sfi.director.cli.listevents, sfi.director.cli.mkdepend, sfi.director.cli.modify, sfi.director.cli.monitor, sfi.director.cli.passwd, sfi.director.cli.queuestat, sfi.director.cli.queueworker, sfi.director.cli.replay, sfi.director.cli.restoreconfig, sfi.director.cli.saveconfig, sfi.director.cli.schema, sfi.director.cli.serverstatus, sfi.director.cli.setguipasswd, sfi.director.cli.shutdown, sfi.director.cli.storepassword, sfi.director.cli.sysinfo, sfi.director.cli.test, and sfi.director.cli.version.

---

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

• director/cli/CLICommand.java

---