org.wildfly.plugin.cli

Class CommandConfiguration

java.lang.Object

org.wildfly.plugin.cli.CommandConfiguration

public class CommandConfiguration
extends Object

The configuration used to execute CLI commands.

Author:

James R. Perkins

Method Summary

Modifier and Type	Method and Description
CommandConfiguration	addCommands(Collection<String> commands) Adds the commands to the CLI commands that should be executed.
CommandConfiguration	addJvmOptions(String... jvmOptions) Adds the JVM options used if isFork() or isOffline() is set to true.
CommandConfiguration	addPropertiesFiles(Collection<File> propertiesFiles) Adds the properties files to use when executing CLI scripts or commands.
CommandConfiguration	addScripts(Collection<File> scripts) Adds the scripts to be executed.
CommandConfiguration	addSystemProperties(Map<String,String> systemProperties) Adds to the system properties to set before the CLI commands are executed.
org.jboss.as.controller.client.ModelControllerClient	getClient() Returns the management client.
MavenModelControllerClientConfiguration	getClientConfiguration() Returns the management client configuration.
Collection<String>	getCommands() Returns the commands to be executed.
Path	getJBossHome() Returns the JBoss Home directory.
Collection<String>	getJvmOptions() Returns the JVM options used if isFork() or isOffline() is set to true.
Collection<Path>	getPropertiesFiles() The properties files to use when executing CLI scripts or commands.
Collection<Path>	getScripts() Returns the scripts to be executed.
String	getStdout() The pattern used to determine how standard out is handled for a new CLI process.
Map<String,String>	getSystemProperties() Returns the system properties to set before CLI commands are executed.
int	getTimeout() Gets the timeout, in seconds, used for the management connection.
boolean	isBatch() Indicates whether or not the commands should be run in a batch or not.
boolean	isFailOnError() Indicates whether or not CLI commands should fail if the command ends in an error or not.
boolean	isFork() Indicates whether or not CLI commands should be executed in a new process.
boolean	isOffline() Indicates whether or not this should be an offline process.
static CommandConfiguration	of(Supplier<org.jboss.as.controller.client.ModelControllerClient> clientSupplier, Supplier<MavenModelControllerClientConfiguration> clientConfigurationSupplier) Creates a new command configuration.
CommandConfiguration	setBatch(boolean batch) Sets whether or not the commands should be executed in a batch or not.
CommandConfiguration	setFailOnError(boolean failOnError) Sets whether or not CLI commands should fail if the command ends in an error or not.
CommandConfiguration	setFork(boolean fork) Sets whether or not the commands should be executed in a new process.
CommandConfiguration	setJBossHome(Path jbossHome) Sets the JBoss Home directory.
CommandConfiguration	setJBossHome(String jbossHome) Sets the JBoss Home directory.
CommandConfiguration	setOffline(boolean offline) Sets whether a client should be associated with the CLI context.
CommandConfiguration	setStdout(String stdout) Sets how the standard output stream should be handled if isFork() or isOffline() is set to true.
CommandConfiguration	setTimeout(int timeout) Sets the timeout, in seconds, used for the management client connection.

Methods inherited from class java.lang.Object

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

Method Detail

of

public static CommandConfiguration of(Supplier<org.jboss.as.controller.client.ModelControllerClient> clientSupplier,
                                      Supplier<MavenModelControllerClientConfiguration> clientConfigurationSupplier)

Creates a new command configuration.

Parameters:

clientSupplier - the supplier used to get a management client

clientConfigurationSupplier - a supplier used to get the client configuration

Returns:

a new command configuration

isBatch

public boolean isBatch()

Indicates whether or not the commands should be run in a batch or not.

Returns:

true if the commands should be executed in a batch, otherwise false

setBatch

public CommandConfiguration setBatch(boolean batch)

Sets whether or not the commands should be executed in a batch or not.

Parameters:

batch - true if the commands should be executed in a batch, otherwise false

Returns:

this configuration

getClient

public org.jboss.as.controller.client.ModelControllerClient getClient()

Returns the management client.

Returns:

the management client

getClientConfiguration

public MavenModelControllerClientConfiguration getClientConfiguration()

Returns the management client configuration.

Returns:

