Package io.deephaven.configuration

Class DataRoutingConfigurationImpl

java.lang.Object

io.deephaven.configuration.ConfigurationImplBase

io.deephaven.configuration.DataRoutingConfigurationImpl

public class DataRoutingConfigurationImpl
extends ConfigurationImplBase

Tool for importing and exporting the routing configuration file.

Field Summary

Fields

Modifier and Type	Field	Description
protected final String	action
protected final String	cmdLineSyntax
protected org.apache.commons.cli.CommandLine	commandLine
protected String[]	commandLineArgs
protected com.fishlib.configuration.Configuration	configuration
protected final org.apache.commons.cli.Options	options

Method Summary

Modifier and Type	Method	Description
protected void	addAuthenticationOptions()	Add the common authentication options to the option set field.
protected void	addEditorOptions()
@Nullable String	editString(@NotNull String input)	Invoke an editor, such as vi, to edit the input string and "save" the output string.
protected void	enforceAggregateKeyIssues(@NotNull List<String> errors)	If any DIS location-key filters were flagged by findAggregateKeyIssues(java.util.Collection<com.illumon.iris.db.v2.routing.DataImportServiceConfig>), log a warning for each.
protected com.fishlib.configuration.Configuration	getConfiguration()	Delay construction - in some cases (e.g.
protected @NotNull WritableDataRoutingService	getDataRoutingService(@NotNull org.apache.commons.cli.CommandLine commandLine)
protected com.fishlib.io.logger.Logger	getUserLog()	Provide access to the user-facing Logger as currently configured.
protected void	logAuditAction()
protected void	requireSingular(@NotNull String option)	Require that the option have a single value.
protected String	requireSingular(@NotNull String option, @NotNull List<String> values)	Return the single value in the list, or throw an exception.
int	run()
protected void	setConfiguration(com.fishlib.configuration.Configuration newConfiguration)	Set the Configuration field.
protected void	setupRawConfig(@NotNull String appName, boolean diskProps, boolean etcdProps)
Collection<String>	supportedActions()

Methods inherited from class io.deephaven.configuration.ConfigurationImplBase

setupConfiguration

Methods inherited from class java.lang.Object

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

Field Details

options

protected final org.apache.commons.cli.Options options

cmdLineSyntax

protected final String cmdLineSyntax

action

protected final String action

commandLine

protected org.apache.commons.cli.CommandLine commandLine

configuration

protected volatile com.fishlib.configuration.Configuration configuration

commandLineArgs

protected String[] commandLineArgs

Method Details

supportedActions

public Collection<String> supportedActions()

run

public int run()
        throws HelpExceptions.CommandLineException,
ClientConnectionConfigProvider.ProviderException

Throws:

HelpExceptions.CommandLineException

ClientConnectionConfigProvider.ProviderException

enforceAggregateKeyIssues

protected void enforceAggregateKeyIssues(@NotNull
 @NotNull List<String> errors)
                                  throws HelpExceptions.CommandLineException

If any DIS location-key filters were flagged by findAggregateKeyIssues(java.util.Collection<com.illumon.iris.db.v2.routing.DataImportServiceConfig>), log a warning for each. Each command will be failed unless --ignore-errors was given or transientIgnoreErrors is set.

Parameters:

errors - a list of messages for filters that reference InternalPartition without handling the AggregateTableLocationKey placeholder

Throws:

HelpExceptions.CommandLineException - if any errors were found and neither --ignore-errors nor transientIgnoreErrors is set

getDataRoutingService

@NotNull
protected @NotNull WritableDataRoutingService getDataRoutingService(@NotNull
 @NotNull org.apache.commons.cli.CommandLine commandLine)
                                                             throws ClientConnectionConfigProvider.ProviderException

Throws:

ClientConnectionConfigProvider.ProviderException

getUserLog

protected com.fishlib.io.logger.Logger getUserLog()

Provide access to the user-facing Logger as currently configured. An interactive user should see messages logged here.

Returns:

the Logger

getConfiguration

protected com.fishlib.configuration.Configuration getConfiguration()

Delay construction - in some cases (e.g. using etcd) the Configuration.getInstance() call needs to be managed to avoid the default use of configuration service.

Returns:

the Configuration to use

setConfiguration

protected void setConfiguration(com.fishlib.configuration.Configuration newConfiguration)

Set the Configuration field. This allows control of the implementation and sane error reporting.

addAuthenticationOptions

protected void addAuthenticationOptions()

Add the common authentication options to the option set field.

addEditorOptions

protected void addEditorOptions()

logAuditAction

protected void logAuditAction()

setupRawConfig

protected void setupRawConfig(@NotNull
 @NotNull String appName,
 boolean diskProps,
 boolean etcdProps)

requireSingular

protected void requireSingular(@NotNull
 @NotNull String option)
                        throws HelpExceptions.CommandLineException

Require that the option have a single value.

Parameters:

option - the option to check

Throws:

HelpExceptions.CommandLineException - if the option has multiple values

requireSingular

protected String requireSingular(@NotNull
 @NotNull String option,
 @NotNull
 @NotNull List<String> values)
                          throws HelpExceptions.CommandLineException

Return the single value in the list, or throw an exception.

Parameters:

option - the option to check

values - the values that were given for the option

Throws:

HelpExceptions.CommandLineException - if the option has multiple values or none

editString

@Nullable
public @Nullable String editString(@NotNull
 @NotNull String input)
                            throws HelpExceptions.HelpException

Invoke an editor, such as vi, to edit the input string and "save" the output string.

Parameters:

input - the string to edit

Returns:

the possibly-modified string, or null if the editor failed or was canceled

Throws:

HelpExceptions.HelpException