SreMain (SARL Agent Oriented Programming Language 0.12.0 API)

All Implemented Interfaces:

SREBootstrap
```
public class SreMain
extends Object
implements SREBootstrap
```
Class that implements the standard main function for running a SARL run-time environment with bootique modules.

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addSREListener(listener : SREListener)` Add an observer on the SRE.
`protected io.bootique.BQRuntime`	`createRuntime(bootique : io.bootique.Bootique, module : Class<? extends com.google.inject.Module>, args : String*)` Create the SRE runtime.
`static String[]`	`filterCommandLineArguments(args : String[])` Filter the command-line arguments for extracting the -D parameters.
`protected void`	`fireSREStarted()` Notifies the observers that the SRE has been started.
`protected void`	`fireSREStopped()` Notifies the observers that the SRE has been stopped.
`Kernel`	`getKernel()` Replies the reference to the kernel.
`Logger`	`getKernelLogger()` Replies the logger used by the SRE.
`io.bootique.BQRuntime`	`getRuntime()`
`<T> T`	`getService(serviceType : Class<T>)` Replies the service of the given type that is implemented into the SRE.
`UUID`	`getUniverseContextUUID()` Replies the UUID of the root/universe context that is given by the user of the bootstrap.
`UUID`	`getUniverseSpaceUUID()` Replies the UUID of the root/universe default space that is given by the user of the bootstrap.
`boolean`	`isRunning()` Replies if the kernel is running.
`void`	`removeSREListener(listener : SREListener)` Remove the given observer on the SRE.
`int`	`runSRE(args : String*)` Run the SRE.
`void`	`setBootAgentTypeContextUUID()` Force the SRE platform to use a default context identifier that is build upon the classname of the boot agent.
`void`	`setCommandLineArguments(commandLineArguments : String[])` Specify arguments that should be used by the SRE as command-line arguments.
`void`	`setRandomContextUUID()` Force the SRE platform to use a random identifier for its default context.
`boolean`	`setRuntime(runtime : io.bootique.BQRuntime)` Set the Bootique runtime instance.
`void`	`setSpecificContextUUID()` Force the SRE platform to use the identifier hard-coded in the source code for its default context.
`void`	`setUniverseContextUUID(id : UUID)` Force the identifier of the root/universe context in case the SRE is run when the `default identifier mode is enabled`.
`void`	`setUniverseSpaceUUID(id : UUID)` Force the identifier of the root/universe default space in case the SRE is run when the `default identifier mode is enabled`.
`void`	`setVerboseLevel(level : int)` Force the verbosity level.
`void`	`shutdown(timeout : int)` Stop the SRE.
`void`	`startAgent(agentCls : Class<? extends Agent>, params : Object*)` Launch the SRE and the first agent in the kernel.
`void`	`startAgent(nbAgents : int, agentCls : Class<? extends Agent>, params : Object*)` Launch the SRE and the first agent in the kernel.
`void`	`startAgentWithID(agentCls : Class<? extends Agent>, agentID : UUID, params : Object*)` Launch the SRE and the first agent in the kernel and assigning a specific UUID.
`void`	`startBootAgent()` Start the boot agent if it is specified in the boot configuration.
`AgentContext`	`startWithoutAgent(asCommandLineApp : boolean, [bootique : io.bootique.Bootique], [module : Class<? extends com.google.inject.Module>])` Start the agent framework without agent.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.sarl.bootstrap.SREBootstrap
isActive, setOffline, shutdown, shutdown, startWithoutAgent, startWithoutAgent

- Method Detail
  - getKernel
```
@Pure
public def getKernel() : Kernel 
```
    Description copied from class: SreMain
    
    Replies the reference to the kernel.
    
    Returns:
    
    the reference to the kernel.
  - setRuntime
```
public def setRuntime(runtime : io.bootique.BQRuntime) : boolean 
```
    Description copied from class: SreMain
    
    Set the Bootique runtime instance.
    
    Parameters:
    
    runtime - the new Bootique runtime.
    
    Returns:
    
    true if the runtime has been changed.
  - isRunning
```
@Pure
public def isRunning() : boolean 
```
    Description copied from interface: SREBootstrap
    
    Replies if the kernel is running.
    
    Specified by:
    
    isRunning in interface SREBootstrap
    
    Returns:
    
    true if the kernel is running. false is replied if the kernel was stopped.
  - setRandomContextUUID
```
public def setRandomContextUUID() : void 
```
    Description copied from interface: SREBootstrap
    
    Force the SRE platform to use a random identifier for its default context.
    This function has no effect if the agent framework is already launched.
    
    Specified by:
    
    setRandomContextUUID in interface SREBootstrap
  - setBootAgentTypeContextUUID
```
public def setBootAgentTypeContextUUID() : void 
```
    Description copied from interface: SREBootstrap
    
    Force the SRE platform to use a default context identifier that is build upon the classname of the boot agent. It means that the UUID is always the same for a given classname.
    This function has no effect if the agent framework is already launched.
    
    Specified by:
    
    setBootAgentTypeContextUUID in interface SREBootstrap
  - setSpecificContextUUID
```
public def setSpecificContextUUID() : void 
```
    Description copied from interface: SREBootstrap
    
    Force the SRE platform to use the identifier hard-coded in the source code for its default context.
    This function has no effect if the agent framework is already launched.
    
    Specified by:
    
    setSpecificContextUUID in interface SREBootstrap
    
    See Also:
    
    SREBootstrap.setUniverseContextUUID(UUID), SREBootstrap.getUniverseContextUUID(), SREBootstrap.setUniverseSpaceUUID(UUID), SREBootstrap.getUniverseSpaceUUID()
  - setUniverseContextUUID
```
public def setUniverseContextUUID(id : UUID) : void 
```
    Description copied from interface: SREBootstrap
    
    Force the identifier of the root/universe context in case the SRE is run when the default identifier mode is enabled.
    This function has no effect if the agent framework is already launched.
    
    Specified by:
    
    setUniverseContextUUID in interface SREBootstrap
    
    Parameters:
    
    id - the identifier, or null if the default identifier should be used.
  - getUniverseContextUUID
```
@Pure
public def getUniverseContextUUID() : UUID 
```
    Description copied from interface: SREBootstrap
    
    Replies the UUID of the root/universe context that is given by the user of the bootstrap.
    This function has no effect if the agent framework is already launched.
    
    Specified by:
    
    getUniverseContextUUID in interface SREBootstrap
    
    Returns:
    
    the identifier, or null if no identifier is provided by the user and the default identifier should be used.
  - setUniverseSpaceUUID
```
public def setUniverseSpaceUUID(id : UUID) : void 
```
    Description copied from interface: SREBootstrap
    
    Force the identifier of the root/universe default space in case the SRE is run when the default identifier mode is enabled.
    This function has no effect if the agent framework is already launched.
    
    Specified by:
    
    setUniverseSpaceUUID in interface SREBootstrap
    
    Parameters:
    
    id - the identifier, or null if the default identifier should be used.
  - getUniverseSpaceUUID
```
@Pure
public def getUniverseSpaceUUID() : UUID 
```
    Description copied from interface: SREBootstrap
    
    Replies the UUID of the root/universe default space that is given by the user of the bootstrap.
    This function has no effect if the agent framework is already launched.
    
    Specified by:
    
    getUniverseSpaceUUID in interface SREBootstrap
    
    Returns:
    
    the identifier, or null if no identifier is provided by the user and the default identifier should be used.
  - setVerboseLevel
```
public def setVerboseLevel(level : int) : void 
```
    Description copied from interface: SREBootstrap
    Force the verbosity level.
    This function may have no effect if the agent framework is already launched. This depends on the implementation of the SRE.
    The value of the level argument does not depend on a specific logging infrastructure. Indeed, JUL, Log4J and SLF4J attach different numeric values to the different logging levels. Consequently, the numerical values that are assummed by this function are:
    - <= 0: off, no logging.
    - = 1: errors only.
    - = 2: errors and warnings.
    - = 3: errors, warnings and info.
    - = 4: errors, warnings, info, debug 1.
    - = 5: errors, warnings, info, debug 1 to 2.
    - = 6: errors, warnings, info, debug 1 to 3.
    - = 7: all messages.
    Specified by:
    
    setVerboseLevel in interface SREBootstrap
    
    Parameters:
    
    level - the verbosity level. See explanation in the documentation of this function.
  - getKernelLogger
```
@Pure
public def getKernelLogger() : Logger 
```
    Description copied from interface: SREBootstrap
    
    Replies the logger used by the SRE.
    This function replies a not null value only if the kernel was launched.
    
    Specified by:
    
    getKernelLogger in interface SREBootstrap
    
    Returns:
    
    the logger, or null if the kernel was not launched or has no logger.
  - createRuntime
```
protected def createRuntime(bootique : io.bootique.Bootique,
                            module : Class<? extends com.google.inject.Module>,
                            args : String*) : io.bootique.BQRuntime 
