A B C D E F G H I J K L M N O P Q R S T U V W X _
All Classes All Packages

A

accept(Path) - Method in class org.apache.karaf.shell.support.completers.FileCompleter

Action - Interface in org.apache.karaf.shell.api.action

An action is the default implementation of the commands in karaf.

ActionCommand - Class in org.apache.karaf.shell.impl.action.command

ActionCommand(ManagerImpl, Class<? extends Action>) - Constructor for class org.apache.karaf.shell.impl.action.command.ActionCommand

ActionCommand.DelayedCompleter - Class in org.apache.karaf.shell.impl.action.command

ActionCommand.DelayedParser - Class in org.apache.karaf.shell.impl.action.command

ActionMaskingCallback - Class in org.apache.karaf.shell.impl.action.command

Activator - Class in org.apache.karaf.shell.impl.console.osgi

Activator() - Constructor for class org.apache.karaf.shell.impl.console.osgi.Activator

addCommandOption(String, String...) - Method in class org.apache.karaf.shell.support.RegexCommandLoggingFilter

addContent(Object...) - Method in class org.apache.karaf.shell.support.table.Row

addContent(List<Object>) - Method in class org.apache.karaf.shell.support.table.Row

addException(Exception) - Method in exception org.apache.karaf.shell.support.MultiException

Deprecated.

addingService(ServiceReference<Object>) - Method in class org.apache.karaf.shell.impl.console.osgi.CommandTracker

addingService(ServiceReference<CommandSessionListener>) - Method in class org.apache.karaf.shell.impl.console.osgi.ListenerTracker

addingService(ServiceReference<Converter>) - Method in class org.apache.karaf.shell.impl.console.osgi.ConverterTracker

addRegEx(String) - Method in class org.apache.karaf.shell.support.RegexCommandLoggingFilter

addRegEx(String, int) - Method in class org.apache.karaf.shell.support.RegexCommandLoggingFilter

addRegEx(String, int, String) - Method in class org.apache.karaf.shell.support.RegexCommandLoggingFilter

addRow() - Method in class org.apache.karaf.shell.support.table.ShellTable

addSignalListener(SignalListener) - Method in interface org.apache.karaf.shell.api.console.Terminal

Add a global listener for all signals.

addSignalListener(SignalListener) - Method in class org.apache.karaf.shell.impl.console.JLineTerminal

addSignalListener(SignalListener) - Method in class org.apache.karaf.shell.support.terminal.SignalSupport

addSignalListener(SignalListener, EnumSet<Signal>) - Method in interface org.apache.karaf.shell.api.console.Terminal

Add a qualified listener for the specific set of signal.

addSignalListener(SignalListener, EnumSet<Signal>) - Method in class org.apache.karaf.shell.impl.console.JLineTerminal

addSignalListener(SignalListener, EnumSet<Signal>) - Method in class org.apache.karaf.shell.support.terminal.SignalSupport

addSignalListener(SignalListener, Signal...) - Method in interface org.apache.karaf.shell.api.console.Terminal

Add a qualified listener for the specific signal.

addSignalListener(SignalListener, Signal...) - Method in class org.apache.karaf.shell.impl.console.JLineTerminal

addSignalListener(SignalListener, Signal...) - Method in class org.apache.karaf.shell.support.terminal.SignalSupport

afterExecute(CommandSession, CharSequence, Exception) - Method in class org.apache.karaf.shell.impl.console.osgi.EventAdminListener

afterExecute(CommandSession, CharSequence, Exception) - Method in class org.apache.karaf.shell.impl.console.osgi.LoggingCommandSessionListener

afterExecute(CommandSession, CharSequence, Object) - Method in class org.apache.karaf.shell.impl.console.osgi.EventAdminListener

afterExecute(CommandSession, CharSequence, Object) - Method in class org.apache.karaf.shell.impl.console.osgi.LoggingCommandSessionListener

AggregateCompleter - Class in org.apache.karaf.shell.support.completers

Completer which contains multiple completers and aggregates them together.

AggregateCompleter(Collection<Completer>) - Constructor for class org.apache.karaf.shell.support.completers.AggregateCompleter

AggregateServiceTracker - Class in org.apache.karaf.shell.impl.action.osgi

Track multiple services by their type

AggregateServiceTracker(BundleContext) - Constructor for class org.apache.karaf.shell.impl.action.osgi.AggregateServiceTracker

AggregateServiceTracker.State - Class in org.apache.karaf.shell.impl.action.osgi

AliasCommand - Class in org.apache.karaf.shell.impl.console.osgi.secured

AliasCommand(String, String) - Constructor for class org.apache.karaf.shell.impl.console.osgi.secured.AliasCommand

aliases() - Method in annotation type org.apache.karaf.shell.api.action.Option

Specify a list of aliases for this option.

align(HAlign) - Method in class org.apache.karaf.shell.support.table.Col

alignCenter() - Method in class org.apache.karaf.shell.support.table.Col

alignLeft() - Method in class org.apache.karaf.shell.support.table.Col

alignRight() - Method in class org.apache.karaf.shell.support.table.Col

ALRM - org.apache.karaf.shell.api.console.Signal

AnsiBufferedReader(InputStream, int, int, int) - Constructor for class org.apache.karaf.shell.support.ansi.AnsiSplitter.AnsiBufferedReader

AnsiColumn - Class in org.apache.karaf.shell.support.table

Colored support for column.

AnsiColumn(String, int, boolean) - Constructor for class org.apache.karaf.shell.support.table.AnsiColumn

AnsiPrintingWikiVisitor - Class in org.apache.karaf.shell.impl.console.commands.help.wikidoc

Translates the Wiki tags to Ansi escape sequences to display them on the console

AnsiPrintingWikiVisitor(PrintStream, int) - Constructor for class org.apache.karaf.shell.impl.console.commands.help.wikidoc.AnsiPrintingWikiVisitor

AnsiSplitter - Class in org.apache.karaf.shell.support.ansi

AnsiSplitter() - Constructor for class org.apache.karaf.shell.support.ansi.AnsiSplitter

AnsiSplitter.AnsiBufferedReader - Class in org.apache.karaf.shell.support.ansi

Argument - Annotation Type in org.apache.karaf.shell.api.action

