Package fish.payara.nucleus.microprofile.config.source.extension

Class BaseSetConfigSourceConfigurationCommand<C extends ConfigSourceConfiguration>

java.lang.Object

fish.payara.nucleus.microprofile.config.source.extension.BaseSetConfigSourceConfigurationCommand<C>

All Implemented Interfaces:

AdminCommand

Direct Known Subclasses:

SetAWSSecretsConfigSourceConfigurationCommand, SetAzureSecretsConfigSourceConfigurationCommand, SetDynamoDBConfigSourceConfigurationCommand, SetGCPSecretsConfigSourceConfigurationCommand, SetHashiCorpSecretsConfigSourceConfigurationCommand, SetLDAPConfigSourceConfiguration

public abstract class BaseSetConfigSourceConfigurationCommand<C extends ConfigSourceConfiguration>
extends Object
implements AdminCommand

The base admin command to set the configuration of a specified config source. Extend this class to configure custom config source configuration options from @Param injected fields.

Author:

Matthew Gill

Field Summary

Fields

Modifier and Type	Field	Description
protected Boolean	dynamic
protected Boolean	enabled
protected Logger	logger
protected ServerEnvironment	server
protected String	target
protected Target	targetUtil

Constructor Summary

Constructors

Constructor	Description
BaseSetConfigSourceConfigurationCommand()

Method Summary

Modifier and Type	Method	Description
protected void	applyValues(ActionReport report, C configuration)	Configure the configuration ConfigBeanProxy from the @Param injected class fields.
protected void	configureDynamically(C configuration)	Called after static configuration if the dynamic field is enabled and this instance is the one selected.
void	execute(AdminCommandContext context)	Executes the command with the command parameters passed as Properties where the keys are the parameter names and the values are the parameter values

Methods inherited from class java.lang.Object

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

Field Detail

targetUtil

@Inject
protected Target targetUtil

server

@Inject
protected ServerEnvironment server

logger

@Inject
protected Logger logger

target

protected String target

dynamic

protected Boolean dynamic

enabled

protected Boolean enabled

Constructor Detail

BaseSetConfigSourceConfigurationCommand

public BaseSetConfigSourceConfigurationCommand()

Method Detail

execute

public void execute(AdminCommandContext context)

Description copied from interface: AdminCommand

Executes the command with the command parameters passed as Properties where the keys are the parameter names and the values are the parameter values

Specified by:

execute in interface AdminCommand

Parameters:

context - information

applyValues

protected void applyValues(ActionReport report,
                           C configuration)
                    throws PropertyVetoException

Configure the configuration ConfigBeanProxy from the @Param injected class fields.

Parameters:

configuration - the ConfigBeanProxy to configure

Throws:

PropertyVetoException - an exception thrown if the property doesn't pass the configured validation.

configureDynamically

protected void configureDynamically(C configuration)

Called after static configuration if the dynamic field is enabled and this instance is the one selected.