```
    Description copied from class: SreMain
    
    Create the SRE runtime.
    
    Parameters:
    
    bootique - the instance of the bootique accessor, or null if none is provided.
    
    module - specify the type of the injection module to be used by the bootique accessor.
    
    args - the command line arguments to put into the bootique accessor. This argument is used only if bootique is evaluated to null.
    
    Returns:
    
    the runtime.
  - filterCommandLineArguments
```
public static def filterCommandLineArguments(args : String[]) : String[] 
```
    Description copied from class: SreMain
    
    Filter the command-line arguments for extracting the -D parameters.
    
    Parameters:
    
    args - the arguments.
    
    Returns:
    
    the filtered arguments.
    
    Since:
    
    0.12
  - runSRE
```
public def runSRE(args : String*) : int 
```
    Description copied from class: SreMain
    
    Run the SRE.
    This function runs the SRE and exits with the return code.
    
    Parameters:
    
    args - the command line arguments.
    
    Returns:
    
    the exit code.
  - startWithoutAgent
```
public def startWithoutAgent(asCommandLineApp : boolean,
                             [bootique : io.bootique.Bootique],
                             [module : Class<? extends com.google.inject.Module>]) : AgentContext 
```
    Description copied from class: SreMain
    
    Start the agent framework without agent.
    
    Parameters:
    
    asCommandLineApp - indicates if the application should be started as a commend-line application. If true, the SRE is started and run directly. Then, the "start agent" functions becomes unusable because the SRE has started everything as it is called from the shell command line. If false, the SRE is started in is normal way and all the functions are available according to their own specifications. If it not recommended to invoke this function with this argument evaluated to true.
    
    bootique - the Bootique instance to set up the framework. If it is null, the default Bootique instance is created.
    
    module - the injection module to use. If it is null, the default module is used.
  - startAgent
```
public def startAgent(nbAgents : int,
                      agentCls : Class<? extends Agent>,
                      params : Object*) : void 
