Package edu.uiuc.ncsa.security.util.cli

Interface Commands

All Superinterfaces:

Logable, Serializable

All Known Implementing Classes:

AbstractCommandsImpl, CommonCommands, CommonCommands2, ConfigurableCommandsImpl, ConfigurableCommandsImpl2, SASCLIDriver.DC, SASCommands, StoreCommands, StoreCommands2, TestCCI, TestCCI.CCIComponent, TestCommands

public interface Commands
extends Logable, Serializable

All sets of commands implement this interface. Each command you want to have found in the interface should fulfill the following contract;

• signature requirement: public void name(InputLine
• help requirement a protected method, suggested name is "showXHelp" where "X" is the name of the method above

This means that if a user asks for help, the methods with the right signature will be displayed by the driver. All you need to do is implement the functionality. The method is called by reflection on the name and is passed whatever arguments are supplied by the user, parsed into a InputLine.

There is no limit to the number or type of command that you may have here.

Creation date: (10/11/02 8:26:14 pm)

Author:

Jeff Gaynor

Method Summary

Modifier and Type	Method	Description
InputLine	bootstrap(InputLine inputLine)
CLIDriver	getDriver()	Back reference to the driver that manages this instance.
IOInterface	getIOInterface()
String	getName()
String	getPrompt()	The prompt displayed to the user.
void	setDriver(CLIDriver driver)

Methods inherited from interface edu.uiuc.ncsa.security.core.Logable

debug, error, info, isDebugOn, setDebugOn, warn

Method Detail

getPrompt

String getPrompt()

The prompt displayed to the user. This allows it to change based on context.

Returns:

java.lang.String

bootstrap

InputLine bootstrap(InputLine inputLine)
             throws Throwable

Throws:

Throwable

getIOInterface

IOInterface getIOInterface()

getName

String getName()

getDriver

CLIDriver getDriver()

Back reference to the driver that manages this instance.

Returns:

setDriver

void setDriver(CLIDriver driver)