Represents a positional argument on a command line (as opposed to an optional named Option

ArgumentCommandLine - Class in org.apache.karaf.shell.support.completers

ArgumentCommandLine(String, int) - Constructor for class org.apache.karaf.shell.support.completers.ArgumentCommandLine

ArgumentCompleter - Class in org.apache.karaf.shell.impl.action.command

ArgumentCompleter(ActionCommand, boolean) - Constructor for class org.apache.karaf.shell.impl.action.command.ArgumentCompleter

argumentPosition() - Method in class org.apache.karaf.shell.support.parsing.GogoParser

array() - Method in class org.apache.felix.gogo.runtime.Parser

Array(Token, List<Token>, Map<Token, Token>) - Constructor for class org.apache.felix.gogo.runtime.Parser.Array

B

beforeExecute(CommandSession, CharSequence) - Method in class org.apache.karaf.shell.impl.console.osgi.EventAdminListener

beforeExecute(CommandSession, CharSequence) - Method in class org.apache.karaf.shell.impl.console.osgi.LoggingCommandSessionListener

bold() - Method in class org.apache.karaf.shell.support.table.Col

bold(boolean) - Method in class org.apache.karaf.shell.impl.console.commands.help.wikidoc.AnsiPrintingWikiVisitor

bold(boolean) - Method in interface org.apache.karaf.shell.impl.console.commands.help.wikidoc.WikiVisitor

bold(boolean) - Method in class org.apache.karaf.shell.support.table.Col

Branding - Class in org.apache.karaf.shell.impl.console

BreakException() - Constructor for exception org.apache.karaf.shell.impl.console.commands.Procedural.BreakException

build(ActionCommand) - Static method in class org.apache.karaf.shell.impl.action.command.ActionMaskingCallback

buildCommandLine(Session, String, int) - Static method in class org.apache.karaf.shell.impl.console.parsing.CommandLineParser

buildCommandLine(Session, String, int, AtomicInteger) - Static method in class org.apache.karaf.shell.impl.console.parsing.CommandLineParser

bundle(Bundle) - Method in class org.apache.karaf.shell.impl.console.osgi.Converters

BundleHelpProvider - Class in org.apache.karaf.shell.impl.console.commands.help

BundleHelpProvider() - Constructor for class org.apache.karaf.shell.impl.console.commands.help.BundleHelpProvider

BUS - org.apache.karaf.shell.api.console.Signal

C

Candidate - Class in org.apache.karaf.shell.api.console

Candidate(String) - Constructor for class org.apache.karaf.shell.api.console.Candidate

Candidate(String, boolean) - Constructor for class org.apache.karaf.shell.api.console.Candidate

Candidate(String, String, String, String, String, String, boolean) - Constructor for class org.apache.karaf.shell.api.console.Candidate

canPauseResume() - Method in class org.apache.karaf.shell.impl.console.JLineTerminal

caseSensitive() - Method in annotation type org.apache.karaf.shell.api.action.Completion

When using a static completer, indicates if completion should be done case sensitive or not.

censor() - Method in annotation type org.apache.karaf.shell.api.action.Argument

Censor the argument in the console.

censor() - Method in annotation type org.apache.karaf.shell.api.action.Option

Censor the argument in the console.

center - org.apache.karaf.shell.support.table.HAlign

Center align.

checkData() - Method in class org.apache.karaf.shell.impl.console.CommandsCompleter

CHLD - org.apache.karaf.shell.api.console.Signal

clear() - Method in interface org.apache.karaf.shell.api.console.History

Clear the history.

clear() - Method in class org.apache.karaf.shell.impl.console.HistoryWrapper

close() - Method in interface org.apache.karaf.shell.api.console.Session

Close this session.

close() - Method in class org.apache.karaf.shell.impl.action.osgi.AggregateServiceTracker

close() - Method in class org.apache.karaf.shell.impl.action.osgi.MultiServiceTracker

close() - Method in class org.apache.karaf.shell.impl.action.osgi.SingleServiceTracker

close() - Method in class org.apache.karaf.shell.impl.console.ConsoleSessionImpl

close() - Method in class org.apache.karaf.shell.impl.console.HeadlessSessionImpl

close() - Method in class org.apache.karaf.shell.impl.console.JLineTerminal

close() - Method in class org.apache.karaf.shell.impl.console.osgi.EventAdminListener

close() - Method in class org.apache.karaf.shell.impl.console.osgi.LocalConsoleManager

close() - Method in class org.apache.karaf.shell.support.ansi.AnsiSplitter.AnsiBufferedReader

closure() - Method in class org.apache.felix.gogo.runtime.Parser

Closure(Token, Parser.Program) - Constructor for class org.apache.felix.gogo.runtime.Parser.Closure

Col - Class in org.apache.karaf.shell.support.table

Column definition.

Col(String) - Constructor for class org.apache.karaf.shell.support.table.Col

COLOR_BLUE - Static variable in class org.apache.karaf.shell.support.ansi.SimpleAnsi

COLOR_CYAN - Static variable in class org.apache.karaf.shell.support.ansi.SimpleAnsi

COLOR_DEFAULT - Static variable in class org.apache.karaf.shell.support.ansi.SimpleAnsi

COLOR_GREEN - Static variable in class org.apache.karaf.shell.support.ansi.SimpleAnsi

COLOR_MAGENTA - Static variable in class org.apache.karaf.shell.support.ansi.SimpleAnsi

COLOR_RED - Static variable in class org.apache.karaf.shell.support.ansi.SimpleAnsi

COLOR_YELLOW - Static variable in class org.apache.karaf.shell.support.ansi.SimpleAnsi

colorProvider(Function<String, String>) - Method in class org.apache.karaf.shell.support.table.Col

column(String) - Method in class org.apache.karaf.shell.support.table.ShellTable

column(Col) - Method in class org.apache.karaf.shell.support.table.ShellTable

Command - Interface in org.apache.karaf.shell.api.console

A Command is a named Function which also provides completion.

Command - Annotation Type in org.apache.karaf.shell.api.action

Used to denote a class represents a command which is executable within a shell/scope or as a command line process.

CommandException - Exception in org.apache.karaf.shell.support

Base class for exceptions thrown when executing commands.

CommandException() - Constructor for exception org.apache.karaf.shell.support.CommandException

CommandException(String) - Constructor for exception org.apache.karaf.shell.support.CommandException

CommandException(String, String) - Constructor for exception org.apache.karaf.shell.support.CommandException

CommandException(String, String, Throwable) - Constructor for exception org.apache.karaf.shell.support.CommandException

CommandException(String, Throwable) - Constructor for exception org.apache.karaf.shell.support.CommandException

CommandException(Throwable) - Constructor for exception org.apache.karaf.shell.support.CommandException

CommandExtender - Class in org.apache.karaf.shell.impl.action.osgi

Bundle extender scanning for command classes.

CommandExtender(Registry) - Constructor for class org.apache.karaf.shell.impl.action.osgi.CommandExtender

CommandExtension - Class in org.apache.karaf.shell.impl.action.osgi

Commands extension

CommandExtension(Bundle, Registry) - Constructor for class org.apache.karaf.shell.impl.action.osgi.CommandExtension

CommandLine - Interface in org.apache.karaf.shell.api.console

A CommandLine object will be created and given the Completers to ease their work.

CommandLineImpl - Class in org.apache.karaf.shell.support.parsing

The result of a delimited buffer.

CommandLineImpl(String[], int, int, int, String) - Constructor for class org.apache.karaf.shell.support.parsing.CommandLineImpl

CommandLineParser - Class in org.apache.karaf.shell.impl.console.parsing

CommandLineParser() - Constructor for class org.apache.karaf.shell.impl.console.parsing.CommandLineParser

CommandListHelpProvider - Class in org.apache.karaf.shell.impl.console.commands.help

CommandListHelpProvider() - Constructor for class org.apache.karaf.shell.impl.console.commands.help.CommandListHelpProvider

CommandLoggingFilter - Interface in org.apache.karaf.shell.api.console

Used to filter a command before it gets logged.

CommandNamesCompleter - Class in org.apache.karaf.shell.impl.console

CommandNamesCompleter - Class in org.apache.karaf.shell.support.completers

Marker class.

CommandNamesCompleter() - Constructor for class org.apache.karaf.shell.impl.console.CommandNamesCompleter

CommandNamesCompleter() - Constructor for class org.apache.karaf.shell.support.completers.CommandNamesCompleter

CommandsCompleter - Class in org.apache.karaf.shell.impl.console

Overall command line completer.

CommandsCompleter - Class in org.apache.karaf.shell.support.completers

Marker class.

CommandsCompleter() - Constructor for class org.apache.karaf.shell.support.completers.CommandsCompleter

CommandsCompleter(SessionFactory, Session) - Constructor for class org.apache.karaf.shell.impl.console.CommandsCompleter

CommandsCompleter.ScopeComparator - Class in org.apache.karaf.shell.impl.console

CommandsHelpProvider - Class in org.apache.karaf.shell.impl.console.commands.help

CommandsHelpProvider() - Constructor for class org.apache.karaf.shell.impl.console.commands.help.CommandsHelpProvider

CommandTracker - Class in org.apache.karaf.shell.impl.console.osgi

CommandTracker(SessionFactory, BundleContext) - Constructor for class org.apache.karaf.shell.impl.console.osgi.CommandTracker

CommandWrapper - Class in org.apache.karaf.shell.impl.console

CommandWrapper(Command) - Constructor for class org.apache.karaf.shell.impl.console.CommandWrapper

compare(String, String) - Method in class org.apache.karaf.shell.impl.console.CommandsCompleter.ScopeComparator

compareTo(Candidate) - Method in class org.apache.karaf.shell.api.console.Candidate

complete() - Method in class org.apache.karaf.shell.api.console.Candidate

complete(Session, CommandLine, List<String>) - Method in interface org.apache.karaf.shell.api.console.Completer

populate possible completion candidates.

complete(Session, CommandLine, List<String>) - Method in class org.apache.karaf.shell.impl.action.command.ActionCommand.DelayedCompleter

complete(Session, CommandLine, List<String>) - Method in class org.apache.karaf.shell.impl.action.command.ArgumentCompleter

complete(Session, CommandLine, List<String>) - Method in class org.apache.karaf.shell.impl.console.CommandNamesCompleter

complete(Session, CommandLine, List<String>) - Method in class org.apache.karaf.shell.impl.console.CommandsCompleter

complete(Session, CommandLine, List<String>) - Method in class org.apache.karaf.shell.support.completers.AggregateCompleter

complete(Session, CommandLine, List<String>) - Method in class org.apache.karaf.shell.support.completers.FileCompleter

complete(Session, CommandLine, List<String>) - Method in class org.apache.karaf.shell.support.completers.NullCompleter

complete(Session, CommandLine, List<String>) - Method in class org.apache.karaf.shell.support.completers.StringsCompleter

complete(Session, CommandLine, List<String>) - Method in class org.apache.karaf.shell.support.completers.UriCompleter

complete(LineReader, ParsedLine, List<Candidate>) - Method in class org.apache.karaf.shell.impl.console.CommandsCompleter

completeCandidates(Session, CommandLine, List<Candidate>) - Method in interface org.apache.karaf.shell.api.console.Completer

completeCandidates(Session, CommandLine, List<Candidate>) - Method in class org.apache.karaf.shell.impl.action.command.ActionCommand.DelayedCompleter

completeCandidates(Session, CommandLine, List<Candidate>) - Method in class org.apache.karaf.shell.impl.action.command.ArgumentCompleter

completeCandidates(Session, CommandLine, List<Candidate>) - Method in class org.apache.karaf.shell.impl.console.CommandsCompleter

completeCandidates(Session, CommandLine, List<Candidate>) - Method in class org.apache.karaf.shell.support.completers.AggregateCompleter

completeCandidates(Session, CommandLine, List<Candidate>) - Method in class org.apache.karaf.shell.support.completers.FileCompleter

completeCandidates(Session, CommandLine, List<Candidate>) - Method in class org.apache.karaf.shell.support.completers.UriCompleter

Completer - Interface in org.apache.karaf.shell.api.console

A Completer is used by the console to complete the command line.

Completion - Annotation Type in org.apache.karaf.shell.api.action

The @Completion annotation can be used on a field annotated with Option or Argument to specify the completion method to use for this field.

COMPLETION_MODE - Static variable in interface org.apache.karaf.shell.api.console.Session

COMPLETION_MODE_FIRST - Static variable in interface org.apache.karaf.shell.api.console.Session

COMPLETION_MODE_GLOBAL - Static variable in interface org.apache.karaf.shell.api.console.Session

COMPLETION_MODE_SUBSHELL - Static variable in interface org.apache.karaf.shell.api.console.Session

configurationEvent(ConfigurationEvent) - Method in class org.apache.karaf.shell.impl.console.osgi.secured.SecuredSessionFactoryImpl

connect() - Method in class org.apache.karaf.shell.impl.console.loader.JarInJarURLConnection

ConsoleSessionImpl - Class in org.apache.karaf.shell.impl.console

ConsoleSessionImpl(SessionFactory, CommandProcessor, ThreadIO, InputStream, PrintStream, PrintStream, Terminal, String, Runnable) - Constructor for class org.apache.karaf.shell.impl.console.ConsoleSessionImpl

CONT - org.apache.karaf.shell.api.console.Signal

ContinueException() - Constructor for exception org.apache.karaf.shell.impl.console.commands.Procedural.ContinueException

convert(Class<?>, Object) - Method in class org.apache.karaf.shell.impl.console.osgi.Converters

convert(Object, Type) - Method in class org.apache.karaf.shell.support.converter.DefaultConverter

convert(Object, ReifiedType) - Method in class org.apache.karaf.shell.support.converter.DefaultConverter

convert(Action, Object, Type) - Method in class org.apache.karaf.shell.impl.action.command.DefaultActionPreparator

Converters - Class in org.apache.karaf.shell.impl.console.osgi

Converters(BundleContext) - Constructor for class org.apache.karaf.shell.impl.console.osgi.Converters

ConverterTracker - Class in org.apache.karaf.shell.impl.console.osgi

Tracker for Converter.

ConverterTracker(SessionFactoryImpl, BundleContext) - Constructor for class org.apache.karaf.shell.impl.console.osgi.ConverterTracker

convertFromString(String, Class, Object) - Method in class org.apache.karaf.shell.support.converter.DefaultConverter

convertToNumber(Number, Class) - Method in class org.apache.karaf.shell.support.converter.DefaultConverter

create(InputStream, PrintStream, PrintStream) - Method in interface org.apache.karaf.shell.api.console.SessionFactory

Create a new headless session.

create(InputStream, PrintStream, PrintStream) - Method in class org.apache.karaf.shell.impl.console.SessionFactoryImpl

create(InputStream, PrintStream, PrintStream, Session) - Method in interface org.apache.karaf.shell.api.console.SessionFactory

Create a new headless session inheriting from the parent session.

create(InputStream, PrintStream, PrintStream, Session) - Method in class org.apache.karaf.shell.impl.console.SessionFactoryImpl

create(InputStream, PrintStream, PrintStream, Terminal, String, Runnable) - Method in interface org.apache.karaf.shell.api.console.SessionFactory

Create new interactive session.

create(InputStream, PrintStream, PrintStream, Terminal, String, Runnable) - Method in class org.apache.karaf.shell.impl.console.SessionFactoryImpl

createNewAction(Session) - Method in class org.apache.karaf.shell.impl.action.command.ActionCommand

createSession(SessionFactory, InputStream, PrintStream, PrintStream, Terminal) - Method in class org.apache.karaf.shell.impl.console.standalone.Main

Allow sub classes of main to change the ConsoleImpl implementation used.

createSessionFactory(ThreadIO) - Method in class org.apache.karaf.shell.impl.console.standalone.Main

createURLStreamHandler(String) - Method in class org.apache.karaf.shell.impl.console.loader.JarInJarURLStreamHandlerFactory

CURRENT_DIR - Static variable in interface org.apache.karaf.shell.impl.console.loader.JarInJarConstants

currentDir() - Method in interface org.apache.karaf.shell.api.console.Session

currentDir() - Method in class org.apache.karaf.shell.impl.console.ConsoleSessionImpl

currentDir() - Method in class org.apache.karaf.shell.impl.console.HeadlessSessionImpl

currentDir(Path) - Method in interface org.apache.karaf.shell.api.console.Session

currentDir(Path) - Method in class org.apache.karaf.shell.impl.console.ConsoleSessionImpl

currentDir(Path) - Method in class org.apache.karaf.shell.impl.console.HeadlessSessionImpl

cursorArgumentIndex() - Method in class org.apache.karaf.shell.support.parsing.GogoParser

cut(String, int) - Method in class org.apache.karaf.shell.support.table.Col

cut(String, int, int) - Static method in class org.apache.karaf.shell.support.ansi.AnsiSplitter

cyan() - Method in class org.apache.karaf.shell.support.table.Col

cyan(boolean) - Method in class org.apache.karaf.shell.support.table.Col

D

debug(Bundle, String) - Method in class org.apache.karaf.shell.impl.action.osgi.CommandExtender

decrement() - Method in class org.apache.karaf.shell.impl.console.commands.SubShellCommand

DEFAULT - Static variable in annotation type org.apache.karaf.shell.api.action.Argument

DEFAULT_KS_COLORS - Static variable in class org.apache.karaf.shell.support.ShellUtil

DEFAULT_PROMPT - Static variable in class org.apache.karaf.shell.impl.console.ConsoleSessionImpl

DEFAULT_REPLACEMENT - Static variable in class org.apache.karaf.shell.support.RegexCommandLoggingFilter

DEFAULT_RPROMPT - Static variable in class org.apache.karaf.shell.impl.console.ConsoleSessionImpl

DEFAULT_STRING - Static variable in annotation type org.apache.karaf.shell.api.action.Argument

DEFAULT_STRING - Static variable in annotation type org.apache.karaf.shell.api.action.Option

DefaultActionPreparator - Class in org.apache.karaf.shell.impl.action.command

DefaultActionPreparator() - Constructor for class org.apache.karaf.shell.impl.action.command.DefaultActionPreparator

DefaultConverter - Class in org.apache.karaf.shell.support.converter

DefaultConverter(Object) - Constructor for class org.apache.karaf.shell.support.converter.DefaultConverter

DefaultParser - Class in org.apache.karaf.shell.support.parsing

DefaultParser() - Constructor for class org.apache.karaf.shell.support.parsing.DefaultParser

DelayedCompleter(Class<?>) - Constructor for class org.apache.karaf.shell.impl.action.command.ActionCommand.DelayedCompleter

DelayedParser(Class<?>) - Constructor for class org.apache.karaf.shell.impl.action.command.ActionCommand.DelayedParser

descr() - Method in class org.apache.karaf.shell.api.console.Candidate

description() - Method in annotation type org.apache.karaf.shell.api.action.Argument

A textual description of the argument.

description() - Method in annotation type org.apache.karaf.shell.api.action.Command

Returns the description of the command which is used to generate command line help.

description() - Method in annotation type org.apache.karaf.shell.api.action.Option

A textual description of the option.

destroy() - Method in class org.apache.karaf.shell.impl.action.osgi.CommandExtension

Destroy - Annotation Type in org.apache.karaf.shell.api.action.lifecycle

A class annotated with Service can have a method annotation with @Destroy in which case the annotated method will be called when the object is destroyed.

detailedDescription() - Method in annotation type org.apache.karaf.shell.api.action.Command

Returns a detailed description of the command.

DISABLE_EOF_EXIT - Static variable in interface org.apache.karaf.shell.api.console.Session

DISABLE_LOGOUT - Static variable in interface org.apache.karaf.shell.api.console.Session

discoverCommands(Session, ClassLoader, String) - Method in class org.apache.karaf.shell.impl.console.standalone.Main

displ() - Method in class org.apache.karaf.shell.api.console.Candidate

doBreak(CommandSession, Process, Object[]) - Method in class org.apache.karaf.shell.impl.console.commands.Procedural

doContinue(CommandSession, Process, Object[]) - Method in class org.apache.karaf.shell.impl.console.commands.Procedural

doCreateExtension(Bundle) - Method in class org.apache.karaf.shell.impl.action.osgi.CommandExtender

doEach(CommandSession, Process, Object[]) - Method in class org.apache.karaf.shell.impl.console.commands.Procedural

doExecute(Session) - Method in class org.apache.karaf.shell.impl.console.commands.ExitCommand

doExecute(Session) - Method in class org.apache.karaf.shell.impl.console.commands.SubShellCommand

doExecute(Session) - Method in class org.apache.karaf.shell.impl.console.commands.TopLevelCommand

doGetPrompt(String, String) - Method in class org.apache.karaf.shell.impl.console.ConsoleSessionImpl

doIf(CommandSession, Process, Object[]) - Method in class org.apache.karaf.shell.impl.console.commands.Procedural

doNot(CommandSession, Process, Object[]) - Method in class org.apache.karaf.shell.impl.console.commands.Procedural

doThrow(CommandSession, Process, Object[]) - Method in class org.apache.karaf.shell.impl.console.commands.Procedural

doTry(CommandSession, Process, Object[]) - Method in class org.apache.karaf.shell.impl.console.commands.Procedural

doUntil(CommandSession, Process, Object[]) - Method in class org.apache.karaf.shell.impl.console.commands.Procedural

doWhile(CommandSession, Process, Object[]) - Method in class org.apache.karaf.shell.impl.console.commands.Procedural

E

echo() - Method in class org.apache.karaf.shell.impl.console.JLineTerminal

echo(boolean) - Method in class org.apache.karaf.shell.impl.console.JLineTerminal

emptyTableText(String) - Method in class org.apache.karaf.shell.support.table.ShellTable

Set text to display if there are no rows in the table.

encoding() - Method in class org.apache.karaf.shell.impl.console.JLineTerminal

end(String) - Method in class org.apache.felix.gogo.runtime.Parser

endPara() - Method in class org.apache.karaf.shell.impl.console.commands.help.wikidoc.AnsiPrintingWikiVisitor

endPara() - Method in interface org.apache.karaf.shell.impl.console.commands.help.wikidoc.WikiVisitor

enterRawMode() - Method in class org.apache.karaf.shell.impl.console.JLineTerminal

enumeration(String) - Method in class org.apache.karaf.shell.impl.console.commands.help.wikidoc.AnsiPrintingWikiVisitor

enumeration(String) - Method in interface org.apache.karaf.shell.impl.console.commands.help.wikidoc.WikiVisitor

eof() - Method in class org.apache.karaf.shell.support.parsing.GogoParser

error(String, Throwable) - Method in class org.apache.karaf.shell.impl.action.osgi.CommandExtender

escaped() - Method in class org.apache.karaf.shell.support.parsing.GogoParser

EventAdminListener - Class in org.apache.karaf.shell.impl.console.osgi

EventAdminListener(BundleContext) - Constructor for class org.apache.karaf.shell.impl.console.osgi.EventAdminListener

Executable(Token) - Constructor for class org.apache.felix.gogo.runtime.Parser.Executable

execute() - Method in interface org.apache.karaf.shell.api.action.Action

Execute the action which has been injected with services from the registry, options and arguments from the command line.

execute(CharSequence) - Method in interface org.apache.karaf.shell.api.console.Session

Execute a program in this session.

execute(CharSequence) - Method in class org.apache.karaf.shell.impl.console.ConsoleSessionImpl

execute(CharSequence) - Method in class org.apache.karaf.shell.impl.console.HeadlessSessionImpl

execute(CommandSession, List<Object>) - Method in class org.apache.karaf.shell.impl.console.CommandWrapper

execute(CommandSession, List<Object>) - Method in class org.apache.karaf.shell.impl.console.osgi.secured.SecuredCommand

execute(Session, List<Object>) - Method in interface org.apache.karaf.shell.api.console.Function

Execute this function within the given Session and with the given arguments.

execute(Session, List<Object>) - Method in class org.apache.karaf.shell.impl.action.command.ActionCommand

execute(Session, List<Object>) - Method in class org.apache.karaf.shell.impl.console.commands.help.HelpCommand

execute(Session, List<Object>) - Method in class org.apache.karaf.shell.impl.console.commands.TopLevelCommand

execute(Session, List<Object>) - Method in class org.apache.karaf.shell.impl.console.osgi.secured.SecuredCommand

ExitCommand - Class in org.apache.karaf.shell.impl.console.commands

ExitCommand() - Constructor for class org.apache.karaf.shell.impl.console.commands.ExitCommand

expect(String) - Method in class org.apache.felix.gogo.runtime.Parser

expectNotNull() - Method in class org.apache.felix.gogo.runtime.Parser

F

FileCompleter - Class in org.apache.karaf.shell.support.completers

A file name completer takes the buffer and issues a list of potential completions.

FileCompleter() - Constructor for class org.apache.karaf.shell.support.completers.FileCompleter

FileOrUriCompleter - Class in org.apache.karaf.shell.support.completers

FileOrUriCompleter() - Constructor for class org.apache.karaf.shell.support.completers.FileOrUriCompleter

filter() - Method in annotation type org.apache.karaf.shell.api.action.lifecycle.Reference

filter(CharSequence) - Method in interface org.apache.karaf.shell.api.console.CommandLoggingFilter

filter(CharSequence) - Method in class org.apache.karaf.shell.support.RegexCommandLoggingFilter

filter(String, ParsedLine) - Method in class org.apache.karaf.shell.impl.action.command.ActionMaskingCallback

first() - Method in interface org.apache.karaf.shell.api.console.History

First available index.

first() - Method in class org.apache.karaf.shell.impl.console.HistoryWrapper

flush() - Method in class org.apache.karaf.shell.impl.console.JLineTerminal

forceAscii() - Method in class org.apache.karaf.shell.support.table.ShellTable

format(Object, int, Converter) - Method in class org.apache.karaf.shell.impl.console.osgi.Converters

FPE - org.apache.karaf.shell.api.console.Signal

Function - Interface in org.apache.karaf.shell.api.console

This interface represents some code that can be executed in the Session.

G

GenericType - Class in org.apache.karaf.shell.support.converter

GenericType(Class, GenericType...) - Constructor for class org.apache.karaf.shell.support.converter.GenericType

GenericType(Type) - Constructor for class org.apache.karaf.shell.support.converter.GenericType

get(int) - Method in interface org.apache.karaf.shell.api.console.History

Command at the given index.

get(int) - Method in class org.apache.karaf.shell.impl.console.HistoryWrapper

get(String) - Method in interface org.apache.karaf.shell.api.console.Session

Get the value of a variable.

get(String) - Static method in enum org.apache.karaf.shell.api.console.Signal

get(String) - Method in class org.apache.karaf.shell.impl.console.ConsoleSessionImpl

get(String) - Method in class org.apache.karaf.shell.impl.console.HeadlessSessionImpl

get(CommandSession, String) - Method in class org.apache.karaf.shell.impl.console.commands.Procedural

getActionClass() - Method in class org.apache.karaf.shell.impl.action.command.ActionCommand

getActualTypeArgument(int) - Method in class org.apache.karaf.shell.support.converter.GenericType

getActualTypeArgument(int) - Method in class org.apache.karaf.shell.support.converter.ReifiedType

Access to a type argument.

getApplication() - Method in class org.apache.karaf.shell.impl.console.standalone.Main

getArgumentPosition() - Method in interface org.apache.karaf.shell.api.console.CommandLine

Retrieve the position of the cursor within the argument

getArgumentPosition() - Method in class org.apache.karaf.shell.support.completers.ArgumentCommandLine

getArgumentPosition() - Method in class org.apache.karaf.shell.support.parsing.CommandLineImpl

getArguments() - Method in interface org.apache.karaf.shell.api.console.CommandLine

List of arguments on the current command.

getArguments() - Method in class org.apache.karaf.shell.support.completers.ArgumentCommandLine

getArguments() - Method in class org.apache.karaf.shell.support.parsing.CommandLineImpl

getAttributes() - Method in class org.apache.karaf.shell.impl.console.JLineTerminal

getAttributes() - Method in class org.apache.karaf.shell.impl.console.KarafTerminal

getBoolean(Session, String) - Static method in class org.apache.karaf.shell.support.ShellUtil

getBooleanCapability(InfoCmp.Capability) - Method in class org.apache.karaf.shell.impl.console.JLineTerminal

getBuffer() - Method in interface org.apache.karaf.shell.api.console.CommandLine

Retrieve the full buffer.

getBuffer() - Method in class org.apache.karaf.shell.support.completers.ArgumentCommandLine

getBuffer() - Method in class org.apache.karaf.shell.support.parsing.CommandLineImpl

getBufferPosition() - Method in interface org.apache.karaf.shell.api.console.CommandLine

Retrieve the position of the cursor within the command line.

getBufferPosition() - Method in class org.apache.karaf.shell.support.completers.ArgumentCommandLine

getBufferPosition() - Method in class org.apache.karaf.shell.support.parsing.CommandLineImpl

getBufferSize() - Method in class org.apache.karaf.shell.impl.console.JLineTerminal

getBundleName(Bundle) - Static method in class org.apache.karaf.shell.support.ShellUtil

getCauses() - Method in exception org.apache.karaf.shell.support.MultiException

Deprecated.

getColorMap(Session, String, String) - Static method in class org.apache.karaf.shell.support.ShellUtil

getCommand() - Method in class org.apache.karaf.shell.impl.console.CommandWrapper

getCommand(String, String) - Method in interface org.apache.karaf.shell.api.console.Registry

Get the actual command with the corresponding scope and name.

getCommand(String, String) - Method in class org.apache.karaf.shell.impl.action.osgi.RegistryImpl

getCommand(String, String) - Method in class org.apache.karaf.shell.impl.console.RegistryImpl

getCommandNameWithoutGlobalPrefix(Session, String) - Static method in class org.apache.karaf.shell.support.NameScoping

Return the name of the command which can omit the global scope prefix if the command starts with the same prefix as the current application.

getCommandProcessor() - Method in class org.apache.karaf.shell.impl.console.SessionFactoryImpl

getCommands() - Method in interface org.apache.karaf.shell.api.console.Registry

Return a list of available commands.

getCommands() - Method in class org.apache.karaf.shell.impl.action.osgi.RegistryImpl

getCommands() - Method in class org.apache.karaf.shell.impl.console.RegistryImpl

getCompleter(boolean) - Method in interface org.apache.karaf.shell.api.console.Command

Retrieve the completer associated with this command.

getCompleter(boolean) - Method in class org.apache.karaf.shell.impl.action.command.ActionCommand

getCompleter(boolean) - Method in class org.apache.karaf.shell.impl.console.commands.help.HelpCommand

getCompleter(boolean) - Method in class org.apache.karaf.shell.impl.console.commands.TopLevelCommand

getCompleter(boolean) - Method in class org.apache.karaf.shell.impl.console.osgi.secured.SecuredCommand

getCompleter(Class<?>) - Method in class org.apache.karaf.shell.impl.action.command.ActionCommand

getCompletionType(Session) - Method in class org.apache.karaf.shell.impl.console.CommandsCompleter

getConsole() - Method in interface org.apache.karaf.shell.api.console.Session

Return the PrintStream for the console.

getConsole() - Method in class org.apache.karaf.shell.impl.console.ConsoleSessionImpl

getConsole() - Method in class org.apache.karaf.shell.impl.console.HeadlessSessionImpl

getContent(String) - Method in class org.apache.karaf.shell.support.table.AnsiColumn

getCurrentScopes(Session) - Method in class org.apache.karaf.shell.impl.console.CommandsCompleter

getCurrentSubShell(Session) - Method in class org.apache.karaf.shell.impl.console.CommandsCompleter

getCurrentUserName() - Static method in class org.apache.karaf.shell.support.ShellUtil

getCursorArgument() - Method in interface org.apache.karaf.shell.api.console.CommandLine

Retrieve the argument for the cursor position

getCursorArgument() - Method in class org.apache.karaf.shell.support.completers.ArgumentCommandLine

getCursorArgument() - Method in class org.apache.karaf.shell.support.parsing.CommandLineImpl

getCursorArgumentIndex() - Method in interface org.apache.karaf.shell.api.console.CommandLine

Retrieve the argument index for the cursor position

getCursorArgumentIndex() - Method in class org.apache.karaf.shell.support.completers.ArgumentCommandLine

getCursorArgumentIndex() - Method in class org.apache.karaf.shell.support.parsing.CommandLineImpl

getCursorPosition(IntConsumer) - Method in class org.apache.karaf.shell.impl.console.JLineTerminal

getDefaultValue(Action, Field) - Method in class org.apache.karaf.shell.impl.action.command.DefaultActionPreparator

getDefaultValueString(Object) - Method in class org.apache.karaf.shell.impl.action.command.DefaultActionPreparator

getDescription() - Method in interface org.apache.karaf.shell.api.console.Command

Retrieve the description of this command.

getDescription() - Method in class org.apache.karaf.shell.impl.action.command.ActionCommand

getDescription() - Method in class org.apache.karaf.shell.impl.console.commands.ExitCommand

getDescription() - Method in class org.apache.karaf.shell.impl.console.commands.help.HelpCommand

getDescription() - Method in class org.apache.karaf.shell.impl.console.commands.SubShellCommand

getDescription() - Method in class org.apache.karaf.shell.impl.console.osgi.secured.SecuredCommand

getDiscoveryResource() - Method in class org.apache.karaf.shell.impl.console.standalone.Main

Sub classes can override so that their registered commands do not conflict with the default shell implementation.

getDisplay(Terminal, Path) - Method in class org.apache.karaf.shell.support.completers.FileCompleter

getEncoding() - Static method in class org.apache.karaf.shell.impl.console.osgi.LocalConsoleManager

Get the default encoding.

getFactory() - Method in interface org.apache.karaf.shell.api.console.Session

Retrieve the SessionFactory associated with this Session.

getFactory() - Method in class org.apache.karaf.shell.impl.console.ConsoleSessionImpl

getFactory() - Method in class org.apache.karaf.shell.impl.console.HeadlessSessionImpl

getFilters() - Method in class org.apache.karaf.shell.impl.console.osgi.LoggingCommandSessionListener

getGroup() - Method in class org.apache.karaf.shell.support.RegexCommandLoggingFilter

getHeight() - Method in interface org.apache.karaf.shell.api.console.Terminal

Height of the terminal.

getHeight() - Method in class org.apache.karaf.shell.impl.console.JLineTerminal

getHelp(Session, String) - Method in class org.apache.karaf.shell.impl.console.commands.help.BundleHelpProvider

getHelp(Session, String) - Method in class org.apache.karaf.shell.impl.console.commands.help.CommandListHelpProvider

getHelp(Session, String) - Method in class org.apache.karaf.shell.impl.console.commands.help.CommandsHelpProvider

getHelp(Session, String) - Method in class org.apache.karaf.shell.impl.console.commands.help.HelpCommand

getHelp(Session, String) - Method in interface org.apache.karaf.shell.impl.console.commands.help.HelpProvider

getHelp(Session, String) - Method in class org.apache.karaf.shell.impl.console.commands.help.ShellHelpProvider

getHelp(Session, String) - Method in class org.apache.karaf.shell.impl.console.commands.help.SimpleHelpProvider

getHelp(Session, String) - Method in class org.apache.karaf.shell.impl.console.commands.help.SingleCommandHelpProvider

getHistory() - Method in interface org.apache.karaf.shell.api.console.Session

Retrieve the History associated with this Session or null if this Session is headless.

getHistory() - Method in class org.apache.karaf.shell.impl.console.ConsoleSessionImpl

getHistory() - Method in class org.apache.karaf.shell.impl.console.HeadlessSessionImpl

getHistoryFile() - Method in class org.apache.karaf.shell.impl.console.ConsoleSessionImpl

Subclasses can override to use a different history file.

getInputStream() - Method in class org.apache.karaf.shell.impl.console.loader.JarInJarURLConnection

getKeyboard() - Method in interface org.apache.karaf.shell.api.console.Session

Return the input stream that is the first of the pipeline.

getKeyboard() - Method in class org.apache.karaf.shell.impl.console.ConsoleSessionImpl

getKeyboard() - Method in class org.apache.karaf.shell.impl.console.HeadlessSessionImpl

getKsColorMap(Session) - Static method in class org.apache.karaf.shell.support.ShellUtil

getMissingServices() - Method in class org.apache.karaf.shell.impl.action.osgi.AggregateServiceTracker.State

getMultiServices() - Method in class org.apache.karaf.shell.impl.action.osgi.AggregateServiceTracker.State

getName() - Method in interface org.apache.karaf.shell.api.console.Command

Retrieve the name of this command.

getName() - Method in class org.apache.karaf.shell.impl.action.command.ActionCommand

getName() - Method in class org.apache.karaf.shell.impl.console.commands.ExitCommand

getName() - Method in class org.apache.karaf.shell.impl.console.commands.help.HelpCommand

getName() - Method in class org.apache.karaf.shell.impl.console.commands.SubShellCommand

getName() - Method in class org.apache.karaf.shell.impl.console.JLineTerminal

getName() - Method in class org.apache.karaf.shell.impl.console.osgi.secured.AliasCommand

getName() - Method in class org.apache.karaf.shell.impl.console.osgi.secured.SecuredCommand

getNiceHelp() - Method in exception org.apache.karaf.shell.support.CommandException

getNumeric() - Method in enum org.apache.karaf.shell.api.console.Signal

getNumericCapability(InfoCmp.Capability) - Method in class org.apache.karaf.shell.impl.console.JLineTerminal

getPalette() - Method in class org.apache.karaf.shell.impl.console.JLineTerminal

getParser() - Method in interface org.apache.karaf.shell.api.console.Command

Retrieve the parser associated with this command or null for the default one.

getParser() - Method in class org.apache.karaf.shell.impl.action.command.ActionCommand

getParser() - Method in class org.apache.karaf.shell.impl.console.commands.help.HelpCommand

getParser() - Method in class org.apache.karaf.shell.impl.console.commands.TopLevelCommand

getParser() - Method in class org.apache.karaf.shell.impl.console.osgi.secured.SecuredCommand

getPattern() - Method in class org.apache.karaf.shell.support.RegexCommandLoggingFilter

getPrompt() - Method in class org.apache.karaf.shell.impl.console.ConsoleSessionImpl

getRawClass() - Method in class org.apache.karaf.shell.support.converter.ReifiedType

Access to the raw class.

getRegistry() - Method in interface org.apache.karaf.shell.api.console.Session

Retrieve the Registry associated with this Session.

getRegistry() - Method in interface org.apache.karaf.shell.api.console.SessionFactory

Retrieve the Registry used by this SessionFactory.

getRegistry() - Method in class org.apache.karaf.shell.impl.console.ConsoleSessionImpl

getRegistry() - Method in class org.apache.karaf.shell.impl.console.HeadlessSessionImpl

getRegistry() - Method in class org.apache.karaf.shell.impl.console.SessionFactoryImpl

getReplacement() - Method in class org.apache.karaf.shell.support.RegexCommandLoggingFilter

getRPrompt() - Method in class org.apache.karaf.shell.impl.console.ConsoleSessionImpl

getScope() - Method in interface org.apache.karaf.shell.api.console.Command

Retrieve the scope of this command.

getScope() - Method in class org.apache.karaf.shell.impl.action.command.ActionCommand

getScope() - Method in class org.apache.karaf.shell.impl.console.commands.help.HelpCommand

getScope() - Method in class org.apache.karaf.shell.impl.console.commands.TopLevelCommand

getScope() - Method in class org.apache.karaf.shell.impl.console.osgi.secured.AliasCommand

getScope() - Method in class org.apache.karaf.shell.impl.console.osgi.secured.SecuredCommand

getService(Class<T>) - Method in interface org.apache.karaf.shell.api.console.Registry

Obtain a service implementing the given class.

getService(Class<T>) - Method in class org.apache.karaf.shell.impl.action.osgi.RegistryImpl

getService(Class<T>) - Method in class org.apache.karaf.shell.impl.console.RegistryImpl

getServices(Class<T>) - Method in interface org.apache.karaf.shell.api.console.Registry

Obtain a list of services implementing the given class.

getServices(Class<T>) - Method in class org.apache.karaf.shell.impl.action.osgi.RegistryImpl

getServices(Class<T>) - Method in class org.apache.karaf.shell.impl.console.RegistryImpl

getSession() - Method in class org.apache.karaf.shell.impl.console.HeadlessSessionImpl

getSignalListeners(Signal, boolean) - Method in class org.apache.karaf.shell.support.terminal.SignalSupport

getSingleServices() - Method in class org.apache.karaf.shell.impl.action.osgi.AggregateServiceTracker.State

getSize() - Method in class org.apache.karaf.shell.impl.console.JLineTerminal

getSize() - Method in class org.apache.karaf.shell.impl.console.KarafTerminal

getSize() - Method in class org.apache.karaf.shell.support.table.Col

getStringCapability(InfoCmp.Capability) - Method in class org.apache.karaf.shell.impl.console.JLineTerminal

getStrings() - Method in class org.apache.karaf.shell.support.completers.StringsCompleter

getTerminal() - Method in interface org.apache.karaf.shell.api.console.Session

Retrieve the Terminal associated with this Session or null if this Session is headless.

getTerminal() - Method in class org.apache.karaf.shell.impl.console.ConsoleSessionImpl

getTerminal() - Method in class org.apache.karaf.shell.impl.console.HeadlessSessionImpl

getTrackedClass() - Method in class org.apache.karaf.shell.impl.action.osgi.SingleServiceTracker

getType() - Method in interface org.apache.karaf.shell.api.console.Terminal

The infocmp type of this terminal

getType() - Method in class org.apache.karaf.shell.impl.console.JLineTerminal

getUnderlineString(String) - Static method in class org.apache.karaf.shell.support.ShellUtil

getUser() - Method in class org.apache.karaf.shell.impl.console.standalone.Main

getUserDir() - Method in class org.apache.karaf.shell.support.completers.FileCompleter

getUserHome() - Method in class org.apache.karaf.shell.support.completers.FileCompleter

getValueString(Object) - Static method in class org.apache.karaf.shell.support.ShellUtil

getWidth() - Method in interface org.apache.karaf.shell.api.console.Terminal

Width of the terminal.

getWidth() - Method in class org.apache.karaf.shell.impl.console.JLineTerminal

GogoParser - Class in org.apache.karaf.shell.support.parsing

GogoParser(String, int) - Constructor for class org.apache.karaf.shell.support.parsing.GogoParser

group() - Method in class org.apache.karaf.shell.api.console.Candidate

H

HAlign - Enum in org.apache.karaf.shell.support.table

Enumeration type which contains all possible horizontal alignments.

handle(Terminal.Signal) - Method in class org.apache.karaf.shell.impl.console.JLineTerminal

handle(Terminal.Signal, Terminal.SignalHandler) - Method in class org.apache.karaf.shell.impl.console.JLineTerminal

hasFocusSupport() - Method in class org.apache.karaf.shell.impl.console.JLineTerminal

hasMouseSupport() - Method in class org.apache.karaf.shell.impl.console.JLineTerminal

hasService(Class<?>) - Method in interface org.apache.karaf.shell.api.console.Registry

Check whether the registry has a service of the given class.

hasService(Class<?>) - Method in class org.apache.karaf.shell.impl.action.osgi.RegistryImpl

hasService(Class<?>) - Method in class org.apache.karaf.shell.impl.console.RegistryImpl

heading(int, String) - Method in class org.apache.karaf.shell.impl.console.commands.help.wikidoc.AnsiPrintingWikiVisitor

heading(int, String) - Method in interface org.apache.karaf.shell.impl.console.commands.help.wikidoc.WikiVisitor

HeadlessSessionImpl - Class in org.apache.karaf.shell.impl.console

HeadlessSessionImpl(SessionFactory, CommandProcessor, InputStream, PrintStream, PrintStream) - Constructor for class org.apache.karaf.shell.impl.console.HeadlessSessionImpl

HeadlessSessionImpl(SessionFactory, CommandProcessor, InputStream, PrintStream, PrintStream, Session) - Constructor for class org.apache.karaf.shell.impl.console.HeadlessSessionImpl

HELP - Static variable in class org.apache.karaf.shell.impl.action.command.HelpOption

HelpCommand - Class in org.apache.karaf.shell.impl.console.commands.help

HelpCommand(SessionFactory) - Constructor for class org.apache.karaf.shell.impl.console.commands.help.HelpCommand

HelpException(String) - Constructor for exception org.apache.karaf.shell.impl.console.commands.Procedural.HelpException

HelpOption - Class in org.apache.karaf.shell.impl.action.command

HelpOption() - Constructor for class org.apache.karaf.shell.impl.action.command.HelpOption

HelpProvider - Interface in org.apache.karaf.shell.impl.console.commands.help

History - Interface in org.apache.karaf.shell.api.console

Session history.

HistoryWrapper - Class in org.apache.karaf.shell.impl.console

HistoryWrapper(History) - Constructor for class org.apache.karaf.shell.impl.console.HistoryWrapper

HUP - org.apache.karaf.shell.api.console.Signal

I

IGNORE_INTERRUPTS - Static variable in interface org.apache.karaf.shell.api.console.Session

ILL - org.apache.karaf.shell.api.console.Signal

increment() - Method in class org.apache.karaf.shell.impl.console.commands.SubShellCommand

index() - Method in annotation type org.apache.karaf.shell.api.action.Argument

Position of the argument in the command line.

Init - Annotation Type in org.apache.karaf.shell.api.action.lifecycle

A class annotated with Service can have a method annotation with @Init in which case the annotated method will be called after a successful injection.

input() - Method in class org.apache.karaf.shell.impl.console.JLineTerminal

input() - Method in class org.apache.karaf.shell.impl.console.KarafTerminal

INSTANCE - Static variable in class org.apache.karaf.shell.support.completers.NullCompleter

instantiate(Class<? extends T>) - Method in class org.apache.karaf.shell.impl.action.command.ManagerImpl

instantiate(Class<? extends T>, Registry) - Method in class org.apache.karaf.shell.impl.action.command.ManagerImpl

INT - org.apache.karaf.shell.api.console.Signal

INTENSITY_BOLD - Static variable in class org.apache.karaf.shell.support.ansi.SimpleAnsi

INTENSITY_NORMAL - Static variable in class org.apache.karaf.shell.support.ansi.SimpleAnsi

INTERNAL_URL_PROTOCOL - Static variable in interface org.apache.karaf.shell.impl.console.loader.JarInJarConstants

INTERNAL_URL_PROTOCOL_WITH_COLON - Static variable in interface org.apache.karaf.shell.impl.console.loader.JarInJarConstants

invoke(CommandSessionImpl, Object, String, List<Object>) - Method in class org.apache.karaf.shell.impl.console.osgi.secured.SecuredSessionFactoryImpl

invoke(CommandSessionImpl, Object, String, List<Object>) - Method in class org.apache.karaf.shell.impl.console.SessionFactoryImpl

IO - org.apache.karaf.shell.api.console.Signal

IOT - org.apache.karaf.shell.api.console.Signal

IS_LOCAL - Static variable in interface org.apache.karaf.shell.api.console.Session

isAliasVisible(String, String) - Method in class org.apache.karaf.shell.impl.console.osgi.secured.SecuredSessionFactoryImpl

isAnsiSupported() - Method in interface org.apache.karaf.shell.api.console.Terminal

Whether ansi sequences are supported or not.

isAnsiSupported() - Method in class org.apache.karaf.shell.impl.console.JLineTerminal

isAssignable(Object, ReifiedType) - Static method in class org.apache.karaf.shell.support.converter.DefaultConverter

isASystemBundle(BundleContext, Bundle) - Static method in class org.apache.karaf.shell.support.ShellUtil

Check if a bundle is a system bundle (start level minor than 50).

isDelimiter(String, int) - Method in class org.apache.karaf.shell.impl.action.command.ArgumentCompleter

Returns true if the specified character is a whitespace parameter.

isDelimiterChar(String, int) - Method in class org.apache.karaf.shell.impl.action.command.ArgumentCompleter

The character is a delimiter if it is whitespace, and the preceding character is not an escape character.

isEchoEnabled() - Method in interface org.apache.karaf.shell.api.console.Terminal

Whether echo is enabled or not.

isEchoEnabled() - Method in class org.apache.karaf.shell.impl.console.JLineTerminal

isEscaped(String, int) - Method in class org.apache.karaf.shell.impl.action.command.ArgumentCompleter

isGlobalScope(Session, String) - Static method in class org.apache.karaf.shell.support.NameScoping

Return true if the given scope is the global scope so that it can be hidden from help messages.

isMultiScopeMode() - Method in class org.apache.karaf.shell.impl.console.standalone.Main

Returns whether or not we are in multi-scope mode.

isMultiScopeMode(Session) - Static method in class org.apache.karaf.shell.support.NameScoping

Return true if we are in multi-scope mode (the default) or if we are in single scope mode which means we avoid prefixing commands with their scope.

isSatisfied() - Method in class org.apache.karaf.shell.impl.action.osgi.AggregateServiceTracker.State

isVisible(Object) - Method in class org.apache.karaf.shell.impl.action.osgi.RegistryImpl

isVisible(Object) - Method in class org.apache.karaf.shell.impl.console.osgi.secured.SecuredSessionFactoryImpl

isVisible(Object) - Method in class org.apache.karaf.shell.impl.console.RegistryImpl

isVisible(String, String) - Method in class org.apache.karaf.shell.impl.console.osgi.secured.SecuredSessionFactoryImpl

isWindows() - Static method in class org.apache.karaf.shell.support.completers.FileCompleter

J

JAR_EXTENSION - Static variable in interface org.apache.karaf.shell.impl.console.loader.JarInJarConstants

JAR_INTERNAL_SEPARATOR - Static variable in interface org.apache.karaf.shell.impl.console.loader.JarInJarConstants

JAR_INTERNAL_URL_PROTOCOL_WITH_COLON - Static variable in interface org.apache.karaf.shell.impl.console.loader.JarInJarConstants

JarInJarConstants - Interface in org.apache.karaf.shell.impl.console.loader

JarInJarStreamHandler - Class in org.apache.karaf.shell.impl.console.loader

JarInJarStreamHandler(ClassLoader) - Constructor for class org.apache.karaf.shell.impl.console.loader.JarInJarStreamHandler

JarInJarURLConnection - Class in org.apache.karaf.shell.impl.console.loader

JarInJarURLConnection(URL, ClassLoader) - Constructor for class org.apache.karaf.shell.impl.console.loader.JarInJarURLConnection

JarInJarURLStreamHandlerFactory - Class in org.apache.karaf.shell.impl.console.loader

JarInJarURLStreamHandlerFactory(ClassLoader) - Constructor for class org.apache.karaf.shell.impl.console.loader.JarInJarURLStreamHandlerFactory

JLineTerminal - Class in org.apache.karaf.shell.impl.console

JLineTerminal(Terminal) - Constructor for class org.apache.karaf.shell.impl.console.JLineTerminal

K

KARAF_COMMANDS - Static variable in class org.apache.karaf.shell.impl.action.osgi.CommandExtender

KarafParser - Class in org.apache.karaf.shell.impl.console.parsing

KarafParser(Session) - Constructor for class org.apache.karaf.shell.impl.console.parsing.KarafParser

KarafTerminal - Class in org.apache.karaf.shell.impl.console

KarafTerminal(Terminal) - Constructor for class org.apache.karaf.shell.impl.console.KarafTerminal

key() - Method in class org.apache.karaf.shell.api.console.Candidate

KILL - org.apache.karaf.shell.api.console.Signal

L

last() - Method in interface org.apache.karaf.shell.api.console.History

Last available index.

last() - Method in class org.apache.karaf.shell.impl.console.HistoryWrapper

LAST_EXCEPTION - Static variable in interface org.apache.karaf.shell.api.console.Session

left - org.apache.karaf.shell.support.table.HAlign

Left align.

length(String, int) - Static method in class org.apache.karaf.shell.support.ansi.AnsiSplitter

link(String, String) - Method in class org.apache.karaf.shell.impl.console.commands.help.wikidoc.AnsiPrintingWikiVisitor

link(String, String) - Method in interface org.apache.karaf.shell.impl.console.commands.help.wikidoc.WikiVisitor

list() - Method in class org.apache.felix.gogo.runtime.Parser.Array

listeners - Variable in class org.apache.karaf.shell.support.terminal.SignalSupport

ListenerTracker - Class in org.apache.karaf.shell.impl.console.osgi

Tracker for CommandSessionListener.

ListenerTracker(SessionFactoryImpl, BundleContext) - Constructor for class org.apache.karaf.shell.impl.console.osgi.ListenerTracker

loadBrandingProperties(boolean) - Static method in class org.apache.karaf.shell.impl.console.Branding

loadPropertyFromShellCfg(String, Function<String, T>, T) - Static method in class org.apache.karaf.shell.support.ShellUtil

LocalConsoleManager - Class in org.apache.karaf.shell.impl.console.osgi

LocalConsoleManager(BundleContext, SessionFactory) - Constructor for class org.apache.karaf.shell.impl.console.osgi.LocalConsoleManager

logException(Session, Throwable) - Static method in class org.apache.karaf.shell.support.ShellUtil

LoggingCommandSessionListener - Class in org.apache.karaf.shell.impl.console.osgi

LoggingCommandSessionListener() - Constructor for class org.apache.karaf.shell.impl.console.osgi.LoggingCommandSessionListener

M

main(String[]) - Static method in class org.apache.karaf.shell.impl.console.standalone.Main

Main - Class in org.apache.karaf.shell.impl.console.standalone

Main() - Constructor for class org.apache.karaf.shell.impl.console.standalone.Main

Manager - Interface in org.apache.karaf.shell.api.action.lifecycle

The Manager service can be used to programmatically register Actions or Completers.

ManagerImpl - Class in org.apache.karaf.shell.impl.action.command

ManagerImpl(Registry, Registry) - Constructor for class org.apache.karaf.shell.impl.action.command.ManagerImpl

ManagerImpl(Registry, Registry, boolean) - Constructor for class org.apache.karaf.shell.impl.action.command.ManagerImpl

map() - Method in class org.apache.felix.gogo.runtime.Parser.Array

mask() - Method in annotation type org.apache.karaf.shell.api.action.Argument

Character to use when censoring the argument in the console.

mask() - Method in annotation type org.apache.karaf.shell.api.action.Option

Character to use when censoring the argument in the console.

maxSize(int) - Method in class org.apache.karaf.shell.support.table.Col

messy() - Method in class org.apache.karaf.shell.support.parsing.GogoParser

MULTI_SCOPE_MODE_KEY - Static variable in class org.apache.karaf.shell.support.NameScoping

MultiException - Exception in org.apache.karaf.shell.support

MultiException(String) - Constructor for exception org.apache.karaf.shell.support.MultiException

MultiException(String, List<Exception>) - Constructor for exception org.apache.karaf.shell.support.MultiException

MultiServiceTracker<T> - Class in org.apache.karaf.shell.impl.action.osgi

Track multiple service by its type.

MultiServiceTracker(BundleContext, Class<T>, String) - Constructor for class org.apache.karaf.shell.impl.action.osgi.MultiServiceTracker

multiValued() - Method in annotation type org.apache.karaf.shell.api.action.Argument

The last argument can be multi-valued in which case the field type must be a List.

multiValued() - Method in annotation type org.apache.karaf.shell.api.action.Option

The last argument can be multi-valued in which case the field type must be a List.

N

name() - Method in annotation type org.apache.karaf.shell.api.action.Argument

Name of the argument.

name() - Method in annotation type org.apache.karaf.shell.api.action.Command

Returns the name of the command if used inside a shell.

name() - Method in annotation type org.apache.karaf.shell.api.action.Option

The name of this option.

NameScoping - Class in org.apache.karaf.shell.support

A helper class for name scoping

NameScoping() - Constructor for class org.apache.karaf.shell.support.NameScoping

next() - Method in class org.apache.felix.gogo.runtime.Parser

next() - Method in class org.apache.karaf.shell.support.parsing.GogoParser

nextToken(String) - Method in class org.apache.karaf.shell.impl.console.commands.help.wikidoc.WikiParser.Tokenizer

noHeaders() - Method in class org.apache.karaf.shell.support.table.ShellTable

NullCompleter - Class in org.apache.karaf.shell.support.completers

NullCompleter() - Constructor for class org.apache.karaf.shell.support.completers.NullCompleter

O

open() - Method in class org.apache.karaf.shell.impl.action.osgi.AggregateServiceTracker

open() - Method in class org.apache.karaf.shell.impl.action.osgi.MultiServiceTracker

open() - Method in class org.apache.karaf.shell.impl.action.osgi.SingleServiceTracker

openConnection(URL) - Method in class org.apache.karaf.shell.impl.console.loader.JarInJarStreamHandler

Operator(Token) - Constructor for class org.apache.felix.gogo.runtime.Parser.Operator

Option - Annotation Type in org.apache.karaf.shell.api.action

Used to mark an optional named command line option who's name typically starts with "--" or "-".

optional() - Method in annotation type org.apache.karaf.shell.api.action.lifecycle.Reference

OptionException(String, Throwable) - Constructor for exception org.apache.karaf.shell.impl.console.commands.Procedural.OptionException

org.apache.felix.gogo.runtime - package org.apache.felix.gogo.runtime

org.apache.karaf.shell.api.action - package org.apache.karaf.shell.api.action

org.apache.karaf.shell.api.action.lifecycle - package org.apache.karaf.shell.api.action.lifecycle

org.apache.karaf.shell.api.console - package org.apache.karaf.shell.api.console

org.apache.karaf.shell.impl.action.command - package org.apache.karaf.shell.impl.action.command

org.apache.karaf.shell.impl.action.osgi - package org.apache.karaf.shell.impl.action.osgi

org.apache.karaf.shell.impl.console - package org.apache.karaf.shell.impl.console

org.apache.karaf.shell.impl.console.commands - package org.apache.karaf.shell.impl.console.commands

org.apache.karaf.shell.impl.console.commands.help - package org.apache.karaf.shell.impl.console.commands.help

org.apache.karaf.shell.impl.console.commands.help.wikidoc - package org.apache.karaf.shell.impl.console.commands.help.wikidoc

org.apache.karaf.shell.impl.console.loader - package org.apache.karaf.shell.impl.console.loader

org.apache.karaf.shell.impl.console.osgi - package org.apache.karaf.shell.impl.console.osgi

org.apache.karaf.shell.impl.console.osgi.secured - package org.apache.karaf.shell.impl.console.osgi.secured

org.apache.karaf.shell.impl.console.parsing - package org.apache.karaf.shell.impl.console.parsing

org.apache.karaf.shell.impl.console.standalone - package org.apache.karaf.shell.impl.console.standalone

org.apache.karaf.shell.support - package org.apache.karaf.shell.support

org.apache.karaf.shell.support.ansi - package org.apache.karaf.shell.support.ansi

org.apache.karaf.shell.support.completers - package org.apache.karaf.shell.support.completers

org.apache.karaf.shell.support.converter - package org.apache.karaf.shell.support.converter

org.apache.karaf.shell.support.parsing - package org.apache.karaf.shell.support.parsing

org.apache.karaf.shell.support.table - package org.apache.karaf.shell.support.table

org.apache.karaf.shell.support.terminal - package org.apache.karaf.shell.support.terminal

output() - Method in class org.apache.karaf.shell.impl.console.JLineTerminal

output() - Method in class org.apache.karaf.shell.impl.console.KarafTerminal

P

parent - Variable in class org.apache.karaf.shell.impl.console.RegistryImpl

parse(Reader) - Method in class org.apache.karaf.shell.impl.console.commands.help.wikidoc.WikiParser

parse(String) - Method in class org.apache.karaf.shell.impl.console.commands.help.wikidoc.WikiParser

parse(String, int, Parser.ParseContext) - Method in class org.apache.karaf.shell.impl.console.parsing.KarafParser

parse(String, Object) - Static method in class org.apache.karaf.shell.support.converter.GenericType

parse(Session, String) - Static method in class org.apache.karaf.shell.impl.console.parsing.CommandLineParser

parse(Session, String, int) - Method in interface org.apache.karaf.shell.api.console.Parser

parse(Session, String, int) - Method in class org.apache.karaf.shell.impl.action.command.ActionCommand.DelayedParser

parse(Session, String, int) - Method in class org.apache.karaf.shell.support.parsing.DefaultParser

parseOptions(CommandSession, String[], Object[]) - Method in class org.apache.karaf.shell.impl.console.commands.Procedural

Parser - Class in org.apache.felix.gogo.runtime

Parser - Interface in org.apache.karaf.shell.api.console

A Parser is used by the console to parse a command line.

Parser(CharSequence) - Constructor for class org.apache.felix.gogo.runtime.Parser

Parser.Array - Class in org.apache.felix.gogo.runtime

[ a b ...] [ k1=v1 k2=v2 ...]

Parser.Closure - Class in org.apache.felix.gogo.runtime

{ program }

Parser.Executable - Class in org.apache.felix.gogo.runtime

Parser.Operator - Class in org.apache.felix.gogo.runtime

Parser.Pipeline - Class in org.apache.felix.gogo.runtime

token1 | token2 | ...

Parser.Program - Class in org.apache.felix.gogo.runtime

pipe1 ; pipe2 ; ...

Parser.Sequence - Class in org.apache.felix.gogo.runtime

( program )

Parser.Statement - Class in org.apache.felix.gogo.runtime

parseURL(URL, String, int, int) - Method in class org.apache.karaf.shell.impl.console.loader.JarInJarStreamHandler

Parsing - Annotation Type in org.apache.karaf.shell.api.action

The @Parsing annotation can be used on a Command to specify a custom Parser to use for the command.

PATH_SEPARATOR - Static variable in interface org.apache.karaf.shell.impl.console.loader.JarInJarConstants

pause() - Method in class org.apache.karaf.shell.impl.console.JLineTerminal

pause(boolean) - Method in class org.apache.karaf.shell.impl.console.JLineTerminal

paused() - Method in class org.apache.karaf.shell.impl.console.JLineTerminal

peek() - Method in class org.apache.karaf.shell.support.parsing.GogoParser

PIPE - org.apache.karaf.shell.api.console.Signal

pipeline() - Method in class org.apache.karaf.shell.support.parsing.GogoParser

Pipeline(Token, List<Parser.Executable>) - Constructor for class org.apache.felix.gogo.runtime.Parser.Pipeline

position() - Method in class org.apache.karaf.shell.support.parsing.GogoParser

position(String, int) - Method in enum org.apache.karaf.shell.support.table.HAlign

Calculate text position.

prepare(Action, Session, List<Object>) - Method in class org.apache.karaf.shell.impl.action.command.DefaultActionPreparator

preprocess(Session, CommandLine) - Method in interface org.apache.karaf.shell.api.console.Parser

preprocess(Session, CommandLine) - Method in class org.apache.karaf.shell.impl.action.command.ActionCommand.DelayedParser

preprocess(Session, CommandLine) - Method in class org.apache.karaf.shell.support.parsing.DefaultParser

print(PrintStream) - Method in class org.apache.karaf.shell.support.table.ShellTable

print(PrintStream, boolean) - Method in class org.apache.karaf.shell.support.table.ShellTable

print(PrintStream, Charset, boolean) - Method in class org.apache.karaf.shell.support.table.ShellTable

PRINT_STACK_TRACES - Static variable in interface org.apache.karaf.shell.api.console.Session

printHelp(PrintStream) - Method in class org.apache.karaf.shell.impl.console.commands.help.HelpCommand

printHelp(Session, PrintStream) - Method in class org.apache.karaf.shell.impl.console.commands.SubShellCommand

printHelp(Session, PrintStream) - Method in class org.apache.karaf.shell.impl.console.commands.TopLevelCommand

printMethodList(Session, PrintStream, SortedMap<String, String>, Collection<String>) - Method in class org.apache.karaf.shell.impl.console.commands.help.CommandListHelpProvider

printShellHelp(Session, PrintStream, String) - Method in class org.apache.karaf.shell.impl.console.commands.help.ShellHelpProvider

printUsage(Action, Map<Option, Field>, Map<Argument, Field>, PrintStream, boolean, int) - Method in class org.apache.karaf.shell.impl.action.command.DefaultActionPreparator

Procedural - Class in org.apache.karaf.shell.impl.console.commands

Procedural() - Constructor for class org.apache.karaf.shell.impl.console.commands.Procedural

Procedural.BreakException - Exception in org.apache.karaf.shell.impl.console.commands

Procedural.ContinueException - Exception in org.apache.karaf.shell.impl.console.commands

Procedural.HelpException - Exception in org.apache.karaf.shell.impl.console.commands

Procedural.OptionException - Exception in org.apache.karaf.shell.impl.console.commands

Procedural.ThrownException - Exception in org.apache.karaf.shell.impl.console.commands

PROF - org.apache.karaf.shell.api.console.Signal

program() - Method in class org.apache.felix.gogo.runtime.Parser.Closure

program() - Method in class org.apache.felix.gogo.runtime.Parser

program() - Method in class org.apache.felix.gogo.runtime.Parser.Sequence

program() - Method in class org.apache.karaf.shell.support.parsing.GogoParser

Program(Token, List<Parser.Executable>) - Constructor for class org.apache.felix.gogo.runtime.Parser.Program

PROMPT - Static variable in class org.apache.karaf.shell.impl.console.ConsoleSessionImpl

push(Token) - Method in class org.apache.felix.gogo.runtime.Parser

put(String, Object) - Method in interface org.apache.karaf.shell.api.console.Session

Set the value of a variable.

put(String, Object) - Method in class org.apache.karaf.shell.impl.console.ConsoleSessionImpl

put(String, Object) - Method in class org.apache.karaf.shell.impl.console.HeadlessSessionImpl

puts(InfoCmp.Capability, Object...) - Method in class org.apache.karaf.shell.impl.console.JLineTerminal

PWR - org.apache.karaf.shell.api.console.Signal

Q

QUIT - org.apache.karaf.shell.api.console.Signal

R

raise(Terminal.Signal) - Method in class org.apache.karaf.shell.impl.console.JLineTerminal

reader() - Method in class org.apache.karaf.shell.impl.console.JLineTerminal

reader() - Method in class org.apache.karaf.shell.impl.console.KarafTerminal

readLine() - Method in class org.apache.karaf.shell.support.ansi.AnsiSplitter.AnsiBufferedReader

readLine(String, Character) - Method in interface org.apache.karaf.shell.api.console.Session

Prompt the user for a line.

readLine(String, Character) - Method in class org.apache.karaf.shell.impl.console.ConsoleSessionImpl

readLine(String, Character) - Method in class org.apache.karaf.shell.impl.console.HeadlessSessionImpl

readMouseEvent() - Method in class org.apache.karaf.shell.impl.console.JLineTerminal

readMouseEvent(IntSupplier) - Method in class org.apache.karaf.shell.impl.console.JLineTerminal

redirect(CommandSessionImpl, Path, int) - Method in class org.apache.karaf.shell.impl.console.osgi.secured.SecuredSessionFactoryImpl

redirect(CommandSessionImpl, Path, int) - Method in class org.apache.karaf.shell.impl.console.SessionFactoryImpl

REDIRECTED_CLASS_PATH_MANIFEST_NAME - Static variable in interface org.apache.karaf.shell.impl.console.loader.JarInJarConstants

redirections() - Method in class org.apache.felix.gogo.runtime.Parser.Statement

Reference - Annotation Type in org.apache.karaf.shell.api.action.lifecycle

A class annotated with Service can have fields annotated with @Service in which case matching services will be retrieved from the Registry and injected.

RegexCommandLoggingFilter - Class in org.apache.karaf.shell.support

RegexCommandLoggingFilter() - Constructor for class org.apache.karaf.shell.support.RegexCommandLoggingFilter

register(Class<?>) - Method in interface org.apache.karaf.shell.api.action.lifecycle.Manager

Register a service.

register(Class<?>) - Method in class org.apache.karaf.shell.impl.action.command.ManagerImpl

register(Object) - Method in interface org.apache.karaf.shell.api.console.Registry

Register a service.

register(Object) - Method in class org.apache.karaf.shell.impl.action.osgi.RegistryImpl

register(Object) - Method in class org.apache.karaf.shell.impl.console.RegistryImpl

register(Object) - Method in class org.apache.karaf.shell.impl.console.SessionFactoryImpl

register(Callable<T>, Class<T>) - Method in interface org.apache.karaf.shell.api.console.Registry

Register a delayed service (or factory).

register(Callable<T>, Class<T>) - Method in class org.apache.karaf.shell.impl.action.osgi.RegistryImpl

register(Callable<T>, Class<T>) - Method in class org.apache.karaf.shell.impl.console.RegistryImpl

Registry - Interface in org.apache.karaf.shell.api.console

Service registry.

RegistryImpl - Class in org.apache.karaf.shell.impl.action.osgi

RegistryImpl - Class in org.apache.karaf.shell.impl.console

RegistryImpl(Registry) - Constructor for class org.apache.karaf.shell.impl.action.osgi.RegistryImpl

RegistryImpl(Registry) - Constructor for class org.apache.karaf.shell.impl.console.RegistryImpl

RegistryImpl(Registry, Session) - Constructor for class org.apache.karaf.shell.impl.console.RegistryImpl

ReifiedType - Class in org.apache.karaf.shell.support.converter

Provides access to a concrete type and its optional generic type arguments.

ReifiedType(Class) - Constructor for class org.apache.karaf.shell.support.converter.ReifiedType

Create a Reified Type for a raw Java class without any generic arguments.

release(Object) - Method in class org.apache.karaf.shell.impl.action.command.ManagerImpl

releaseAction(Action) - Method in class org.apache.karaf.shell.impl.action.command.ActionCommand

removedService(ServiceReference<Object>, List<Command>) - Method in class org.apache.karaf.shell.impl.console.osgi.CommandTracker

removedService(ServiceReference<CommandSessionListener>, CommandSessionListener) - Method in class org.apache.karaf.shell.impl.console.osgi.ListenerTracker

removedService(ServiceReference<Converter>, Converter) - Method in class org.apache.karaf.shell.impl.console.osgi.ConverterTracker

removeSignalListener(SignalListener) - Method in interface org.apache.karaf.shell.api.console.Terminal

Remove a previously registered listener for all the signals it was registered.

removeSignalListener(SignalListener) - Method in class org.apache.karaf.shell.impl.console.JLineTerminal

removeSignalListener(SignalListener) - Method in class org.apache.karaf.shell.support.terminal.SignalSupport

required() - Method in annotation type org.apache.karaf.shell.api.action.Argument

Whether this argument is mandatory or not.

required() - Method in annotation type org.apache.karaf.shell.api.action.Option

Whether this argument is mandatory or not.

RESET - Static variable in class org.apache.karaf.shell.support.ansi.SimpleAnsi

resolveCommand(String) - Method in interface org.apache.karaf.shell.api.console.Session

Resolve a command name.

resolveCommand(String) - Method in class org.apache.karaf.shell.impl.console.ConsoleSessionImpl

resolveCommand(String) - Method in class org.apache.karaf.shell.impl.console.HeadlessSessionImpl

resume() - Method in class org.apache.karaf.shell.impl.console.JLineTerminal

right - org.apache.karaf.shell.support.table.HAlign

Right align.

Row - Class in org.apache.karaf.shell.support.table

RPROMPT - Static variable in class org.apache.karaf.shell.impl.console.ConsoleSessionImpl

run() - Method in class org.apache.karaf.shell.impl.console.ConsoleSessionImpl

run() - Method in class org.apache.karaf.shell.impl.console.HeadlessSessionImpl

run(String[]) - Method in class org.apache.karaf.shell.impl.console.standalone.Main

Use this method when the shell is being executed as a top level shell.

run(CommandSession, Process, Object[]) - Method in class org.apache.karaf.shell.impl.console.commands.Procedural

S

scope() - Method in annotation type org.apache.karaf.shell.api.action.Command

Returns the scope or sub shell of the command.

SCOPE - Static variable in interface org.apache.karaf.shell.api.console.Session

SCOPE_GLOBAL - Static variable in interface org.apache.karaf.shell.api.console.Session

ScopeComparator(List<String>) - Constructor for class org.apache.karaf.shell.impl.console.CommandsCompleter.ScopeComparator

SecuredCommand - Class in org.apache.karaf.shell.impl.console.osgi.secured

SecuredCommand(SecuredSessionFactoryImpl, Command) - Constructor for class org.apache.karaf.shell.impl.console.osgi.secured.SecuredCommand

SecuredSessionFactoryImpl - Class in org.apache.karaf.shell.impl.console.osgi.secured

SecuredSessionFactoryImpl(BundleContext, ThreadIO) - Constructor for class org.apache.karaf.shell.impl.console.osgi.secured.SecuredSessionFactoryImpl

SEGV - org.apache.karaf.shell.api.console.Signal

separator() - Method in class org.apache.karaf.shell.support.completers.FileCompleter

separator(String) - Method in class org.apache.karaf.shell.support.table.ShellTable

sequence() - Method in class org.apache.felix.gogo.runtime.Parser

Sequence(Token, Parser.Program) - Constructor for class org.apache.felix.gogo.runtime.Parser.Sequence

Service - Annotation Type in org.apache.karaf.shell.api.action.lifecycle

Classes that need to be managed must be annotated with @Service annotation.

services - Variable in class org.apache.karaf.shell.impl.console.RegistryImpl

session - Variable in class org.apache.karaf.shell.impl.console.RegistryImpl

Session - Interface in org.apache.karaf.shell.api.console

A Session can be used to execute commands.

SessionFactory - Interface in org.apache.karaf.shell.api.console

The SessionFactory can be used to create Session to execute commands.

SessionFactoryImpl - Class in org.apache.karaf.shell.impl.console

SessionFactoryImpl(ThreadIO) - Constructor for class org.apache.karaf.shell.impl.console.SessionFactoryImpl

setApplication(String) - Method in class org.apache.karaf.shell.impl.console.standalone.Main

setAttributes(Attributes) - Method in class org.apache.karaf.shell.impl.console.JLineTerminal

setAttributes(Attributes) - Method in class org.apache.karaf.shell.impl.console.KarafTerminal

setEchoEnabled(boolean) - Method in interface org.apache.karaf.shell.api.console.Terminal

Enable or disable echo.

setEchoEnabled(boolean) - Method in class org.apache.karaf.shell.impl.console.JLineTerminal

setFilters(Collection<CommandLoggingFilter>) - Method in class org.apache.karaf.shell.impl.console.osgi.LoggingCommandSessionListener

setGroup(int) - Method in class org.apache.karaf.shell.support.RegexCommandLoggingFilter

setName(String) - Method in class org.apache.karaf.shell.impl.console.osgi.secured.AliasCommand

setPattern(String) - Method in class org.apache.karaf.shell.support.RegexCommandLoggingFilter

setReplacement(String) - Method in class org.apache.karaf.shell.support.RegexCommandLoggingFilter

setScope(String) - Method in class org.apache.karaf.shell.impl.console.osgi.secured.AliasCommand

setSessionProperties(Properties) - Method in class org.apache.karaf.shell.impl.console.ConsoleSessionImpl

setSize(Size) - Method in class org.apache.karaf.shell.impl.console.JLineTerminal

setSize(Size) - Method in class org.apache.karaf.shell.impl.console.KarafTerminal

setTabs(int) - Method in class org.apache.karaf.shell.support.ansi.AnsiSplitter.AnsiBufferedReader

setUser(String) - Method in class org.apache.karaf.shell.impl.console.standalone.Main

SHELL_HISTORY_FILE_MAXSIZE - Static variable in class org.apache.karaf.shell.impl.console.ConsoleSessionImpl

SHELL_HISTORY_MAXSIZE - Static variable in class org.apache.karaf.shell.impl.console.ConsoleSessionImpl

SHELL_INIT_SCRIPT - Static variable in class org.apache.karaf.shell.impl.console.ConsoleSessionImpl

ShellHelpProvider - Class in org.apache.karaf.shell.impl.console.commands.help

ShellHelpProvider() - Constructor for class org.apache.karaf.shell.impl.console.commands.help.ShellHelpProvider

ShellTable - Class in org.apache.karaf.shell.support.table

ShellTable() - Constructor for class org.apache.karaf.shell.support.table.ShellTable

ShellUtil - Class in org.apache.karaf.shell.support

ShellUtil() - Constructor for class org.apache.karaf.shell.support.ShellUtil

signal(Signal) - Method in interface org.apache.karaf.shell.api.console.SignalListener

Callback method called when a signal occurs.

signal(Signal) - Method in class org.apache.karaf.shell.support.terminal.SignalSupport

Signal - Enum in org.apache.karaf.shell.api.console

SignalListener - Interface in org.apache.karaf.shell.api.console

Define a listener to receive signals

SignalSupport - Class in org.apache.karaf.shell.support.terminal

SignalSupport() - Constructor for class org.apache.karaf.shell.support.terminal.SignalSupport

SimpleAnsi - Class in org.apache.karaf.shell.support.ansi

SimpleAnsi() - Constructor for class org.apache.karaf.shell.support.ansi.SimpleAnsi

SimpleHelpProvider - Class in org.apache.karaf.shell.impl.console.commands.help

SimpleHelpProvider() - Constructor for class org.apache.karaf.shell.impl.console.commands.help.SimpleHelpProvider

SingleCommandHelpProvider - Class in org.apache.karaf.shell.impl.console.commands.help

SingleCommandHelpProvider() - Constructor for class org.apache.karaf.shell.impl.console.commands.help.SingleCommandHelpProvider

SingleServiceTracker<T> - Class in org.apache.karaf.shell.impl.action.osgi

Track a single service by its type.

SingleServiceTracker(BundleContext, Class<T>, String) - Constructor for class org.apache.karaf.shell.impl.action.osgi.SingleServiceTracker

size() - Method in class org.apache.karaf.shell.support.converter.GenericType

size() - Method in class org.apache.karaf.shell.support.converter.ReifiedType

Return the number of type arguments.

size(int) - Method in class org.apache.karaf.shell.support.table.ShellTable

sort(Map<String, Completer>[], List<String>) - Method in class org.apache.karaf.shell.impl.console.CommandsCompleter

splitLines(String, int, int) - Static method in class org.apache.karaf.shell.support.ansi.AnsiSplitter

splitter(InputStream, int, int) - Static method in class org.apache.karaf.shell.support.ansi.AnsiSplitter

stack - Variable in class org.apache.felix.gogo.runtime.Parser

start() - Method in class org.apache.karaf.shell.impl.action.osgi.CommandExtension

start() - Method in class org.apache.karaf.shell.impl.console.osgi.LocalConsoleManager

start(String, String) - Method in class org.apache.felix.gogo.runtime.Parser

start(BundleContext) - Method in class org.apache.karaf.shell.impl.console.osgi.Activator

startPara(int) - Method in class org.apache.karaf.shell.impl.console.commands.help.wikidoc.AnsiPrintingWikiVisitor

startPara(int) - Method in interface org.apache.karaf.shell.impl.console.commands.help.wikidoc.WikiVisitor

State() - Constructor for class org.apache.karaf.shell.impl.action.osgi.AggregateServiceTracker.State

statement() - Method in class org.apache.felix.gogo.runtime.Parser

statement() - Method in class org.apache.karaf.shell.support.parsing.GogoParser

Statement(Token, List<Token>, List<Token>) - Constructor for class org.apache.felix.gogo.runtime.Parser.Statement

statements - Variable in class org.apache.felix.gogo.runtime.Parser

statements() - Method in class org.apache.felix.gogo.runtime.Parser

STKFLT - org.apache.karaf.shell.api.console.Signal

stop() - Method in class org.apache.karaf.shell.impl.console.osgi.LocalConsoleManager

stop() - Method in class org.apache.karaf.shell.impl.console.osgi.secured.SecuredSessionFactoryImpl

stop() - Method in class org.apache.karaf.shell.impl.console.SessionFactoryImpl

stop(BundleContext) - Method in class org.apache.karaf.shell.impl.console.osgi.Activator

STOP - org.apache.karaf.shell.api.console.Signal

StringsCompleter - Class in org.apache.karaf.shell.support.completers

Completer for a set of strings.

StringsCompleter() - Constructor for class org.apache.karaf.shell.support.completers.StringsCompleter

StringsCompleter(boolean) - Constructor for class org.apache.karaf.shell.support.completers.StringsCompleter

StringsCompleter(String[]) - Constructor for class org.apache.karaf.shell.support.completers.StringsCompleter

StringsCompleter(String[], boolean) - Constructor for class org.apache.karaf.shell.support.completers.StringsCompleter

StringsCompleter(Collection<String>) - Constructor for class org.apache.karaf.shell.support.completers.StringsCompleter

StringsCompleter(Collection<String>, boolean) - Constructor for class org.apache.karaf.shell.support.completers.StringsCompleter

SUBSHELL - Static variable in interface org.apache.karaf.shell.api.console.Session

SubShellCommand - Class in org.apache.karaf.shell.impl.console.commands

SubShellCommand(String) - Constructor for class org.apache.karaf.shell.impl.console.commands.SubShellCommand

substring(String, int, int, int) - Static method in class org.apache.karaf.shell.support.ansi.AnsiSplitter

suffix() - Method in class org.apache.karaf.shell.api.console.Candidate

T

TERM - org.apache.karaf.shell.api.console.Signal

Terminal - Interface in org.apache.karaf.shell.api.console

Session terminal.

text(String) - Method in class org.apache.karaf.shell.impl.console.commands.help.wikidoc.AnsiPrintingWikiVisitor

text(String) - Method in interface org.apache.karaf.shell.impl.console.commands.help.wikidoc.WikiVisitor

throwIf(String, List<Exception>) - Static method in exception org.apache.karaf.shell.support.MultiException

throwIfExceptions() - Method in exception org.apache.karaf.shell.support.MultiException

ThrownException(Throwable) - Constructor for exception org.apache.karaf.shell.impl.console.commands.Procedural.ThrownException

Tokenizer(String) - Constructor for class org.apache.karaf.shell.impl.console.commands.help.wikidoc.WikiParser.Tokenizer

tokens - Variable in class org.apache.felix.gogo.runtime.Parser

tokens() - Method in class org.apache.felix.gogo.runtime.Parser.Pipeline

tokens() - Method in class org.apache.felix.gogo.runtime.Parser.Program

tokens() - Method in class org.apache.felix.gogo.runtime.Parser.Statement

tokens() - Method in class org.apache.felix.gogo.runtime.Parser

TopLevelCommand - Class in org.apache.karaf.shell.impl.console.commands

TopLevelCommand() - Constructor for class org.apache.karaf.shell.impl.console.commands.TopLevelCommand

toString() - Method in class org.apache.karaf.shell.support.converter.GenericType

toString() - Method in class org.apache.karaf.shell.support.parsing.GogoParser

track(GenericType, boolean, String) - Method in class org.apache.karaf.shell.impl.action.osgi.CommandExtension

trackFocus(boolean) - Method in class org.apache.karaf.shell.impl.console.JLineTerminal

trackList(Class<T>, String) - Method in class org.apache.karaf.shell.impl.action.osgi.AggregateServiceTracker

trackMouse(Terminal.MouseTracking) - Method in class org.apache.karaf.shell.impl.console.JLineTerminal

trackSingle(Class<T>, boolean, String) - Method in class org.apache.karaf.shell.impl.action.osgi.AggregateServiceTracker

TRAP - org.apache.karaf.shell.api.console.Signal

TSTP - org.apache.karaf.shell.api.console.Signal

TTIN - org.apache.karaf.shell.api.console.Signal

TTOU - org.apache.karaf.shell.api.console.Signal

tz - Variable in class org.apache.felix.gogo.runtime.Parser

U

unescape() - Method in class org.apache.karaf.shell.support.parsing.GogoParser

unregister(Class<?>) - Method in interface org.apache.karaf.shell.api.action.lifecycle.Manager

Unregister a previously registered class.

unregister(Class<?>) - Method in class org.apache.karaf.shell.impl.action.command.ManagerImpl

unregister(Object) - Method in interface org.apache.karaf.shell.api.console.Registry

Unregister a service.

unregister(Object) - Method in class org.apache.karaf.shell.impl.action.osgi.RegistryImpl

unregister(Object) - Method in class org.apache.karaf.shell.impl.console.osgi.secured.SecuredSessionFactoryImpl

unregister(Object) - Method in class org.apache.karaf.shell.impl.console.RegistryImpl

unregister(Object) - Method in class org.apache.karaf.shell.impl.console.SessionFactoryImpl

update(ConfigurationAdmin, ConfigurationAdmin) - Method in class org.apache.karaf.shell.impl.console.osgi.secured.SecuredSessionFactoryImpl

updateSize(int) - Method in class org.apache.karaf.shell.support.table.Col

updateState(List<T>) - Method in class org.apache.karaf.shell.impl.action.osgi.MultiServiceTracker

updateState(AggregateServiceTracker.State) - Method in class org.apache.karaf.shell.impl.action.osgi.AggregateServiceTracker

updateState(T, T) - Method in class org.apache.karaf.shell.impl.action.osgi.SingleServiceTracker

URG - org.apache.karaf.shell.api.console.Signal

UriCompleter - Class in org.apache.karaf.shell.support.completers

UriCompleter() - Constructor for class org.apache.karaf.shell.support.completers.UriCompleter

USR1 - org.apache.karaf.shell.api.console.Signal

USR2 - org.apache.karaf.shell.api.console.Signal

V

value() - Method in annotation type org.apache.karaf.shell.api.action.Completion

The completer class to use for this field.

value() - Method in annotation type org.apache.karaf.shell.api.action.Parsing

The parser class to use for this command.

value() - Method in class org.apache.karaf.shell.api.console.Candidate

value() - Method in class org.apache.karaf.shell.support.parsing.GogoParser

valueOf(String) - Static method in enum org.apache.karaf.shell.api.console.Signal

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.apache.karaf.shell.support.table.HAlign

Returns the enum constant of this type with the specified name.

values() - Method in annotation type org.apache.karaf.shell.api.action.Completion

When using a static completer, returns the possible values.

values() - Static method in enum org.apache.karaf.shell.api.console.Signal

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.apache.karaf.shell.support.table.HAlign

Returns an array containing the constants of this enum type, in the order they are declared.

valueToShowInHelp() - Method in annotation type org.apache.karaf.shell.api.action.Argument

The generated help displays default values for arguments.

valueToShowInHelp() - Method in annotation type org.apache.karaf.shell.api.action.Option

The generated help displays default values for arguments.

verifyCompleter(Session, Completer, String) - Method in class org.apache.karaf.shell.impl.action.command.ArgumentCompleter

VTALRM - org.apache.karaf.shell.api.console.Signal

W

warn(Bundle, String, Throwable) - Method in class org.apache.karaf.shell.impl.action.osgi.CommandExtender

welcome(Properties) - Method in class org.apache.karaf.shell.impl.console.ConsoleSessionImpl

whole(List<? extends Token>, int) - Method in class org.apache.felix.gogo.runtime.Parser

whole(Token, Token) - Method in class org.apache.felix.gogo.runtime.Parser

WikiParser - Class in org.apache.karaf.shell.impl.console.commands.help.wikidoc

Parses wiki syntax from a reader and calls a Wikivisitor with the tokens it finds

WikiParser(WikiVisitor) - Constructor for class org.apache.karaf.shell.impl.console.commands.help.wikidoc.WikiParser

WikiParser.Tokenizer - Class in org.apache.karaf.shell.impl.console.commands.help.wikidoc

WikiVisitor - Interface in org.apache.karaf.shell.impl.console.commands.help.wikidoc

Will be used by WikiParser to call the respective handler when it recognizes the tag

WINCH - org.apache.karaf.shell.api.console.Signal

window(InputStream, int, int, int) - Static method in class org.apache.karaf.shell.support.ansi.AnsiSplitter

wrap() - Method in class org.apache.karaf.shell.support.table.Col

wrap(boolean) - Method in class org.apache.karaf.shell.support.table.Col

wrap(String) - Method in class org.apache.karaf.shell.support.table.Col

wrap(Command) - Method in class org.apache.karaf.shell.impl.console.osgi.secured.SecuredSessionFactoryImpl

wrap(Command) - Method in class org.apache.karaf.shell.impl.console.SessionFactoryImpl

writer() - Method in class org.apache.karaf.shell.impl.console.JLineTerminal

writer() - Method in class org.apache.karaf.shell.impl.console.KarafTerminal

ws() - Method in class org.apache.karaf.shell.support.parsing.GogoParser

X

XCPU - org.apache.karaf.shell.api.console.Signal

XFSZ - org.apache.karaf.shell.api.console.Signal

_

_main(CommandSession, Object[]) - Method in class org.apache.karaf.shell.impl.console.commands.Procedural

A B C D E F G H I J K L M N O P Q R S T U V W X _
All Classes All Packages