Index (Shibboleth Shared :: CLI Support 9.0.0 API)

A B C D E G H I L N O P Q R S T V W Y
All Classes and Interfaces|All Packages|Constant Field Values

A

AbstractCommandLine<T extends CommandLineArguments> - Class in net.shibboleth.shared.cli: A simple driver for a Spring-based CLI.
AbstractCommandLine() - Constructor for class net.shibboleth.shared.cli.AbstractCommandLine
AbstractCommandLine.TerminalCodes - Enum Class in net.shibboleth.shared.cli: Terminal codes.
AbstractCommandLineArguments - Class in net.shibboleth.shared.cli: Command line arguments base class for the AbstractCommandLine class.
AbstractCommandLineArguments() - Constructor for class net.shibboleth.shared.cli.AbstractCommandLineArguments
ansi - Variable in class net.shibboleth.shared.cli.AbstractCommandLineArguments: Use ANSI color codes.
ansicode - Variable in enum class net.shibboleth.shared.cli.AbstractCommandLine.TerminalCodes: Code string.
applicationContext - Variable in class net.shibboleth.shared.cli.AbstractCommandLine: Spring context.
ARGS_PROPERTY - Static variable in class net.shibboleth.shared.cli.AbstractCommandLine: Name of system property for command line argument class.

B

BLACK - Enum constant in enum class net.shibboleth.shared.cli.AbstractCommandLine.TerminalCodes: Black.
BLUE - Enum constant in enum class net.shibboleth.shared.cli.AbstractCommandLine.TerminalCodes: Blue.

C

caseSensitiveOptions - Variable in class net.shibboleth.shared.cli.AbstractCommandLine: Whether options are case-sensitive.
code(CommandLineArguments) - Method in enum class net.shibboleth.shared.cli.AbstractCommandLine.TerminalCodes: Gets the relevant code for the enum value.
CommandLineArguments - Interface in net.shibboleth.shared.cli: Command line arguments interface for command line tools.
contextInitializer - Variable in class net.shibboleth.shared.cli.AbstractCommandLine: Optional Context initialized.
CYAN - Enum constant in enum class net.shibboleth.shared.cli.AbstractCommandLine.TerminalCodes: Cyan.

D

doRun(T) - Method in class net.shibboleth.shared.cli.AbstractCommandLine: The execution method to override.

E

error(String) - Static method in class net.shibboleth.shared.cli.AbstractCommandLine: Prints the error message to STDERR.

G

getAdditionalSpringResources() - Method in class net.shibboleth.shared.cli.AbstractCommandLine: Return any additional resources that should be prepended to that supplied by the caller.
getApplicationContext() - Method in class net.shibboleth.shared.cli.AbstractCommandLine: Get the Spring context.
getArgumentClass() - Method in class net.shibboleth.shared.cli.AbstractCommandLine: Get the class of the argument object to instantiate.
getLanguageRanges() - Method in class net.shibboleth.shared.cli.AbstractCommandLineArguments: Get the specified RFC4647 language ranges.
getLog() - Method in class net.shibboleth.shared.cli.AbstractCommandLineArguments: Get the logger for this class.
getLogger() - Method in class net.shibboleth.shared.cli.AbstractCommandLine: Get logger.
getLoggingConfiguration() - Method in class net.shibboleth.shared.cli.AbstractCommandLineArguments: Gets the name of the requested logging configuration file from the command line.
getLoggingConfiguration() - Method in interface net.shibboleth.shared.cli.CommandLineArguments: Gets the name of the requested logging configuration file from the command line.
getOtherArgs() - Method in class net.shibboleth.shared.cli.AbstractCommandLineArguments: Get unparsed arguments.
getOtherArgs() - Method in interface net.shibboleth.shared.cli.CommandLineArguments: Get unparsed arguments.
getPropertyFiles() - Method in class net.shibboleth.shared.cli.AbstractCommandLineArguments: Get list of property filenames to load.
getPropertyFiles() - Method in interface net.shibboleth.shared.cli.CommandLineArguments: Get list of property filenames to load.
getVersion() - Method in class net.shibboleth.shared.cli.AbstractCommandLine: Return an appropriate version value.
GREEN - Enum constant in enum class net.shibboleth.shared.cli.AbstractCommandLine.TerminalCodes: Green.

H

help - Variable in class net.shibboleth.shared.cli.AbstractCommandLineArguments: Help has been requested.

I

