org.springframework.boot.actuate.autoconfigure

Class ShellProperties

java.lang.Object

org.springframework.boot.actuate.autoconfigure.ShellProperties

@ConfigurationProperties(prefix="management.shell",
                         ignoreUnknownFields=true)
public class ShellProperties
extends Object

Configuration properties for the shell subsystem.

Author:

Christian Dupuis, Phillip Webb, Eddú Meléndez, Stephane Nicoll

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ShellProperties.Auth
static class	ShellProperties.CrshShellAuthenticationProperties Base class for Auth specific properties.
static class	ShellProperties.CrshShellProperties Base class for CRaSH properties.
static class	ShellProperties.JaasAuthenticationProperties Auth specific properties for JAAS authentication.
static class	ShellProperties.KeyAuthenticationProperties Auth specific properties for key authentication.
static class	ShellProperties.SimpleAuthenticationProperties Auth specific properties for simple authentication.
static class	ShellProperties.SpringAuthenticationProperties Auth specific properties for Spring authentication.
static class	ShellProperties.Ssh SSH properties.
static class	ShellProperties.Telnet Telnet properties.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SHELL_PREFIX

Constructor Summary

Constructors

Constructor and Description
ShellProperties()

Method Summary

Modifier and Type	Method and Description
Properties	asCrshShellConfig() Return a properties file configured from these settings that can be applied to a CRaSH shell instance.
ShellProperties.CrshShellProperties[]	getAdditionalProperties()
ShellProperties.Auth	getAuth()
String[]	getCommandPathPatterns()
int	getCommandRefreshInterval()
String[]	getConfigPathPatterns()
String[]	getDisabledCommands()
String[]	getDisabledPlugins()
ShellProperties.Ssh	getSsh()
ShellProperties.Telnet	getTelnet()
void	setCommandPathPatterns(String[] commandPathPatterns)
void	setCommandRefreshInterval(int commandRefreshInterval)
void	setConfigPathPatterns(String[] configPathPatterns)
void	setDisabledCommands(String[] disabledCommands)
void	setDisabledPlugins(String[] disabledPlugins)
protected void	validateCrshShellConfig(Properties properties) Basic validation of applied CRaSH shell configuration.

Methods inherited from class java.lang.Object

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

Field Detail

SHELL_PREFIX

public static final String SHELL_PREFIX

See Also:

Constant Field Values

Constructor Detail

ShellProperties

public ShellProperties()

Method Detail

getAuth

public ShellProperties.Auth getAuth()

getAdditionalProperties

public ShellProperties.CrshShellProperties[] getAdditionalProperties()

setCommandRefreshInterval

public void setCommandRefreshInterval(int commandRefreshInterval)

getCommandRefreshInterval

public int getCommandRefreshInterval()

setCommandPathPatterns

public void setCommandPathPatterns(String[] commandPathPatterns)

getCommandPathPatterns

public String[] getCommandPathPatterns()

setConfigPathPatterns

public void setConfigPathPatterns(String[] configPathPatterns)

getConfigPathPatterns

public String[] getConfigPathPatterns()

setDisabledCommands

public void setDisabledCommands(String[] disabledCommands)

getDisabledCommands

public String[] getDisabledCommands()

setDisabledPlugins

public void setDisabledPlugins(String[] disabledPlugins)

getDisabledPlugins

public String[] getDisabledPlugins()

getSsh

public ShellProperties.Ssh getSsh()

getTelnet

public ShellProperties.Telnet getTelnet()

asCrshShellConfig

public Properties asCrshShellConfig()

Return a properties file configured from these settings that can be applied to a CRaSH shell instance.

Returns:

the CRaSH properties

validateCrshShellConfig

protected void validateCrshShellConfig(Properties properties)

Basic validation of applied CRaSH shell configuration.

Parameters:

properties - the properties to validate