the management client configuration

getJBossHome

public Path getJBossHome()

Returns the JBoss Home directory.

Returns:

the JBoss Home directory or null if the value was not set

setJBossHome

public CommandConfiguration setJBossHome(String jbossHome)

Sets the JBoss Home directory.

Parameters:

jbossHome - the JBoss Home directory or null if the value is not required

Returns:

this configuration

setJBossHome

public CommandConfiguration setJBossHome(Path jbossHome)

Sets the JBoss Home directory.

Parameters:

jbossHome - the JBoss Home directory or null if the value is not required

Returns:

this configuration

getJvmOptions

public Collection<String> getJvmOptions()

Returns the JVM options used if isFork() or isOffline() is set to true.

Returns:

the JVM options

addJvmOptions

public CommandConfiguration addJvmOptions(String... jvmOptions)

Adds the JVM options used if isFork() or isOffline() is set to true.

Parameters:

jvmOptions - the JVM options or null

Returns:

this configuration

getSystemProperties

public Map<String,String> getSystemProperties()

Returns the system properties to set before CLI commands are executed.

Returns:

the system properties to set before CLI commands are executed

addSystemProperties

public CommandConfiguration addSystemProperties(Map<String,String> systemProperties)

Adds to the system properties to set before the CLI commands are executed.

Parameters:

systemProperties - the system properties or null

Returns:

this configuration

getPropertiesFiles

public Collection<Path> getPropertiesFiles()

The properties files to use when executing CLI scripts or commands.

Returns:

the paths to the properties files

addPropertiesFiles

public CommandConfiguration addPropertiesFiles(Collection<File> propertiesFiles)

Adds the properties files to use when executing CLI scripts or commands.

Parameters:

propertiesFiles - the property files to add

Returns:

this configuration

getCommands

public Collection<String> getCommands()

Returns the commands to be executed.

Returns:

the commands to be executed

addCommands

public CommandConfiguration addCommands(Collection<String> commands)

Adds the commands to the CLI commands that should be executed.

Parameters:

commands - the commands to be executed

Returns:

this configuration

getScripts

public Collection<Path> getScripts()

Returns the scripts to be executed.

Returns:

the scripts to be executed

addScripts

public CommandConfiguration addScripts(Collection<File> scripts)

Adds the scripts to be executed.

Parameters:

scripts - the scripts to be executed

Returns:

this configuration

isFailOnError

public boolean isFailOnError()

Indicates whether or not CLI commands should fail if the command ends in an error or not.

Returns:

true if a CLI command fails then the execution should fail

setFailOnError

public CommandConfiguration setFailOnError(boolean failOnError)

Sets whether or not CLI commands should fail if the command ends in an error or not.

Parameters:

failOnError - true if a CLI command fails then the execution should fail

Returns:

this configuration

isFork

public boolean isFork()

Indicates whether or not CLI commands should be executed in a new process.

Returns:

true to execute CLI commands in a new process

setFork

public CommandConfiguration setFork(boolean fork)

Sets whether or not the commands should be executed in a new process.

Note that is isOffline() is set to true this has no effect.

Parameters:

fork - true if commands should be executed in a new process

Returns:

this configuration

isOffline

public boolean isOffline()

Indicates whether or not this should be an offline process.

Returns:

true if this should be an offline process, otherwise false

setOffline

public CommandConfiguration setOffline(boolean offline)

Sets whether a client should be associated with the CLI context.

Note this launches CLI in a new process.

Parameters:

offline - true if this should be an offline process

Returns:

this configuration

getStdout

public String getStdout()

The pattern used to determine how standard out is handled for a new CLI process.

Returns:

the standard out pattern

setStdout

public CommandConfiguration setStdout(String stdout)

Sets how the standard output stream should be handled if isFork() or isOffline() is set to true.

Parameters:

stdout - the pattern for standard out

Returns:

this configuration

getTimeout

public int getTimeout()

Gets the timeout, in seconds, used for the management connection.

Returns:

the timeout used for the management connection

setTimeout

public CommandConfiguration setTimeout(int timeout)

Sets the timeout, in seconds, used for the management client connection.

Parameters:

timeout - the timeout to use in seconds

Returns:

this configuration