CLI (pki-javadoc)

java.lang.Object
- org.dogtagpki.cli.CLI

Direct Known Subclasses:

ActivityCLI, AuditCLI, AuthenticatorCLI, AuthorityCLI, CACertCLI, CACertRequestCLI, CACLI, CADBCLI, ClientCLI, CommandCLI, ConfigCLI, ConnectorCLI, FeatureCLI, GroupCLI, GroupMemberCLI, KRACertCLI, KRACLI, KRAConnectorCLI, KRAKeyCLI, MainCLI, NSSCLI, NSSKeyCLI, OCSPCLI, PKCS11CertCLI, PKCS11CLI, PKCS11KeyCLI, PKCS12CertCLI, PKCS12CLI, PKCS12KeyCLI, PKCS7CertCLI, PKCS7CLI, PKIServerCLI, ProfileCLI, ProfileCLI, ProfileMappingCLI, ProxyCLI, SecurityDomainCLI, SelfTestCLI, SubsystemCLI, SubsystemDBCLI, TKSCLI, TKSKeyCLI, TokenCLI, TPSCertCLI, TPSCLI, TPSConnectorCLI, UserCertCLI, UserCLI, UserMembershipCLI
```
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`
`static org.slf4j.Logger`	`logger`
`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)

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

All Methods Instance Methods Concrete Methods
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)`
`ClientConfig`	`getConfig()`
`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()`
`CLI`	`getRoot()`
`boolean`	`isDeprecated()`
`void`	`printCommands(java.util.Map<java.lang.String,CLI> modules)`
`void`	`printHelp()`
`CLI`	`removeModule(java.lang.String name)`
`void`	`runExternal(java.util.List<java.lang.String> command)`
`void`	`runExternal(java.lang.String[] command)`
`void`	`setDescription(java.lang.String description)`
`void`	`setName(java.lang.String name)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

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 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()
```

getRoot
```
public CLI getRoot()
```

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()
```

getConfig

public ClientConfig getConfig()
                       throws java.lang.Exception

Throws:: java.lang.Exception

getClient

public PKIClient getClient()
                    throws java.lang.Exception

Throws:: java.lang.Exception

getClient

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

Throws:: java.lang.Exception

printHelp
```
public void printHelp()
```

printCommands

public void printCommands(java.util.Map<java.lang.String,CLI> modules)

execute

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

Throws:: java.lang.Exception

runExternal

public void runExternal(java.util.List<java.lang.String> command)
                 throws CLIException,
                        java.io.IOException,
                        java.lang.InterruptedException

Throws:: CLIException; java.io.IOException; java.lang.InterruptedException

runExternal

public void runExternal(java.lang.String[] command)
                 throws CLIException,
                        java.io.IOException,
                        java.lang.InterruptedException

Throws:: CLIException; java.io.IOException; java.lang.InterruptedException

Class CLI

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

logger

verbose

parser

formatter

name

description

parent

options

modules

client

Constructor Detail

CLI

CLI

Method Detail

getName

setName

getFullName

getFullModuleName

getDescription

setDescription

getParent

getRoot

isDeprecated

getModules

getModule

addModule

removeModule

findModules

findModule

getManPage

getConfig

getClient

getClient

printHelp

printCommands

execute

runExternal

runExternal