SREBootstrap (SARL Agent Oriented Programming Language 0.12.0 API)

All Known Implementing Classes:

SreMain
```
public interface SREBootstrap
```
Represents an access point to the SARL run-time environment (SRE). This access point may be used for accessing the underlying SRE independently of its implementation.
Depending on the implementation of the SRE, an instance of this SRE access point could be injected.

Since:

0.6

Version:

io.sarl.lang.core 0.12.0 20210527-171007

Author:

Stéphane Galland

Maven Group Id:

io.sarl.lang

Maven Artifact Id:

io.sarl.lang.core

Method Summary

All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addSREListener(listener : SREListener)` Add an observer on the SRE.
`default Logger`	`getKernelLogger()` Replies the logger used by the SRE.
`<T> T`	`getService(serviceType : Class<T>)` Replies the service of the given type that is implemented into the SRE.
`default UUID`	`getUniverseContextUUID()` Replies the UUID of the root/universe context that is given by the user of the bootstrap.
`default UUID`	`getUniverseSpaceUUID()` Replies the UUID of the root/universe default space that is given by the user of the bootstrap.
`default boolean`	`isActive()` Replies if the bootstrap could be used.
`default boolean`	`isRunning()` Replies if the kernel is running.
`void`	`removeSREListener(listener : SREListener)` Remove the given observer on the SRE.
`default void`	`setBootAgentTypeContextUUID()` Force the SRE platform to use a default context identifier that is build upon the classname of the boot agent.
`void`	`setCommandLineArguments(arguments : String[])` Specify arguments that should be used by the SRE as command-line arguments.
`default void`	`setOffline(isOffline : boolean)` Deprecated. since 0.12, no direct replacement
`default void`	`setRandomContextUUID()` Force the SRE platform to use a random identifier for its default context.
`default void`	`setSpecificContextUUID()` Force the SRE platform to use the identifier hard-coded in the source code for its default context.
`default 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`.
`default 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`.
`default void`	`setVerboseLevel(level : int)` Force the verbosity level.
`default void`	`shutdown()` Stop the SRE.
`default void`	`shutdown(blocking : boolean)` Stop the SRE.
`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.
`default AgentContext`	`startWithoutAgent()` Start the SRE without an agent.
`AgentContext`	`startWithoutAgent(asCommandLineApp : boolean)` Start the SRE without an agent.

- Method Detail
  - setCommandLineArguments
```
def setCommandLineArguments(arguments : 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.
    
    Parameters:
    
    arguments - the command-line arguments.
    
    Since:
    
    0.12
  - startWithoutAgent
```
def startWithoutAgent(asCommandLineApp : boolean) : AgentContext 
```
    Description copied from interface: SREBootstrap
    
    Start the SRE without an agent. This function prepare the default context.
    
    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.
    
    Returns:
    
    the context that is created by the bootstrap. If null there is no context created.
    
    Since:
    
    0.12
    
    See Also:
    
    SREBootstrap.startWithoutAgent()
  - startWithoutAgent
```
default def startWithoutAgent() : AgentContext 
```
    Description copied from interface: SREBootstrap
    
    Start the SRE without an agent. This function prepare the default context.
    
    Returns:
    
    the context that is created by the bootstrap. If null there is no context created.
    
    Since:
    
    0.7
  - startAgent
```
def startAgent(agentCls : Class<? extends Agent>,
               params : Object*) : void 
        throws Exception
```
    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.
    
    Parameters:
    
    agentCls - type of the first agent to launch.
    
    params - parameters to pass to the agent as its initialization parameters.
    
    Throws:
    
    Exception - - if it is impossible to start the platform.
    
    See Also:
    
    #getBootAgentIdentifier()
  - startAgent
```
def startAgent(nbAgents : int,
               agentCls : Class<? extends Agent>,
               params : Object*) : void 
        throws Exception
```
    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.
    
    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.
    
    Throws:
    
    Exception - - if it is impossible to start the platform.
    
    See Also:
    
    #getBootAgentIdentifier()
  - startAgentWithID
```
def startAgentWithID(agentCls : Class<? extends Agent>,
                     agentID : UUID,
                     params : Object*) : void 
              throws Exception
```
    Description copied from interface: SREBootstrap
    
    Launch the SRE and the first agent in the kernel and assigning a specific UUID.
    
    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.
    
    Throws:
    
    Exception - - if it is impossible to start the platform.
    
    Since:
    
    0.10
  - isActive
```
@Pure
default def isActive() : boolean 
```
    Description copied from interface: SREBootstrap
    
    Replies if the bootstrap could be used.
    If the bootstrap cannot be used, it cannot launch agent.
    
    Returns:
    
    true if the bootstrap could be used. false if it cannot be used.
  - isRunning
```
@Pure
default def isRunning() : boolean 
```
    Description copied from interface: SREBootstrap
    
    Replies if the kernel is running.
    
    Returns:
    
    true if the kernel is running. false is replied if the kernel was stopped.
    
    Since:
    
    0.10
  - setOffline
```
@Deprecated
default def setOffline(isOffline : boolean) : void 
```
    Deprecated. since 0.12, no direct replacement
    
    Description copied from interface: SREBootstrap
    
    Set offline flag of the agent platform before it is launched.
    This function has no effect if the agent framework is already launched.
    
    Parameters:
    
    isOffline - the offline flag.
    
    Throws:
    
    UnsupportedOperationException - a runtime exception
    
    Since:
    
    0.7
  - setRandomContextUUID
```
default 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.
    
    Throws:
    
    UnsupportedOperationException - a runtime exception
    
    Since:
    
    0.7
  - setBootAgentTypeContextUUID