```
    Description copied from interface: SREBootstrap
    
    Launch the SRE and the first agent in the kernel.
    The function #getBootAgentIdentifier() permits to retrieve the identifier of the first launched agent.
    
    Specified by:
    
    startAgent in interface SREBootstrap
    
    Parameters:
    
    nbAgents - the number of agents to be launched.
    
    agentCls - type of the first agent to launch.
    
    params - parameters to pass to the agent as its initialization parameters.
    
    See Also:
    
    #getBootAgentIdentifier()
  - startBootAgent
```
public def startBootAgent() : void 
```
    Description copied from class: SreMain
    
    Start the boot agent if it is specified in the boot configuration.
  - startAgent
```
public def startAgent(agentCls : Class<? extends Agent>,
                      params : Object*) : void 
```
    Description copied from interface: SREBootstrap
    
    Launch the SRE and the first agent in the kernel.
    The function #getBootAgentIdentifier() permits to retrieve the identifier of the first launched agent.
    
    Specified by:
    
    startAgent in interface SREBootstrap
    
    Parameters:
    
    agentCls - type of the first agent to launch.
    
    params - parameters to pass to the agent as its initialization parameters.
    
    See Also:
    
    #getBootAgentIdentifier()
  - startAgentWithID
```
public def startAgentWithID(agentCls : Class<? extends Agent>,
                            agentID : UUID,
                            params : Object*) : void 
