io.sarl.sre.boot.commands

Class AbstractRunCommand

java.lang.Object

io.bootique.command.CommandWithMetadata

io.sarl.sre.boot.commands.AbstractRunCommand

All Implemented Interfaces:

io.bootique.command.Command

public abstract class AbstractRunCommand
extends io.bootique.command.CommandWithMetadata

Abstract command for running the SRE without agent at boot time.

This abstract command provides helping tools for implementing a launching command.

Since:

0.9

Version:

io.janusproject.plugin 0.12.0 20210527-171007

Author:

Stéphane Galland

Maven Group Id:

io.janusproject.sre

Maven Artifact Id:

io.janusproject.plugin

Field Summary

Fields

Modifier and Type	Field and Description
protected javax.inject.Provider<SreConfig>	configuration Launching configuration.

Constructor Summary

Constructors

Constructor and Description
AbstractRunCommand(configuration : javax.inject.Provider<SreConfig>, commandBuilder : io.bootique.meta.application.CommandMetadata.Builder) Constructor.

Method Summary

Modifier and Type	Method and Description
protected SREBootstrap	getSREBootstrap() Replies the SRE bootstrap.
protected boolean	isAgentType(value : String) Replies if the given value is the fully qualified name of an agent's type.
protected void	startAgentsFromConfig(bootstrap : SREBootstrap, config : BootConfig) Start all the boot agents that are defined into the configuration.
protected BootConfig	synchronizeCliWithBootConfig(args : io.bootique.cli.Cli, maxNbAgents : int) Synchronizes the command-line arguments and the SRE configuration.

Methods inherited from class io.bootique.command.CommandWithMetadata

getMetadata, run

Methods inherited from class java.lang.Object

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

Field Detail

configuration

protected val configuration : javax.inject.Provider<SreConfig>

Description copied from class: AbstractRunCommand

Launching configuration.

Constructor Detail

AbstractRunCommand

public new(configuration : javax.inject.Provider<SreConfig>,
           commandBuilder : io.bootique.meta.application.CommandMetadata.Builder)

Constructor.

Parameters:

configuration - the configuration of the tool.

commandBuilder - the builder of the command.

lock - the lock to use for synchronizing.

Method Detail

isAgentType

@Pure
protected def isAgentType(value : String) : boolean 

Description copied from class: AbstractRunCommand

Replies if the given value is the fully qualified name of an agent's type. An agent's type is a Class that extends the Agent type.

Parameters:

value - the value to test.

Returns:

true if the given value is the fully qualified name of an agent's type.

synchronizeCliWithBootConfig

protected def synchronizeCliWithBootConfig(args : io.bootique.cli.Cli,
                                           maxNbAgents : int) : BootConfig 

Description copied from class: AbstractRunCommand

Synchronizes the command-line arguments and the SRE configuration. This function gets the arguments from the given Cli and updates the SreConfig.

Parameters:

args - the definition of the command line arguments

maxNbAgents - is the maximum number of agents to be launched.

Returns:

the boot configuration.

getSREBootstrap

@Pure
protected def getSREBootstrap() : SREBootstrap 

Description copied from class: AbstractRunCommand

Replies the SRE bootstrap.

Returns:

the SRE bootstrap.

startAgentsFromConfig

protected def startAgentsFromConfig(bootstrap : SREBootstrap,
                                    config : BootConfig) : void 

Description copied from class: AbstractRunCommand

Start all the boot agents that are defined into the configuration.

Parameters:

bootstrap - the SRE bootstrap.

config - the configuration to use.