Index (prosEO Command Line Interface 2.0.0 API)

A C D E F G I J L M O P R S T U W
All Classes and Interfaces|All Packages|Constant Field Values

A

allowedTypes - Static variable in class de.dlr.proseo.ui.cli.parser.CLISyntax: Allowed type names in syntax file

C

CLICommand - Class in de.dlr.proseo.ui.cli.parser: Class representing a prosEO CLI command
CLICommand() - Constructor for class de.dlr.proseo.ui.cli.parser.CLICommand
CLIConfiguration - Class in de.dlr.proseo.ui.cli: Configuration class for the prosEO Ingestor component
CLIConfiguration() - Constructor for class de.dlr.proseo.ui.cli.CLIConfiguration
CLIOption - Class in de.dlr.proseo.ui.cli.parser: Class representing a prosEO CLI command option
CLIOption() - Constructor for class de.dlr.proseo.ui.cli.parser.CLIOption
CLIParameter - Class in de.dlr.proseo.ui.cli.parser: Class representing a CLI command parameter
CLIParameter() - Constructor for class de.dlr.proseo.ui.cli.parser.CLIParameter
CLIParser - Class in de.dlr.proseo.ui.cli.parser: Parser for the prosEO Command Line Interface Command line syntax is based on a YAML specification.
CLIParser() - Constructor for class de.dlr.proseo.ui.cli.parser.CLIParser
CLISyntax - Class in de.dlr.proseo.ui.cli.parser: Representation of the prosEO Command Line Interface syntax The command line syntax is based on a YAML specification, which is used to initialize a CLISyntax object.
CLISyntax() - Constructor for class de.dlr.proseo.ui.cli.parser.CLISyntax
CLIUtil - Class in de.dlr.proseo.ui.cli: Utility methods for command interpretation
CLIUtil() - Constructor for class de.dlr.proseo.ui.cli.CLIUtil
CLIUtil.Credentials - Class in de.dlr.proseo.ui.cli: Helper class to return username and password from a method
CMD_ARCHIVE - Static variable in class de.dlr.proseo.ui.cli.ProductArchiveCommandRunner
CMD_CONFIGURATION - Static variable in class de.dlr.proseo.ui.cli.ProcessorCommandRunner
CMD_FACILITY - Static variable in class de.dlr.proseo.ui.cli.FacilityCommandRunner
CMD_GROUP - Static variable in class de.dlr.proseo.ui.cli.UserCommandRunner
CMD_INGEST - Static variable in class de.dlr.proseo.ui.cli.IngestorCommandRunner
CMD_JOB - Static variable in class de.dlr.proseo.ui.cli.JobCommandRunner
CMD_MISSION - Static variable in class de.dlr.proseo.ui.cli.MissionCommandRunner
CMD_ORBIT - Static variable in class de.dlr.proseo.ui.cli.MissionCommandRunner
CMD_ORDER - Static variable in class de.dlr.proseo.ui.cli.OrderCommandRunner
CMD_PASSWORD - Static variable in class de.dlr.proseo.ui.cli.UserCommandRunner
CMD_PROCESSOR - Static variable in class de.dlr.proseo.ui.cli.ProcessorCommandRunner
CMD_PRODUCT - Static variable in class de.dlr.proseo.ui.cli.IngestorCommandRunner
CMD_PRODUCTCLASS - Static variable in class de.dlr.proseo.ui.cli.ProductclassCommandRunner
CMD_USER - Static variable in class de.dlr.proseo.ui.cli.UserCommandRunner
CMD_WORKFLOW - Static variable in class de.dlr.proseo.ui.cli.WorkflowCommandRunner
CommandLineInterface - Class in de.dlr.proseo.ui.cli: prosEO Command Line Interface application
CommandLineInterface() - Constructor for class de.dlr.proseo.ui.cli.CommandLineInterface
Credentials() - Constructor for class de.dlr.proseo.ui.cli.CLIUtil.Credentials

D