initLogging(T) - Method in class net.shibboleth.shared.cli.AbstractCommandLine: Initialize the logging subsystem.
isANSI() - Method in class net.shibboleth.shared.cli.AbstractCommandLineArguments: Indicates the presence of the --ansi option.
isANSI() - Method in interface net.shibboleth.shared.cli.CommandLineArguments: Indicates the presence of the --ansi option.
isHelp() - Method in class net.shibboleth.shared.cli.AbstractCommandLineArguments: Indicates the presence of the --help option.
isHelp() - Method in interface net.shibboleth.shared.cli.CommandLineArguments: Indicates the presence of the --help option.
isQuietOutput() - Method in class net.shibboleth.shared.cli.AbstractCommandLineArguments: Indicates the presence of the --quiet option.
isQuietOutput() - Method in interface net.shibboleth.shared.cli.CommandLineArguments: Indicates the presence of the --quiet option.
isVerboseOutput() - Method in class net.shibboleth.shared.cli.AbstractCommandLineArguments: Indicates the presence of the --verbose option.
isVerboseOutput() - Method in interface net.shibboleth.shared.cli.CommandLineArguments: Indicates the presence of the --verbose option.
isVersion() - Method in class net.shibboleth.shared.cli.AbstractCommandLineArguments: Indicates the presence of the --version option.
isVersion() - Method in interface net.shibboleth.shared.cli.CommandLineArguments: Indicates the presence of the --version option.

L

languageRanges - Variable in class net.shibboleth.shared.cli.AbstractCommandLineArguments: RFC4647 language ranges.
logConfig - Variable in class net.shibboleth.shared.cli.AbstractCommandLineArguments: Name of a specific logging configuration, if one has been requested.

N

net.shibboleth.shared.cli - package net.shibboleth.shared.cli: Command line functionality.

O

otherArgs - Variable in class net.shibboleth.shared.cli.AbstractCommandLineArguments: Command-line arguments which are not part of options.

P

printHelp(PrintStream) - Method in class net.shibboleth.shared.cli.AbstractCommandLineArguments: Print default command line help instructions.
printHelp(PrintStream) - Method in interface net.shibboleth.shared.cli.CommandLineArguments: Print default command line help instructions.
propertySources - Variable in class net.shibboleth.shared.cli.AbstractCommandLineArguments: Spring property sources.
PURPLE - Enum constant in enum class net.shibboleth.shared.cli.AbstractCommandLine.TerminalCodes: Purple.

Q

quiet - Variable in class net.shibboleth.shared.cli.AbstractCommandLineArguments: Quiet logging has been requested.

R

RC_INIT - Static variable in class net.shibboleth.shared.cli.AbstractCommandLine: Return code indicating an initialization error, 1 .
RC_IO - Static variable in class net.shibboleth.shared.cli.AbstractCommandLine: Return code indicating an error reading files, 2 .
RC_OK - Static variable in class net.shibboleth.shared.cli.AbstractCommandLine: Return code indicating command completed successfully, 0 .
RC_UNKNOWN - Static variable in class net.shibboleth.shared.cli.AbstractCommandLine: Return code indicating an unknown error occurred, -1 .
RED - Enum constant in enum class net.shibboleth.shared.cli.AbstractCommandLine.TerminalCodes: Red.
RESET - Enum constant in enum class net.shibboleth.shared.cli.AbstractCommandLine.TerminalCodes: Reset.
run(String[]) - Method in class net.shibboleth.shared.cli.AbstractCommandLine: Run method.

S

setCaseSensitiveOptions(boolean) - Method in class net.shibboleth.shared.cli.AbstractCommandLine: Sets whether JCommander parses options case-sensitively or not.
setContextInitializer(ApplicationContextInitializer<? super FilesystemGenericApplicationContext>) - Method in class net.shibboleth.shared.cli.AbstractCommandLine: Set a context initializer.
setLoggingProperty(String) - Method in class net.shibboleth.shared.cli.AbstractCommandLine: Set the logback configuration to a specific location.
setLoggingToLocalResource(String) - Method in class net.shibboleth.shared.cli.AbstractCommandLine: Set the logback configuration to a specific package-local resource.

T

TerminalCodes(String) - Constructor for enum class net.shibboleth.shared.cli.AbstractCommandLine.TerminalCodes: Constructor.

V

validate() - Method in class net.shibboleth.shared.cli.AbstractCommandLineArguments: Validate the parameter set.
validate() - Method in interface net.shibboleth.shared.cli.CommandLineArguments: Validate the parameter set.
valueOf(String) - Static method in enum class net.shibboleth.shared.cli.AbstractCommandLine.TerminalCodes: Returns the enum constant of this class with the specified name.
values() - Static method in enum class net.shibboleth.shared.cli.AbstractCommandLine.TerminalCodes: Returns an array containing the constants of this enum class, in the order they are declared.
verbose - Variable in class net.shibboleth.shared.cli.AbstractCommandLineArguments: Verbose logging has been requested.
version - Variable in class net.shibboleth.shared.cli.AbstractCommandLineArguments: Version has been requested.

W

WHITE - Enum constant in enum class net.shibboleth.shared.cli.AbstractCommandLine.TerminalCodes: White.

Y

YELLOW - Enum constant in enum class net.shibboleth.shared.cli.AbstractCommandLine.TerminalCodes: Yellow.

A B C D E G H I L N O P Q R S T V W Y
All Classes and Interfaces|All Packages|Constant Field Values