CLIConstants (OpenAM Project 15.1.7-SNAPSHOT API)

```
public interface CLIConstants
```
This interface defines constants used in the package.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ANNOT_PRODUCTNAME` Name of product name annotation in definition class.
`static String`	`ANNOT_RESOURCE_BUNDLE_NAME` Name of product resource bundle name annotation in definition class.
`static String`	`ANNOT_VERSION` Name of product version annotation in definition class.
`static String`	`ARGUMENT_DEBUG` Name of debug argument/option.
`static String`	`ARGUMENT_HELP` Name of help argument/option.
`static String`	`ARGUMENT_INFORMATION` Name of tool information argument/option.
`static String`	`ARGUMENT_LOCALE` Name of locale argument/option.
`static String`	`ARGUMENT_NOLOG` Name of disable logging argument/option.
`static String`	`ARGUMENT_VERBOSE` Name of verbose argument/option.
`static String`	`ARGUMENT_VERSION` Name of version argument/option.
`static String`	`ATTR_NAME_AGENT_TYPE` Agent Type attribute name.
`static String`	`ATTR_SCHEMA_AGENT_PWD` Agent Password Attribute Schema name
`static String`	`AUTH_CORE_SERVICE` Core authentication service name.
`static String`	`CMD_NAME_IMPORT_SVC_CONFIG` Import configuration data sub command name.
`static String`	`FLAG_SINGLE` Flag to indicate that an argument/option is single.
`static String`	`FLAG_UNARY` Flag to indicate that an argument/option is unary.
`static String`	`FLAG_WEB_UI_CHECKBOX` Flag to indicate that an argument/option is to be displayed as checkbox in web based CLI.
`static String`	`FLAG_WEB_UI_TEXT` Flag to indicate that an argument/option is to be displayed as text box in web based CLI.
`static String`	`FLAG_WEB_UI_TEXTAREA` Flag to indicate that an argument/option is to be displayed as textarea in web based CLI.
`static String`	`FLD_PRODUCT_NAME` Name of product name field in definition class.
`static String`	`JSP_EXIT_CODE_TAG` Comment Tag for exit code in JSP
`static String`	`NAME_DEBUGGER` Name of debugger.
`static String`	`PREFIX_ARGUMENT` Prefix for argument/option defined in this interface.
`static String`	`PREFIX_ARGUMENT_LONG` Prefix of long argument/option passed into the CLI.
`static String`	`PREFIX_ARGUMENT_SHORT` Prefix of short argument/option passed into the CLI.
`static String`	`PREFIX_SHORT_ARGUMENT` Prefix for short argument/option defined in this interface.
`static String`	`PREFIX_SUBCMD_RES` Prefix of resource key.
`static String`	`SHORT_ARGUMENT_DEBUG` Short name of debug argument/option.
`static String`	`SHORT_ARGUMENT_HELP` Short name of help argument/option.
`static String`	`SHORT_ARGUMENT_INFORMATION` Short name of information argument/option.
`static String`	`SHORT_ARGUMENT_LOCALE` Short name of locale argument/option.
`static String`	`SHORT_ARGUMENT_NOLOG` Short name of disable logging argument/option.
`static String`	`SHORT_ARGUMENT_VERBOSE` Short name of verbose argument/option.
`static String`	`SHORT_ARGUMENT_VERSION` Short name of version argument/option.
`static String`	`SYS_PROPERTY_COMMAND_NAME` Name of the commandline interface.
`static String`	`SYS_PROPERTY_DEFINITION_FILES` Name of definition files that drive the behavior of CLI.
`static String`	`SYS_PROPERTY_OUTPUT_WRITER` Class name of the output writer.
`static String`	`USAGE_FORMAT` Template for formating usage.
`static String`	`USAGE_OPTION_FORMAT` Template for formating mandatory option in usage text.
`static String`	`USAGE_OPTION_NAME_FORMAT` Template for formating mandatory option name in usage text.
`static String`	`USAGE_OPTION_WITH_ALIAS_FORMAT` Template for formating mandatory option (with alias) in usage text.
`static String`	`USAGE_OPTIONAL_OPTION_FORMAT` Template for formating optional option in usage text.
`static String`	`USAGE_OPTIONAL_OPTION_NAME_FORMAT` Template for formating operational option name in usage text.
`static String`	`USAGE_OPTIONAL_OPTION_WITh_ALIAS_FORMAT` Template for formating optional option (with alias) in usage text.
`static String`	`USAGE_SUBCMD_EX_FORMAT` Template for formating sub command (extended format) in usage text.
`static String`	`USAGE_SUBCMD_FORMAT` Template for formating sub command (short format) in usage text.
`static String`	`USAGE_SUBCMD_HELP_FORMAT` Template for formating sub command help in usage text.
`static String`	`USAGE_SUBCMD_LONG_FORMAT` Template for formating sub command (long format) in usage text.
`static String`	`WEB_ENABLED_URL` Name of web enabled URL.
`static String`	`WEB_INPUT` Tag for web input.
`static String`	`WEB_RES_MARKER` Web resource string marker.

- Field Detail
  - SYS_PROPERTY_DEFINITION_FILES
```
static final String SYS_PROPERTY_DEFINITION_FILES
```
    Name of definition files that drive the behavior of CLI. These files are passed in as a property in the java interface. i.e. java -DdefinitionFiles=....
    
    See Also:
    
    Constant Field Values
  - SYS_PROPERTY_COMMAND_NAME
```
static final String SYS_PROPERTY_COMMAND_NAME
```
    Name of the commandline interface. This name is passed in as a property in the java interface. i.e. java -DcommandName=....
    
    See Also:
    
    Constant Field Values
  - SYS_PROPERTY_OUTPUT_WRITER
```
static final String SYS_PROPERTY_OUTPUT_WRITER
```
    Class name of the output writer. This name is passed in as a property in the java interface. i.e. java -DoutputWriter=....
    
    See Also:
    
    Constant Field Values
  - WEB_ENABLED_URL
```
static final String WEB_ENABLED_URL
```
    Name of web enabled URL.
    
    See Also:
    
    Constant Field Values
  - NAME_DEBUGGER
```
static final String NAME_DEBUGGER
```
    Name of debugger.
    
    See Also:
    
    Constant Field Values
  - FLD_PRODUCT_NAME
```
static final String FLD_PRODUCT_NAME
```
    Name of product name field in definition class.
    
    See Also:
    
    Constant Field Values
  - ANNOT_PRODUCTNAME
```
static final String ANNOT_PRODUCTNAME
```
    Name of product name annotation in definition class.
    
    See Also:
    
    Constant Field Values
  - ANNOT_VERSION
```
static final String ANNOT_VERSION
```
    Name of product version annotation in definition class.
    
    See Also:
    
    Constant Field Values
  - ANNOT_RESOURCE_BUNDLE_NAME
```
static final String ANNOT_RESOURCE_BUNDLE_NAME
```
    Name of product resource bundle name annotation in definition class.
    
    See Also:
    
    Constant Field Values
  - PREFIX_ARGUMENT
```
static final String PREFIX_ARGUMENT
```
    Prefix for argument/option defined in this interface.
    
    See Also:
    
    Constant Field Values
  - PREFIX_SHORT_ARGUMENT
```
static final String PREFIX_SHORT_ARGUMENT
```
    Prefix for short argument/option defined in this interface.
    
    See Also:
    
    Constant Field Values
  - PREFIX_ARGUMENT_LONG
```
static final String PREFIX_ARGUMENT_LONG
```
    Prefix of long argument/option passed into the CLI. e.g. --version
    
    See Also:
    
    Constant Field Values
  - PREFIX_ARGUMENT_SHORT
```
static final String PREFIX_ARGUMENT_SHORT
```
    Prefix of short argument/option passed into the CLI. e.g. --n
    
    See Also:
    
    Constant Field Values
  - PREFIX_SUBCMD_RES
```
static final String PREFIX_SUBCMD_RES
```
    Prefix of resource key. e.g. subcmd-version=Print Version of this tool.
    
    See Also:
    
    Constant Field Values
  - FLAG_WEB_UI_TEXTAREA
```
static final String FLAG_WEB_UI_TEXTAREA
```
    Flag to indicate that an argument/option is to be displayed as textarea in web based CLI.
    
    See Also:
    
    Constant Field Values
  - FLAG_WEB_UI_TEXT
```
static final String FLAG_WEB_UI_TEXT
```
    Flag to indicate that an argument/option is to be displayed as text box in web based CLI.
    
    See Also:
    
    Constant Field Values
  - FLAG_WEB_UI_CHECKBOX
```
static final String FLAG_WEB_UI_CHECKBOX
```
    Flag to indicate that an argument/option is to be displayed as checkbox in web based CLI.
    
    See Also:
    
    Constant Field Values
  - FLAG_UNARY
```
static final String FLAG_UNARY
```
    Flag to indicate that an argument/option is unary. e.g. --help
    
    See Also:
    
    Constant Field Values
  - FLAG_SINGLE
```
static final String FLAG_SINGLE
```
    Flag to indicate that an argument/option is single. e.g. --locale en_US
    
    See Also:
    
    Constant Field Values
  - ARGUMENT_VERSION
```
static final String ARGUMENT_VERSION
```
    Name of version argument/option.
    
    See Also:
    
    Constant Field Values
  - SHORT_ARGUMENT_VERSION
```
static final String SHORT_ARGUMENT_VERSION
```
    Short name of version argument/option.
    
    See Also:
    
    Constant Field Values
  - ARGUMENT_INFORMATION
```
static final String ARGUMENT_INFORMATION
```
    Name of tool information argument/option.
    
    See Also:
    
    Constant Field Values
  - SHORT_ARGUMENT_INFORMATION
```
static final String SHORT_ARGUMENT_INFORMATION
```
    Short name of information argument/option.
    
    See Also:
    
    Constant Field Values
  - ARGUMENT_DEBUG
```
static final String ARGUMENT_DEBUG
```
    Name of debug argument/option.
    
    See Also:
    
    Constant Field Values
  - SHORT_ARGUMENT_DEBUG
```
static final String SHORT_ARGUMENT_DEBUG
```
    Short name of debug argument/option.
    
    See Also:
    
    Constant Field Values
  - ARGUMENT_HELP
```
static final String ARGUMENT_HELP
```
    Name of help argument/option.
    
    See Also:
    
    Constant Field Values
  - SHORT_ARGUMENT_HELP
```
static final String SHORT_ARGUMENT_HELP
```
    Short name of help argument/option.
    
    See Also:
    
    Constant Field Values
  - ARGUMENT_VERBOSE
```
static final String ARGUMENT_VERBOSE
```
    Name of verbose argument/option.
    
    See Also:
    
    Constant Field Values
  - SHORT_ARGUMENT_VERBOSE
```
static final String SHORT_ARGUMENT_VERBOSE
```
    Short name of verbose argument/option.
    
    See Also:
    
    Constant Field Values
  - ARGUMENT_LOCALE
```
static final String ARGUMENT_LOCALE
```
    Name of locale argument/option.
    
    See Also:
    
    Constant Field Values
  - SHORT_ARGUMENT_LOCALE
```
static final String SHORT_ARGUMENT_LOCALE
```
    Short name of locale argument/option.
    
    See Also:
    
    Constant Field Values
  - ARGUMENT_NOLOG
```
static final String ARGUMENT_NOLOG
```
    Name of disable logging argument/option.
    
    See Also:
    
    Constant Field Values
  - SHORT_ARGUMENT_NOLOG
```
static final String SHORT_ARGUMENT_NOLOG
```
    Short name of disable logging argument/option.
    
    See Also:
    
    Constant Field Values
  - USAGE_FORMAT
```
static final String USAGE_FORMAT
```
    Template for formating usage.
    
    See Also:
    
    Constant Field Values
  - USAGE_SUBCMD_FORMAT
```
static final String USAGE_SUBCMD_FORMAT
```
    Template for formating sub command (short format) in usage text.
    
    See Also:
    
    Constant Field Values
  - USAGE_SUBCMD_LONG_FORMAT
```
static final String USAGE_SUBCMD_LONG_FORMAT
```
    Template for formating sub command (long format) in usage text.
    
    See Also:
    
    Constant Field Values
  - USAGE_SUBCMD_EX_FORMAT
```
static final String USAGE_SUBCMD_EX_FORMAT
```
    Template for formating sub command (extended format) in usage text.
    
    See Also:
    
    Constant Field Values
  - USAGE_SUBCMD_HELP_FORMAT
```
static final String USAGE_SUBCMD_HELP_FORMAT
```
    Template for formating sub command help in usage text.
    
    See Also:
    
    Constant Field Values
  - USAGE_OPTION_NAME_FORMAT
```
static final String USAGE_OPTION_NAME_FORMAT
```
    Template for formating mandatory option name in usage text.
    
    See Also:
    
    Constant Field Values
  - USAGE_OPTIONAL_OPTION_NAME_FORMAT
```
static final String USAGE_OPTIONAL_OPTION_NAME_FORMAT
```
    Template for formating operational option name in usage text.
    
    See Also:
    
    Constant Field Values
  - USAGE_OPTION_FORMAT
```
static final String USAGE_OPTION_FORMAT
```
    Template for formating mandatory option in usage text.
    
    See Also:
    
    Constant Field Values
  - USAGE_OPTION_WITH_ALIAS_FORMAT
```
static final String USAGE_OPTION_WITH_ALIAS_FORMAT
```
    Template for formating mandatory option (with alias) in usage text.
    
    See Also:
    
    Constant Field Values
  - USAGE_OPTIONAL_OPTION_FORMAT
```
static final String USAGE_OPTIONAL_OPTION_FORMAT
```
    Template for formating optional option in usage text.
    
    See Also:
    
    Constant Field Values
  - USAGE_OPTIONAL_OPTION_WITh_ALIAS_FORMAT
```
static final String USAGE_OPTIONAL_OPTION_WITh_ALIAS_FORMAT
```
    Template for formating optional option (with alias) in usage text.
    
    See Also:
    
    Constant Field Values
  - AUTH_CORE_SERVICE
```
static final String AUTH_CORE_SERVICE
```
    Core authentication service name.
    
    See Also:
    
    Constant Field Values
  - WEB_INPUT
```
static final String WEB_INPUT
```
    Tag for web input.
    
    See Also:
    
    Constant Field Values
  - JSP_EXIT_CODE_TAG
```
static final String JSP_EXIT_CODE_TAG
```
    Comment Tag for exit code in JSP
    
    See Also:
    
    Constant Field Values
  - WEB_RES_MARKER
```
static final String WEB_RES_MARKER
```
    Web resource string marker.
    
    See Also:
    
    Constant Field Values
  - ATTR_NAME_AGENT_TYPE
```
static final String ATTR_NAME_AGENT_TYPE
```
    Agent Type attribute name.
    
    See Also:
    
    Constant Field Values
  - ATTR_SCHEMA_AGENT_PWD
```
static final String ATTR_SCHEMA_AGENT_PWD
```
    Agent Password Attribute Schema name
    
    See Also:
    
    Constant Field Values
  - CMD_NAME_IMPORT_SVC_CONFIG
```
static final String CMD_NAME_IMPORT_SVC_CONFIG
```
    Import configuration data sub command name.
    
    See Also:
    
    Constant Field Values

Interface CLIConstants

Field Summary

Field Detail

SYS_PROPERTY_DEFINITION_FILES

SYS_PROPERTY_COMMAND_NAME

SYS_PROPERTY_OUTPUT_WRITER

WEB_ENABLED_URL

NAME_DEBUGGER

FLD_PRODUCT_NAME

ANNOT_PRODUCTNAME

ANNOT_VERSION

ANNOT_RESOURCE_BUNDLE_NAME

PREFIX_ARGUMENT

PREFIX_SHORT_ARGUMENT

PREFIX_ARGUMENT_LONG

PREFIX_ARGUMENT_SHORT

PREFIX_SUBCMD_RES

FLAG_WEB_UI_TEXTAREA

FLAG_WEB_UI_TEXT

FLAG_WEB_UI_CHECKBOX

FLAG_UNARY

FLAG_SINGLE

ARGUMENT_VERSION

SHORT_ARGUMENT_VERSION

ARGUMENT_INFORMATION

SHORT_ARGUMENT_INFORMATION

ARGUMENT_DEBUG

SHORT_ARGUMENT_DEBUG

ARGUMENT_HELP

SHORT_ARGUMENT_HELP

ARGUMENT_VERBOSE

SHORT_ARGUMENT_VERBOSE

ARGUMENT_LOCALE

SHORT_ARGUMENT_LOCALE

ARGUMENT_NOLOG

SHORT_ARGUMENT_NOLOG

USAGE_FORMAT

USAGE_SUBCMD_FORMAT

USAGE_SUBCMD_LONG_FORMAT

USAGE_SUBCMD_EX_FORMAT

USAGE_SUBCMD_HELP_FORMAT

USAGE_OPTION_NAME_FORMAT

USAGE_OPTIONAL_OPTION_NAME_FORMAT

USAGE_OPTION_FORMAT

USAGE_OPTION_WITH_ALIAS_FORMAT

USAGE_OPTIONAL_OPTION_FORMAT

USAGE_OPTIONAL_OPTION_WITh_ALIAS_FORMAT

AUTH_CORE_SERVICE

WEB_INPUT

JSP_EXIT_CODE_TAG

WEB_RES_MARKER

ATTR_NAME_AGENT_TYPE

ATTR_SCHEMA_AGENT_PWD

CMD_NAME_IMPORT_SVC_CONFIG