de.dlr.proseo.ui.cli - package de.dlr.proseo.ui.cli: Top-level classes for the prosEO Command-Line Interface component
de.dlr.proseo.ui.cli.parser - package de.dlr.proseo.ui.cli.parser: Parser classes for the prosEO Command-Line Interface component
de.dlr.proseo.ui.cli.syntax2html - package de.dlr.proseo.ui.cli.syntax2html: Syntax documentation for the prosEO Command-Line Interface component

E

executeCommand(ParsedCommand) - Method in class de.dlr.proseo.ui.cli.FacilityCommandRunner: Run the given command
executeCommand(ParsedCommand) - Method in class de.dlr.proseo.ui.cli.IngestorCommandRunner: Run the given command
executeCommand(ParsedCommand) - Method in class de.dlr.proseo.ui.cli.JobCommandRunner: Run the given command
executeCommand(ParsedCommand) - Method in class de.dlr.proseo.ui.cli.MissionCommandRunner: Run the given command
executeCommand(ParsedCommand) - Method in class de.dlr.proseo.ui.cli.OrderCommandRunner: Run the given command
executeCommand(ParsedCommand) - Method in class de.dlr.proseo.ui.cli.ProcessorCommandRunner: Run the given command
executeCommand(ParsedCommand) - Method in class de.dlr.proseo.ui.cli.ProductArchiveCommandRunner: Run the given command
executeCommand(ParsedCommand) - Method in class de.dlr.proseo.ui.cli.ProductclassCommandRunner: Run the given command
executeCommand(ParsedCommand) - Method in class de.dlr.proseo.ui.cli.UserCommandRunner: Run the given command
executeCommand(ParsedCommand) - Method in class de.dlr.proseo.ui.cli.WorkflowCommandRunner: Run the given command

F

FacilityCommandRunner - Class in de.dlr.proseo.ui.cli: Run commands for managing prosEO processing facilities (create, read, update, delete).
FacilityCommandRunner() - Constructor for class de.dlr.proseo.ui.cli.FacilityCommandRunner
FILE_FORMAT_JSON - Static variable in class de.dlr.proseo.ui.cli.CLIUtil: JSON file format
FILE_FORMAT_XML - Static variable in class de.dlr.proseo.ui.cli.CLIUtil: XML file format
FILE_FORMAT_YAML - Static variable in class de.dlr.proseo.ui.cli.CLIUtil: YAML file format
fromSyntaxFile(String) - Static method in class de.dlr.proseo.ui.cli.parser.CLISyntax: Load the CLI syntax file from the given file path

G

