org.jboss.as.controller.persistence

Interface ConfigurationExtension

All Known Implementing Classes:

YamlConfigurationExtension

public interface ConfigurationExtension

Interface for extensions of the XML boot configuration.

Author:

Emmanuel Hugonnet (c) 2021 Red Hat, Inc.

Method Summary

Modifier and Type	Method and Description
boolean	commandLineContainsArgument(String arg) Checks if the argument is one of those required for this configuration extension.
String	getCommandLineInstructions() Returns the command line instructions.
String[]	getCommandLineUsageArguments() Returns the command line usage arguments to be displayed for help.
ConfigurationExtension	load(Path... files) Loads supplemental configurations.
void	processOperations(ImmutableManagementResourceRegistration rootRegistration, List<ParsedBootOp> postExtensionOps) Process the already defined boot operations to update them with the supplemnetal configurations.
boolean	shouldProcessOperations(RunningMode mode) Checks if the configuration extension should process the supplemental configurations.

Method Detail

load

ConfigurationExtension load(Path... files)

Loads supplemental configurations.

Parameters:

files - the paths to files with supplemental configuration.

Returns:

the configuration extension.

getCommandLineUsageArguments

String[] getCommandLineUsageArguments()

Returns the command line usage arguments to be displayed for help.

Returns:

the command line usage arguments to be displayed for help.

commandLineContainsArgument

boolean commandLineContainsArgument(String arg)

Checks if the argument is one of those required for this configuration extension.

Parameters:

arg: - the command line or one of its argument.

Returns:

true if the argument is one of those required by this configuration extension - false otherwise.

getCommandLineInstructions

String getCommandLineInstructions()

Returns the command line instructions.

Returns:

the command line instructions.

shouldProcessOperations

boolean shouldProcessOperations(RunningMode mode)

Checks if the configuration extension should process the supplemental configurations.

Parameters:

mode: - the running mode of the server.

Returns:

true if the configuration extension should process operations - false otherwise.

processOperations

void processOperations(ImmutableManagementResourceRegistration rootRegistration,
                       List<ParsedBootOp> postExtensionOps)

Process the already defined boot operations to update them with the supplemnetal configurations.

Parameters:

rootRegistration: - metamodel.

postExtensionOps: - initial boot oerations.