Class CLI

java.lang.Object

org.dogtagpki.cli.CLI

Direct Known Subclasses:

ACMECLI, ActivityCLI, AuditCLI, AuthenticatorCLI, AuthorityCLI, CACertCLI, CACertRequestCLI, CACRLCLI, ClientCLI, CommandCLI, ConfigCLI, ConnectorCLI, FeatureCLI, GroupCLI, GroupMemberCLI, JobCLI, KRACertCLI, KRAConnectorCLI, KRAKeyCLI, MainCLI, NSSCertCLI, NSSCLI, NSSKeyCLI, OCSPCertCLI, PKCS11CertCLI, PKCS11CLI, PKCS11KeyCLI, PKCS12CertCLI, PKCS12CLI, PKCS12KeyCLI, PKCS7CertCLI, PKCS7CLI, PKIServerCLI, ProfileCLI, ProfileCLI, ProfileMappingCLI, PublisherCLI, PublisherOCSPCLI, RangeCLI, SDCLI, SDCLI, SDSubsystemCLI, SDTypeCLI, SecurityDomainCLI, SecurityDomainHostCLI, SelfTestCLI, SubsystemACLCLI, SubsystemCLI, SubsystemDBAccessCLI, SubsystemDBCLI, SubsystemDBIndexCLI, SubsystemDBReplicationAgreementCLI, SubsystemDBReplicationCLI, SubsystemDBVLVCLI, SubsystemGroupCLI, SubsystemGroupMemberCLI, SubsystemUserCertCLI, SubsystemUserCLI, SubsystemUserRoleCLI, TKSCertCLI, TKSKeyCLI, TokenCLI, TPSCertCLI, TPSConnectorCLI, UserCertCLI, UserCLI, UserMembershipCLI

public class CLI
extends Object

Author:

Endi S. Dewata

Field Summary

Fields

Modifier and Type	Field	Description
String	description
boolean	exitOnError
static org.apache.commons.cli.HelpFormatter	formatter
static org.slf4j.Logger	logger
Map<String, CLIModule>	modules
String	name
org.apache.commons.cli.Options	options
CLI	parent
static org.apache.commons.cli.CommandLineParser	parser
static boolean	verbose

Constructor Summary

Constructors

Constructor	Description
CLI(String name, String description)
CLI(String name, String description, CLI parent)

Method Summary

Modifier and Type	Method	Description
void	addModule(String name, String className)
void	addModule(CLI cli)
void	createOptions()
void	execute(String[] args)
void	executeCommand(String[] args)
void	executeCommands(BufferedReader in, boolean shell)
CLIModule	findModule(String command)	Find the last module that handles the specified command.
List<CLIModule>	findModules(String command)	Find the list of modules that handle the specified command.
ClientConfig	getConfig()
String	getDescription()
String	getFullModuleName(String moduleName)
String	getFullName()
String	getManPage()
CLIModule	getModule(String name)
Collection<CLIModule>	getModules()
String	getName()
CLI	getParent()
CLI	getRoot()
void	handleException(Throwable t)
boolean	isDeprecated()
String[]	parseLine(String line)	Parse a command line into an array of tokens.
org.apache.commons.cli.CommandLine	parseOptions(String[] args)
void	printHelp()
void	printVersion()
CLIModule	removeModule(String name)
void	runExternal(String[] command)
void	runExternal(List<String> command)
void	setDescription(String description)
void	setName(String name)

Methods inherited from class Object

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

Field Details

logger

public static org.slf4j.Logger logger

verbose

public static boolean verbose

parser

public static org.apache.commons.cli.CommandLineParser parser

formatter

public static org.apache.commons.cli.HelpFormatter formatter

name

public String name

description

public String description

parent

public CLI parent

options

public org.apache.commons.cli.Options options

modules

public Map<String, CLIModule> modules

exitOnError

public boolean exitOnError

Constructor Details

CLI

public CLI(String name,
 String description)

CLI

public CLI(String name,
 String description,
 CLI parent)

Method Details

getName

public String getName()

setName

public void setName(String name)

getFullName

public String getFullName()

getFullModuleName

public String getFullModuleName(String moduleName)

getDescription

public String getDescription()

setDescription

public void setDescription(String description)

getParent

public CLI getParent()

getRoot

public CLI getRoot()

isDeprecated

public boolean isDeprecated()

getModules

public Collection<CLIModule> getModules()

getModule

public CLIModule getModule(String name)

addModule

public void addModule(CLI cli)

addModule

public void addModule(String name,
 String className)

removeModule

public CLIModule removeModule(String name)

findModules

public List<CLIModule> findModules(String command)
                            throws Exception

Find the list of modules that handle the specified command.

Throws:

Exception

findModule

public CLIModule findModule(String command)
                     throws Exception

Find the last module that handles the specified command.

Throws:

Exception

getManPage

public String getManPage()

getConfig

public ClientConfig getConfig()
                       throws Exception

Throws:

Exception

createOptions

public void createOptions()
                   throws Exception

Throws:

Exception

parseOptions

public org.apache.commons.cli.CommandLine parseOptions(String[] args)
                                                throws Exception

Throws:

Exception

printVersion

public void printVersion()

printHelp

public void printHelp()
               throws Exception

Throws:

Exception

parseLine

public String[] parseLine(String line)
                   throws Exception

Parse a command line into an array of tokens. For example: nss-cert-request --subject "CN=Certificate Authority" should be parsed into: ["nss-cert-request", "--subject", "CN=Certificate Authority"]

Throws:

Exception

handleException

public void handleException(Throwable t)

executeCommand

public void executeCommand(String[] args)
                    throws Exception

Throws:

Exception

executeCommands

public void executeCommands(BufferedReader in,
 boolean shell)
                     throws Exception

Throws:

Exception

execute

public void execute(String[] args)
             throws Exception

Throws:

Exception

runExternal

public void runExternal(List<String> command)
                 throws CLIException,
IOException,
InterruptedException

Throws:

CLIException

IOException

InterruptedException

runExternal

public void runExternal(String[] command)
                 throws CLIException,
IOException,
InterruptedException

Throws:

CLIException

IOException

InterruptedException