getCliStart() - Method in class de.dlr.proseo.ui.cli.CLIConfiguration: Indicate whether the CLI prompt should be started
getCliSyntaxFile() - Method in class de.dlr.proseo.ui.cli.CLIConfiguration: Gets the file path to the CLI syntax file
getCommandMap() - Method in class de.dlr.proseo.ui.cli.parser.CLISyntax: Gets the available commands as a lookup map by command name
getCommands() - Method in class de.dlr.proseo.ui.cli.parser.CLISyntax: Gets the available commands
getDescription() - Method in class de.dlr.proseo.ui.cli.parser.CLICommand: Gets the command description
getDescription() - Method in class de.dlr.proseo.ui.cli.parser.CLIOption: Gets the option's description
getDescription() - Method in class de.dlr.proseo.ui.cli.parser.CLIParameter: Gets the parameter's description
getDescription() - Method in class de.dlr.proseo.ui.cli.parser.CLISyntax: Gets the syntax description
getGlobalOptionMap() - Method in class de.dlr.proseo.ui.cli.parser.CLISyntax: Gets the options valid for all commands as a map by full name
getGlobalOptions() - Method in class de.dlr.proseo.ui.cli.parser.CLISyntax: Gets the options valid for all commands
getGlobalOptionsShortForm() - Method in class de.dlr.proseo.ui.cli.parser.CLISyntax: Gets the options valid for all commands as a map by short form
getName() - Method in class de.dlr.proseo.ui.cli.parser.CLICommand: Gets the command name
getName() - Method in class de.dlr.proseo.ui.cli.parser.CLIOption: Gets the option's name
getName() - Method in class de.dlr.proseo.ui.cli.parser.CLIParameter: Gets the parameter's name
getName() - Method in class de.dlr.proseo.ui.cli.parser.ParsedCommand: Gets the parsed command's name
getName() - Method in class de.dlr.proseo.ui.cli.parser.ParsedOption: Gets the parsed option's name
getName() - Method in class de.dlr.proseo.ui.cli.parser.ParsedParameter: Gets the parsed parameter's name
getOptional() - Method in class de.dlr.proseo.ui.cli.parser.CLIParameter: Return whether the parameter is optional
getOptions() - Method in class de.dlr.proseo.ui.cli.parser.CLICommand: Gets the command's options
getOptions() - Method in class de.dlr.proseo.ui.cli.parser.CLISyntax: Gets the top-level options
getOptions() - Method in class de.dlr.proseo.ui.cli.parser.ParsedCommand: Gets the parsed command's options
getParameters() - Method in class de.dlr.proseo.ui.cli.parser.CLICommand: Gets the command's parameters
getParameters() - Method in class de.dlr.proseo.ui.cli.parser.ParsedCommand: Gets the parsed command's parameters
getRepeatable() - Method in class de.dlr.proseo.ui.cli.parser.CLIParameter: Return whether the parameter is repeatable
getShortForm() - Method in class de.dlr.proseo.ui.cli.parser.CLIOption: Gets the option's short form
getSubcommand() - Method in class de.dlr.proseo.ui.cli.parser.ParsedCommand: Gets the parsed command's subcommand
getSubcommands() - Method in class de.dlr.proseo.ui.cli.parser.CLICommand: Gets the command's subcommands
getSyntax() - Method in class de.dlr.proseo.ui.cli.parser.CLIParser: Return the currently applicable syntax
getSyntaxCommand() - Method in class de.dlr.proseo.ui.cli.parser.ParsedCommand: Gets the parsed command's syntax command
getSyntaxOption() - Method in class de.dlr.proseo.ui.cli.parser.ParsedOption: Gets the parsed option's syntax option
getSyntaxParameter() - Method in class de.dlr.proseo.ui.cli.parser.ParsedParameter: Gets the parsed parameter's syntax parameter
getTitle() - Method in class de.dlr.proseo.ui.cli.parser.CLISyntax: Gets the title of the syntax file
getTopLevelOptions() - Method in class de.dlr.proseo.ui.cli.parser.CLISyntax: Gets the top-level options as a map by full name
getType() - Method in class de.dlr.proseo.ui.cli.parser.CLIOption: Gets the option's type
getType() - Method in class de.dlr.proseo.ui.cli.parser.CLIParameter: Gets the parameter's type
getType() - Method in class de.dlr.proseo.ui.cli.parser.ParsedOption: Gets the parsed option's type
getType() - Method in class de.dlr.proseo.ui.cli.parser.ParsedParameter: Gets the parsed parameter's type
getValue() - Method in class de.dlr.proseo.ui.cli.parser.ParsedOption: Gets the parsed option's description
getValue() - Method in class de.dlr.proseo.ui.cli.parser.ParsedParameter: Gets the parsed parameter's value
getVersion() - Method in class de.dlr.proseo.ui.cli.parser.CLISyntax: Gets the syntax file version

I

IngestorCommandRunner - Class in de.dlr.proseo.ui.cli: Run commands for ingesting and managing prosEO products (create, read, update, delete etc.).
IngestorCommandRunner() - Constructor for class de.dlr.proseo.ui.cli.IngestorCommandRunner
inputSyntax - Static variable in class de.dlr.proseo.ui.cli.parser.CLISyntax: The syntax used in this program run (the last one parsed)
isHelpRequested() - Method in class de.dlr.proseo.ui.cli.parser.ParsedCommand: Check, whether the "help" option was set
isInteractiveMode - Static variable in class de.dlr.proseo.ui.cli.CommandLineInterface: Indicator for interactive mode vs. running from input redirection

J

JobCommandRunner - Class in de.dlr.proseo.ui.cli: Run commands for managing prosEO orders (create, read, update, delete etc.).
JobCommandRunner() - Constructor for class de.dlr.proseo.ui.cli.JobCommandRunner