```
default 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.
    
    Throws:
    
    UnsupportedOperationException - a runtime exception
    
    Since:
    
    0.7
  - setSpecificContextUUID
```
default 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.
    
    Throws:
    
    UnsupportedOperationException - a runtime exception
    
    Since:
    
    0.9
    
    See Also:
    
    SREBootstrap.setUniverseContextUUID(UUID), SREBootstrap.getUniverseContextUUID(), SREBootstrap.setUniverseSpaceUUID(UUID), SREBootstrap.getUniverseSpaceUUID()
  - setUniverseContextUUID
```
default 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.
    
    Parameters:
    
    id - the identifier, or null if the default identifier should be used.
    
    Throws:
    
    UnsupportedOperationException - a runtime exception
    
    Since:
    
    0.9
  - getUniverseContextUUID
```
@Pure
default 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.
    
    Returns:
    
    the identifier, or null if no identifier is provided by the user and the default identifier should be used.
    
    Throws:
    
    UnsupportedOperationException - a runtime exception
    
    Since:
    
    0.9
  - setUniverseSpaceUUID
```
default 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.
    
    Parameters:
    
    id - the identifier, or null if the default identifier should be used.
    
    Throws:
    
    UnsupportedOperationException - a runtime exception
    
    Since:
    
    0.9
  - getUniverseSpaceUUID
```
@Pure
default 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.
    
    Returns:
    
    the identifier, or null if no identifier is provided by the user and the default identifier should be used.
    
    Throws:
    
    UnsupportedOperationException - a runtime exception
    
    Since:
    
    0.9
  - setVerboseLevel
```
default 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.
    Parameters:
    
    level - the verbosity level. See explanation in the documentation of this function.
    
    Throws:
    
    UnsupportedOperationException - a runtime exception
    
    Since:
    
    0.7
  - getKernelLogger
```
@Pure
default 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.
    
    Returns:
    
    the logger, or null if the kernel was not launched or has no logger.
    
    Since:
    
    0.10
  - shutdown
```
default def shutdown() : void 
              throws InterruptedException
```
    Description copied from interface: SREBootstrap
    
    Stop the SRE. This function may cause the agents to stop during the run of a behavior. This function has no timeout. This function returns when the kernel and all its services are stopped.
    
    Throws:
    
    InterruptedException - the shutdown process is interrupted.
    
    Since:
    
    0.10
    
    See Also:
    
    SREBootstrap.shutdown(boolean), SREBootstrap.shutdown(int), #shutdown(boolean, int)
  - shutdown
```
default def shutdown(blocking : boolean) : void 
              throws InterruptedException
```
    Description copied from interface: SREBootstrap
    
    Stop the SRE. This function may cause the agents to stop during the run of a behavior. This function has no timeout.
    If the argument's value is evaluated to true, the SREBootstrap.shutdown(int) functions is invoked with negative timeout; Otherwise the SREBootstrap.shutdown(int) functions is invoked with 0 value.
    
    Parameters:
    
    blocking - indicates if the functions is blocked until the shutdown task is finished. If it is true, the function returns when the kernel is down. If it is false, the function could return before the kernel is down.
    
    Throws:
    
    InterruptedException - the shutdown process is interrupted.
    
    Since:
    
    0.10
    
    See Also:
    
    SREBootstrap.shutdown(), SREBootstrap.shutdown(int), #shutdown(boolean, int)
  - shutdown
```
def shutdown(timeout : int) : void 
      throws InterruptedException
```
    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.
    
    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.
    
    Throws:
    
    InterruptedException - the shutdown process is interrupted.
    
    Since:
    
    0.11
    
    See Also:
    
    SREBootstrap.shutdown(), SREBootstrap.shutdown(boolean), SREBootstrap.shutdown(int)
  - getService
```
@Pure
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.
    
    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.
    
    Since:
    
    0.10
  - addSREListener
```
def addSREListener(listener : SREListener) : void 
```
    Description copied from interface: SREBootstrap
    
    Add an observer on the SRE.
    
    Parameters:
    
    listener - the observer to add.
    
    Since:
    
    0.11
  - removeSREListener
```
def removeSREListener(listener : SREListener) : void 
```
    Description copied from interface: SREBootstrap
    
    Remove the given observer on the SRE.
    
    Parameters:
    
    listener - the observer to remove.
    
    Since:
    
    0.11

Interface SREBootstrap

Method Summary

Method Detail

setCommandLineArguments

startWithoutAgent

startWithoutAgent

startAgent

startAgent

startAgentWithID

isActive

isRunning

setOffline

setRandomContextUUID

setBootAgentTypeContextUUID

setSpecificContextUUID

setUniverseContextUUID

getUniverseContextUUID

setUniverseSpaceUUID

getUniverseSpaceUUID

setVerboseLevel

getKernelLogger

shutdown

shutdown

shutdown

getService

addSREListener

removeSREListener