Class CLI

java.lang.Object

org.dogtagpki.cli.CLI

Direct Known Subclasses:

ACMECLI, ActivityCLI, AuditCLI, AuthenticatorCLI, AuthorityCLI, CACertCLI, CACertRequestCLI, ClientCLI, CommandCLI, ConfigCLI, ConnectorCLI, FeatureCLI, GroupCLI, GroupMemberCLI, KRACertCLI, KRAConnectorCLI, KRAKeyCLI, MainCLI, NSSCertCLI, NSSCLI, NSSKeyCLI, PKCS11CertCLI, PKCS11CLI, PKCS11KeyCLI, PKCS12CertCLI, PKCS12CLI, PKCS12KeyCLI, PKCS7CertCLI, PKCS7CLI, PKIServerCLI, ProfileCLI, ProfileCLI, ProfileMappingCLI, ProxyCLI, PublisherCLI, PublisherOCSPCLI, RangeCLI, SDCLI, SDHostCLI, SecurityDomainCLI, SecurityDomainHostCLI, SelfTestCLI, SubsystemCLI, SubsystemDBCLI, SubsystemDBVLVCLI, SubsystemGroupCLI, SubsystemGroupMemberCLI, SubsystemRangeCLI, SubsystemUserCertCLI, SubsystemUserCLI, 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
PKIClient	client
String	description
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	execute(String[] args)
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.
PKIClient	getClient()
Object	getClient(String name)
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()
boolean	isDeprecated()
void	printHelp()
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 java.lang.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

client

public PKIClient client

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

getClient

public PKIClient getClient()
                    throws Exception

Throws:

Exception

getClient

public Object getClient(String name)
                 throws Exception

Throws:

Exception

printHelp

public void printHelp()
               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