L

loadSyntax() - Method in class de.dlr.proseo.ui.cli.parser.CLIParser: Load the command line syntax from the configured syntax file

M

main(String[]) - Static method in class de.dlr.proseo.ui.cli.CommandLineInterface: Main function to start the Spring application; exits with return code 0 on normal termination, with return code 1 otherwise
main(String...) - Static method in class de.dlr.proseo.ui.cli.syntax2html.Syntax2HTML: Converts YAML syntax file to HTML for documentation purposes
MissionCommandRunner - Class in de.dlr.proseo.ui.cli: Run commands for managing prosEO missions, spacecrafts and orbits (create, read, update, delete etc.).
MissionCommandRunner() - Constructor for class de.dlr.proseo.ui.cli.MissionCommandRunner

O

OrderCommandRunner - Class in de.dlr.proseo.ui.cli: Run commands for managing prosEO orders (create, read, update, delete etc.).
OrderCommandRunner() - Constructor for class de.dlr.proseo.ui.cli.OrderCommandRunner

P

parse(String) - Method in class de.dlr.proseo.ui.cli.parser.CLIParser: Parse a command string using the given syntax structure
parseDateTime(String) - Static method in class de.dlr.proseo.ui.cli.CLIUtil: Parse a date and time string in the format "yyyy-MM-dd'T'HH:mm:ss.SSSSSS[zZX]", whereby all of the following variants are allowed: yyyy-MM-dd yyyy-MM-ddTHH:mm yyyy-MM-ddTHH:mm:ss yyyy-MM-ddTHH:mm:ss.S[SSSSS] any of the above plus a time zone in general, RFC 822 or ISO 8601 format Missing parts are set to zero, a missing time zone is set to UTC.
ParsedCommand - Class in de.dlr.proseo.ui.cli.parser: Class representing a parsed command line command
ParsedCommand() - Constructor for class de.dlr.proseo.ui.cli.parser.ParsedCommand
ParsedOption - Class in de.dlr.proseo.ui.cli.parser: Class representing a parsed command option
ParsedOption() - Constructor for class de.dlr.proseo.ui.cli.parser.ParsedOption
ParsedParameter - Class in de.dlr.proseo.ui.cli.parser: Class representing a parsed command parameter
ParsedParameter() - Constructor for class de.dlr.proseo.ui.cli.parser.ParsedParameter
parseObjectFile(File, String, Class<T>) - Static method in class de.dlr.proseo.ui.cli.CLIUtil: Read the description for an object of the given type from a file in Json, XML or Yaml format
password - Variable in class de.dlr.proseo.ui.cli.CLIUtil.Credentials
printHelp(PrintStream) - Method in class de.dlr.proseo.ui.cli.parser.CLICommand: Print help information for this command on the given print stream
printHelp(PrintStream) - Method in class de.dlr.proseo.ui.cli.parser.CLISyntax: Print help information for this command on the given print stream
printHTML() - Method in class de.dlr.proseo.ui.cli.parser.CLISyntax: Generates a StringBuilder, appends it with HTML code that prints a title and description, calls the respective printHTML() methods for all global options, options and commands from the respective Documentation class fields.
printHTML(StringBuilder) - Method in class de.dlr.proseo.ui.cli.parser.CLICommand: Appends the StringBuilder provided by the caller with HTML code that prints a table with the command's name and description and calls - if applicable - the printHTML() methods of subcommands, options and parameters.
printHTML(StringBuilder) - Method in class de.dlr.proseo.ui.cli.parser.CLIOption: Appends the StringBuilder provided by the caller with HTML code that prints a table with the option's name, short form (if applicable) and description.
printHTML(StringBuilder) - Method in class de.dlr.proseo.ui.cli.parser.CLIParameter: Appends the StringBuilder provided by the caller with HTML code that prints a table with the parameter's name and a description.
printObject(PrintStream, Object, String) - Static method in class de.dlr.proseo.ui.cli.CLIUtil: Print the given object to the given output stream according to the requested file format; if the object is a list or set of size 1, then the single element of the collection is printed, not the list/set itself
ProcessorCommandRunner - Class in de.dlr.proseo.ui.cli: Run commands for managing prosEO processor classes, versions and configurations (create, read, update, delete etc.).
ProcessorCommandRunner() - Constructor for class de.dlr.proseo.ui.cli.ProcessorCommandRunner
ProductArchiveCommandRunner - Class in de.dlr.proseo.ui.cli: Run commands for managing prosEO product archives (create, read, update, delete).
ProductArchiveCommandRunner() - Constructor for class de.dlr.proseo.ui.cli.ProductArchiveCommandRunner
ProductclassCommandRunner - Class in de.dlr.proseo.ui.cli: Run commands for managing prosEO product classes and selection rules (create, read, update, delete etc.).
ProductclassCommandRunner() - Constructor for class de.dlr.proseo.ui.cli.ProductclassCommandRunner

