com.netscape.cmstools.cli

Class CLI

java.lang.Object

com.netscape.cmstools.cli.CLI

Direct Known Subclasses:

ActivityCLI, ActivityFindCLI, ActivityShowCLI, AuditCLI, AuditModifyCLI, AuditShowCLI, AuthenticatorAddCLI, AuthenticatorCLI, AuthenticatorFindCLI, AuthenticatorModifyCLI, AuthenticatorRemoveCLI, AuthenticatorShowCLI, CertCLI, CertFindCLI, CertHoldCLI, CertReleaseHoldCLI, CertRequestFindCLI, CertRequestProfileFindCLI, CertRequestProfileShowCLI, CertRequestReviewCLI, CertRequestShowCLI, CertRequestSubmitCLI, CertRevokeCLI, CertShowCLI, ClientCertFindCLI, ClientCertImportCLI, ClientCertModifyCLI, ClientCertRemoveCLI, ClientCertRequestCLI, ClientCertShowCLI, ClientCLI, ClientInitCLI, ConfigCLI, ConfigModifyCLI, ConfigShowCLI, ConnectorAddCLI, ConnectorCLI, ConnectorFindCLI, ConnectorModifyCLI, ConnectorRemoveCLI, ConnectorShowCLI, GroupAddCLI, GroupCLI, GroupFindCLI, GroupMemberAddCLI, GroupMemberCLI, GroupMemberFindCLI, GroupMemberRemoveCLI, GroupMemberShowCLI, GroupModifyCLI, GroupRemoveCLI, GroupShowCLI, HelpCLI, KeyArchiveCLI, KeyCLI, KeyFindCLI, KeyGenerateCLI, KeyModifyCLI, KeyRecoverCLI, KeyRequestFindCLI, KeyRequestReviewCLI, KeyRequestShowCLI, KeyRetrieveCLI, KeyShowCLI, KeyTemplateFindCLI, KeyTemplateShowCLI, KRAConnectorAddCLI, KRAConnectorCLI, KRAConnectorRemoveCLI, KRAConnectorShowCLI, MainCLI, ProfileAddCLI, ProfileAddCLI, ProfileCLI, ProfileCLI, ProfileDisableCLI, ProfileEditCLI, ProfileEnableCLI, ProfileFindCLI, ProfileFindCLI, ProfileMappingAddCLI, ProfileMappingCLI, ProfileMappingFindCLI, ProfileMappingModifyCLI, ProfileMappingRemoveCLI, ProfileMappingShowCLI, ProfileModifyCLI, ProfileModifyCLI, ProfileRemoveCLI, ProfileRemoveCLI, ProfileShowCLI, ProfileShowCLI, ProxyCLI, SecurityDomainCLI, SecurityDomainShowCLI, SelfTestCLI, SelfTestFindCLI, SelfTestRunCLI, SelfTestShowCLI, SubsystemCLI, TokenAddCLI, TokenCLI, TokenFindCLI, TokenModifyCLI, TokenRemoveCLI, TokenShowCLI, TPSCertCLI, TPSCertFindCLI, TPSCertShowCLI, TPSConnectorAddCLI, TPSConnectorCLI, TPSConnectorFindCLI, TPSConnectorModCLI, TPSConnectorRemoveCLI, TPSConnectorShowCLI, UserAddCLI, UserCertAddCLI, UserCertCLI, UserCertFindCLI, UserCertRemoveCLI, UserCertShowCLI, UserCLI, UserFindCLI, UserMembershipAddCLI, UserMembershipCLI, UserMembershipFindCLI, UserMembershipRemoveCLI, UserModifyCLI, UserRemoveCLI, UserShowCLI

public class CLI
extends java.lang.Object

Author:

Endi S. Dewata

Field Summary

Fields

Modifier and Type	Field and Description
PKIClient	client
java.lang.String	description
static org.apache.commons.cli.HelpFormatter	formatter
java.util.Map<java.lang.String,CLI>	modules
java.lang.String	name
org.apache.commons.cli.Options	options
CLI	parent
static org.apache.commons.cli.CommandLineParser	parser
static boolean	verbose

Constructor Summary

Constructors

Constructor and Description
CLI(java.lang.String name, java.lang.String description)
CLI(java.lang.String name, java.lang.String description, CLI parent)

Method Summary

Modifier and Type	Method and Description
void	addModule(CLI module)
void	execute(java.lang.String[] args)
CLI	findModule(java.lang.String command) Find the last module that handles the specified command.
java.util.List<CLI>	findModules(java.lang.String command) Find the list of modules that handle the specified command.
PKIClient	getClient()
java.lang.Object	getClient(java.lang.String name)
java.util.Collection<CLI>	getDeprecatedModules()
java.lang.String	getDescription()
java.lang.String	getFullModuleName(java.lang.String moduleName)
java.lang.String	getFullName()
java.lang.String	getManPage()
CLI	getModule(java.lang.String name)
java.util.Collection<CLI>	getModules()
java.lang.String	getName()
CLI	getParent()
boolean	isDeprecated()
static boolean	isVerbose()
void	printHelp()
CLI	removeModule(java.lang.String name)
void	setDescription(java.lang.String description)
void	setName(java.lang.String name)
static void	setVerbose(boolean verbose)

Methods inherited from class java.lang.Object

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

Field Detail

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 java.lang.String name

description

public java.lang.String description

parent

public CLI parent

options

public org.apache.commons.cli.Options options

modules

public java.util.Map<java.lang.String,CLI> modules

client

public PKIClient client

Constructor Detail

CLI

public CLI(java.lang.String name,
           java.lang.String description)

CLI

public CLI(java.lang.String name,
           java.lang.String description,
           CLI parent)

Method Detail

getName

public java.lang.String getName()

setName

public void setName(java.lang.String name)

getFullName

public java.lang.String getFullName()

getFullModuleName

public java.lang.String getFullModuleName(java.lang.String moduleName)

getDescription

public java.lang.String getDescription()

setDescription

public void setDescription(java.lang.String description)

getParent

public CLI getParent()

isDeprecated

public boolean isDeprecated()

getModules

public java.util.Collection<CLI> getModules()

getModule

public CLI getModule(java.lang.String name)

addModule

public void addModule(CLI module)

removeModule

public CLI removeModule(java.lang.String name)

findModules

public java.util.List<CLI> findModules(java.lang.String command)
                                throws java.lang.Exception

Find the list of modules that handle the specified command.

Throws:

java.lang.Exception

findModule

public CLI findModule(java.lang.String command)
               throws java.lang.Exception

Find the last module that handles the specified command.

Throws:

java.lang.Exception

getManPage

public java.lang.String getManPage()

getClient

public PKIClient getClient()

getClient

public java.lang.Object getClient(java.lang.String name)

getDeprecatedModules

public java.util.Collection<CLI> getDeprecatedModules()

printHelp

public void printHelp()

execute

public void execute(java.lang.String[] args)
             throws java.lang.Exception

Throws:

java.lang.Exception

isVerbose

public static boolean isVerbose()

setVerbose

public static void setVerbose(boolean verbose)