org.springframework.shell.jline

Class InteractiveShellApplicationRunner

java.lang.Object

org.springframework.shell.jline.InteractiveShellApplicationRunner

All Implemented Interfaces:

org.springframework.boot.ApplicationRunner

@Order(value=0)
public class InteractiveShellApplicationRunner
extends Object
implements org.springframework.boot.ApplicationRunner

Default Boot runner that bootstraps the shell application in interactive mode.

Runs the REPL of the shell unless the spring.shell.interactive property has been set to false.

Author:

Eric Bottard

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	InteractiveShellApplicationRunner.JLineInputProvider

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENABLED
static int	PRECEDENCE The precedence at which this runner is set.
static String	SPRING_SHELL_INTERACTIVE
static String	SPRING_SHELL_INTERACTIVE_ENABLED The name of the property that controls whether this runner effectively does something.

Constructor Summary

Constructors

Constructor and Description
InteractiveShellApplicationRunner(org.jline.reader.LineReader lineReader, PromptProvider promptProvider, org.jline.reader.Parser parser, Shell shell, org.springframework.core.env.Environment environment)

Method Summary

Modifier and Type	Method and Description
static void	disable(org.springframework.core.env.ConfigurableEnvironment environment) Helper method to dynamically disable this runner.
boolean	isEnabled()
void	run(org.springframework.boot.ApplicationArguments args)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PRECEDENCE

public static final int PRECEDENCE

The precedence at which this runner is set. Highger precedence runners may effectively disable this one by setting the SPRING_SHELL_INTERACTIVE_ENABLED property to false.

See Also:

Constant Field Values

SPRING_SHELL_INTERACTIVE

public static final String SPRING_SHELL_INTERACTIVE

See Also:

Constant Field Values

ENABLED

public static final String ENABLED

See Also:

Constant Field Values

SPRING_SHELL_INTERACTIVE_ENABLED

public static final String SPRING_SHELL_INTERACTIVE_ENABLED

The name of the property that controls whether this runner effectively does something.

See Also:

Constant Field Values

Constructor Detail

InteractiveShellApplicationRunner

public InteractiveShellApplicationRunner(org.jline.reader.LineReader lineReader,
                                         PromptProvider promptProvider,
                                         org.jline.reader.Parser parser,
                                         Shell shell,
                                         org.springframework.core.env.Environment environment)

Method Detail

run

public void run(org.springframework.boot.ApplicationArguments args)
         throws Exception

Specified by:

run in interface org.springframework.boot.ApplicationRunner

Throws:

Exception

isEnabled

public boolean isEnabled()

disable

public static void disable(org.springframework.core.env.ConfigurableEnvironment environment)

Helper method to dynamically disable this runner.