R

readIdentFile(String) - Static method in class de.dlr.proseo.ui.cli.CLIUtil: Read the user credentials from a file consisting of one or two lines, the first line containing the username (without mission prefix) and the second line the password.
run(String...) - Method in class de.dlr.proseo.ui.cli.CommandLineInterface: Main command loop after initialization of Spring environment

S

setAttribute(Object, String) - Static method in class de.dlr.proseo.ui.cli.CLIUtil: Set an object attribute from an "attribute=value" parameter using reflection.
setCommandMap(Map<String, CLICommand>) - Method in class de.dlr.proseo.ui.cli.parser.CLISyntax: Sets the command lookup map
setCommands(List<CLICommand>) - Method in class de.dlr.proseo.ui.cli.parser.CLISyntax: Sets the available commands
setDescription(String) - Method in class de.dlr.proseo.ui.cli.parser.CLICommand: Sets the command description
setDescription(String) - Method in class de.dlr.proseo.ui.cli.parser.CLIOption: Sets the option's description
setDescription(String) - Method in class de.dlr.proseo.ui.cli.parser.CLIParameter: Sets the parameter's description
setDescription(String) - Method in class de.dlr.proseo.ui.cli.parser.CLISyntax: Sets the syntax description
setGlobalOptionMap(Map<String, CLIOption>) - Method in class de.dlr.proseo.ui.cli.parser.CLISyntax: Sets the global option map (full name)
setGlobalOptions(List<CLIOption>) - Method in class de.dlr.proseo.ui.cli.parser.CLISyntax: Sets the options valid for all commands
setGlobalOptionsShortForm(Map<String, CLIOption>) - Method in class de.dlr.proseo.ui.cli.parser.CLISyntax: Sets the global option map (short form)
setName(String) - Method in class de.dlr.proseo.ui.cli.parser.CLICommand: Sets the command name
setName(String) - Method in class de.dlr.proseo.ui.cli.parser.CLIOption: Sets the option's name
setName(String) - Method in class de.dlr.proseo.ui.cli.parser.CLIParameter: Sets the parameter's name
setName(String) - Method in class de.dlr.proseo.ui.cli.parser.ParsedCommand: Sets the parsed command's name
setName(String) - Method in class de.dlr.proseo.ui.cli.parser.ParsedOption: Sets the parsed option's name
setName(String) - Method in class de.dlr.proseo.ui.cli.parser.ParsedParameter: Sets the parsed parameter's name
setOptional(Boolean) - Method in class de.dlr.proseo.ui.cli.parser.CLIParameter: Set whether the parameter is optional
setOptions(List<CLIOption>) - Method in class de.dlr.proseo.ui.cli.parser.CLICommand: Sets the command's options
setOptions(List<CLIOption>) - Method in class de.dlr.proseo.ui.cli.parser.CLISyntax: Sets the top-level options
setOptions(List<ParsedOption>) - Method in class de.dlr.proseo.ui.cli.parser.ParsedCommand: Sets the parsed command's options
setParameters(List<CLIParameter>) - Method in class de.dlr.proseo.ui.cli.parser.CLICommand: Sets the command's parameters
setParameters(List<ParsedParameter>) - Method in class de.dlr.proseo.ui.cli.parser.ParsedCommand: Sets the parsed command's parameters
setRepeatable(Boolean) - Method in class de.dlr.proseo.ui.cli.parser.CLIParameter: Set whether the parameter is repeatable
setShortForm(Character) - Method in class de.dlr.proseo.ui.cli.parser.CLIOption: Sets the option's short form
setSubcommand(ParsedCommand) - Method in class de.dlr.proseo.ui.cli.parser.ParsedCommand: Sets the parsed command's subcommand
setSubcommands(List<CLICommand>) - Method in class de.dlr.proseo.ui.cli.parser.CLICommand: Sets the command's subcommands
setSyntaxCommand(CLICommand) - Method in class de.dlr.proseo.ui.cli.parser.ParsedCommand: Sets the parsed command's syntax command
setSyntaxOption(CLIOption) - Method in class de.dlr.proseo.ui.cli.parser.ParsedOption: Sets the parsed option's syntax option
setSyntaxParameter(CLIParameter) - Method in class de.dlr.proseo.ui.cli.parser.ParsedParameter: Sets the parsed parameter's syntax parameter
setTitle(String) - Method in class de.dlr.proseo.ui.cli.parser.CLISyntax: Gets the title of the syntax file
setTopLevelOptions(Map<String, CLIOption>) - Method in class de.dlr.proseo.ui.cli.parser.CLISyntax: Sets the top-level option map (full name)
setType(String) - Method in class de.dlr.proseo.ui.cli.parser.CLIOption: Sets the option's type
setType(String) - Method in class de.dlr.proseo.ui.cli.parser.CLIParameter: Sets the parameter's type
setType(String) - Method in class de.dlr.proseo.ui.cli.parser.ParsedOption: Sets the parsed option's type
setType(String) - Method in class de.dlr.proseo.ui.cli.parser.ParsedParameter: Sets the parsed parameter's type
setValue(String) - Method in class de.dlr.proseo.ui.cli.parser.ParsedOption: Sets the parsed option's description
setValue(String) - Method in class de.dlr.proseo.ui.cli.parser.ParsedParameter: Sets the parsed parameter's value
setVersion(String) - Method in class de.dlr.proseo.ui.cli.parser.CLISyntax: sets the syntax file version
Syntax2HTML - Class in de.dlr.proseo.ui.cli.syntax2html: Converts YAML syntax file to HTML for documentation purposes.
Syntax2HTML() - Constructor for class de.dlr.proseo.ui.cli.syntax2html.Syntax2HTML