```
    Description copied from interface: SREBootstrap
    
    Launch the SRE and the first agent in the kernel and assigning a specific UUID.
    
    Specified by:
    
    startAgentWithID in interface SREBootstrap
    
    Parameters:
    
    agentCls - type of the first agent to launch.
    
    agentID - the identifier of the agent to be created.
    
    params - parameters to pass to the agent as its initialization parameters.
  - shutdown
```
public def shutdown(timeout : int) : void 
```
    Description copied from interface: SREBootstrap
    
    Stop the SRE. This function may cause the agents to stop during the run of a behavior. This function returns when the kernel and all its services are stopped.
    
    Specified by:
    
    shutdown in interface SREBootstrap
    
    Parameters:
    
    timeout - the maximum amount of milliseconds to wait for the shutdown. If the provided value is strictly positive, it is the number of milliseconds to wait for the termination of the shutdown. If the provided value is equal to 0, the function returns as soon as the shutdown process is launch (no waiting for the termination of the shutdown). If the value is strictly negative, the function waits forever for the termination of the shutdown process. The default value is -1.
    
    See Also:
    
    SREBootstrap.shutdown(), SREBootstrap.shutdown(boolean), SREBootstrap.shutdown(int)
  - getService
```
@Pure
public def getService(serviceType : Class<T>) : T  with <T> 
```
    Description copied from interface: SREBootstrap
    
    Replies the service of the given type that is implemented into the SRE.
    
    Specified by:
    
    getService in interface SREBootstrap
    
    Type Parameters:
    
    T - the type of the service.
    
    Parameters:
    
    serviceType - the type of the service.
    
    Returns:
    
    the service instance, or null if the SRE does not have any instance of service of the given type.
  - addSREListener
```
public def addSREListener(listener : SREListener) : void 
```
    Description copied from interface: SREBootstrap
    
    Add an observer on the SRE.
    
    Specified by:
    
    addSREListener in interface SREBootstrap
    
    Parameters:
    
    listener - the observer to add.
  - removeSREListener
```
public def removeSREListener(listener : SREListener) : void 
```
    Description copied from interface: SREBootstrap
    
    Remove the given observer on the SRE.
    
    Specified by:
    
    removeSREListener in interface SREBootstrap
    
    Parameters:
    
    listener - the observer to remove.
  - fireSREStarted
```
protected def fireSREStarted() : void 
```
    Description copied from class: SreMain
    
    Notifies the observers that the SRE has been started.
    
    Since:
    
    0.11
  - fireSREStopped
```
protected def fireSREStopped() : void 
```
    Description copied from class: SreMain
    
    Notifies the observers that the SRE has been stopped.
    
    Since:
    
    0.11
  - getRuntime
```
@Pure
public def getRuntime() : io.bootique.BQRuntime 
```
  - setCommandLineArguments
```
public def setCommandLineArguments(commandLineArguments : String[]) : void 
```
    Description copied from interface: SREBootstrap
    
    Specify arguments that should be used by the SRE as command-line arguments. These arguments are usually used as start-up of the SRE.
    
    Specified by:
    
    setCommandLineArguments in interface SREBootstrap
    
    Parameters:
    
    commandLineArguments - the command-line arguments.

Class SreMain

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface io.sarl.bootstrap.SREBootstrap

Method Detail

getKernel

setRuntime

isRunning

setRandomContextUUID

setBootAgentTypeContextUUID

setSpecificContextUUID

setUniverseContextUUID

getUniverseContextUUID

setUniverseSpaceUUID

getUniverseSpaceUUID

setVerboseLevel

getKernelLogger

createRuntime

filterCommandLineArguments

runSRE

startWithoutAgent

startAgent

startBootAgent

startAgent

startAgentWithID

shutdown

getService

addSREListener

removeSREListener

fireSREStarted

fireSREStopped

getRuntime

setCommandLineArguments