org.graylog2.bootstrap

Class CmdLineTool

java.lang.Object

org.graylog2.bootstrap.CmdLineTool

All Implemented Interfaces:

Runnable, CliCommand

Direct Known Subclasses:

AbstractJournalCommand, ServerBootstrap

public abstract class CmdLineTool
extends Object
implements CliCommand

Field Summary

Fields

Modifier and Type	Field and Description
protected ChainingClassLoader	chainingClassLoader
protected String	commandName
protected BaseConfiguration	configuration
protected com.google.inject.Injector	coreConfigInjector
protected boolean	dumpConfig
protected boolean	dumpDefaultConfig
protected static String	FILE_SEPARATOR
protected com.google.inject.Injector	injector
protected com.github.joschi.jadconfig.JadConfig	jadConfig
protected static String	TMPDIR
protected static Version	version

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CmdLineTool(BaseConfiguration configuration)
protected	CmdLineTool(String commandName, BaseConfiguration configuration)

Method Summary

Modifier and Type	Method and Description
protected void	annotateInjectorCreationException(com.google.inject.CreationException e)
protected void	annotateInjectorExceptions(Collection<com.google.inject.spi.Message> messages)
protected static void	applySecuritySettings(TLSProtocolsConfiguration configuration)
protected void	beforeStart() Things that have to run before the startCommand() method is being called.
protected void	beforeStart(TLSProtocolsConfiguration configuration)
protected Set<ServerStatus.Capability>	capabilities()
protected abstract List<com.google.inject.Module>	getCommandBindings()
protected abstract List<Object>	getCommandConfigurationBeans()
protected Collection<com.github.joschi.jadconfig.Repository>	getConfigRepositories(String configFile)
protected List<com.google.inject.Module>	getSharedBindingsModules()
boolean	isDebug()
boolean	isDumpConfig()
boolean	isDumpDefaultConfig()
protected Set<Plugin>	loadPlugins(Path pluginPath, ChainingClassLoader chainingClassLoader)
protected boolean	onlyLogErrors()
protected void	processConfiguration(com.github.joschi.jadconfig.JadConfig jadConfig)
void	run()
protected com.google.inject.Injector	setupCoreConfigInjector() Set up a separate injector, containing only the core configuration bindings.
protected com.google.inject.Injector	setupInjector(com.github.joschi.jadconfig.guice.NamedConfigParametersModule configModule, com.google.inject.Module... otherModules)
protected org.apache.logging.log4j.Level	setupLogger()
protected abstract void	startCommand()
protected boolean	validateConfiguration() Validate the given configuration for this command.

Methods inherited from class java.lang.Object

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

Field Detail

version

protected static final Version version

FILE_SEPARATOR

protected static final String FILE_SEPARATOR

TMPDIR

protected static final String TMPDIR

jadConfig

protected final com.github.joschi.jadconfig.JadConfig jadConfig

configuration

protected final BaseConfiguration configuration

chainingClassLoader

protected final ChainingClassLoader chainingClassLoader

dumpConfig

@Option(name="--dump-config",
        description="Show the effective Graylog configuration and exit")
protected boolean dumpConfig

dumpDefaultConfig

@Option(name="--dump-default-config",
        description="Show the default configuration and exit")
protected boolean dumpDefaultConfig

commandName

protected String commandName

injector

protected com.google.inject.Injector injector

coreConfigInjector

protected com.google.inject.Injector coreConfigInjector

Constructor Detail

CmdLineTool

protected CmdLineTool(BaseConfiguration configuration)

CmdLineTool

protected CmdLineTool(String commandName,
                      BaseConfiguration configuration)

Method Detail

validateConfiguration

protected boolean validateConfiguration()

Validate the given configuration for this command.

Returns:

true if the configuration is valid, false.

isDumpConfig

public boolean isDumpConfig()

isDumpDefaultConfig

public boolean isDumpDefaultConfig()

isDebug

public boolean isDebug()

getCommandBindings

protected abstract List<com.google.inject.Module> getCommandBindings()

getCommandConfigurationBeans

protected abstract List<Object> getCommandConfigurationBeans()

beforeStart

protected void beforeStart()

Things that have to run before the startCommand() method is being called.

beforeStart

protected void beforeStart(TLSProtocolsConfiguration configuration)

applySecuritySettings

protected static void applySecuritySettings(TLSProtocolsConfiguration configuration)

run

public void run()

Specified by:

run in interface Runnable

startCommand

protected abstract void startCommand()

setupLogger

protected org.apache.logging.log4j.Level setupLogger()

onlyLogErrors

protected boolean onlyLogErrors()

loadPlugins

protected Set<Plugin> loadPlugins(Path pluginPath,
                                  ChainingClassLoader chainingClassLoader)

getConfigRepositories

protected Collection<com.github.joschi.jadconfig.Repository> getConfigRepositories(String configFile)

processConfiguration

protected void processConfiguration(com.github.joschi.jadconfig.JadConfig jadConfig)

getSharedBindingsModules

protected List<com.google.inject.Module> getSharedBindingsModules()

setupInjector

protected com.google.inject.Injector setupInjector(com.github.joschi.jadconfig.guice.NamedConfigParametersModule configModule,
                                                   com.google.inject.Module... otherModules)

setupCoreConfigInjector

protected com.google.inject.Injector setupCoreConfigInjector()

Set up a separate injector, containing only the core configuration bindings. It can be used to look up configuration values in modules at binding time.

annotateInjectorCreationException

protected void annotateInjectorCreationException(com.google.inject.CreationException e)

annotateInjectorExceptions

protected void annotateInjectorExceptions(Collection<com.google.inject.spi.Message> messages)

capabilities

protected Set<ServerStatus.Capability> capabilities()