T

TOP_LEVEL_COMMAND_NAME - Static variable in class de.dlr.proseo.ui.cli.parser.CLIParser: The name of the top-level command
toString() - Method in class de.dlr.proseo.ui.cli.parser.CLICommand
toString() - Method in class de.dlr.proseo.ui.cli.parser.CLIOption: Returns the option in string format
toString() - Method in class de.dlr.proseo.ui.cli.parser.CLIParameter: Returns a String representation of the parameter
toString() - Method in class de.dlr.proseo.ui.cli.parser.CLISyntax: Returns a String representation of the syntax
toString() - Method in class de.dlr.proseo.ui.cli.parser.ParsedCommand: Returns a String representation of the parsed command
toString() - Method in class de.dlr.proseo.ui.cli.parser.ParsedOption: Returns a String representation of the parsed option
toString() - Method in class de.dlr.proseo.ui.cli.parser.ParsedParameter: Returns a String representation of the parsed parameter

U

UserCommandRunner - Class in de.dlr.proseo.ui.cli: Run commands for managing prosEO user accounts and user groups (create, read, update, delete etc.).
UserCommandRunner() - Constructor for class de.dlr.proseo.ui.cli.UserCommandRunner
username - Variable in class de.dlr.proseo.ui.cli.CLIUtil.Credentials

W

WorkflowCommandRunner - Class in de.dlr.proseo.ui.cli: Run commands for managing prosEO workflows (create, read, update, delete etc.).
WorkflowCommandRunner() - Constructor for class de.dlr.proseo.ui.cli.WorkflowCommandRunner

A C D E F G I J L M O P R S T U W
All Classes and Interfaces|All Packages|Constant Field Values