BootConfig (SARL Agent Oriented Programming Language 0.12.0 API)

```
public class BootConfig
extends Object
```
Configuration for specifying the SRE booting parameters.

Since:

0.8.0

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
`static String`	`BOOT_AGENT_NAME` Name of the property that contains the agent to boot.
`static String`	`PREFIX` Prefix for the configuration entries of the boot modules.
`static String`	`PROGRAM_NAME_NAME` Name of the property that contains the name of the SRE main program from the external point of view.
`static String`	`PROGRAM_NAME_VALUE` Default value of the property that contains the name of the SRE main program from the external point of view.
`static String`	`ROOT_CONTEXT_BOOT_TYPE_NAME` Name of the property that contains the type of root context at boot.
`static String`	`ROOT_CONTEXT_ID_NAME` Name of the property that contains the identifier of the root context.
`static String`	`ROOT_CONTEXT_ID_VALUE` The default value for the root context identifier.
`static String`	`ROOT_DEFAULT_SPACE_ID_NAME` Name of the property that contains the identifier for the default space of the root context.
`static String`	`ROOT_DEFAULT_SPACE_ID_VALUE` The default value for the root default space identifier.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String[]`	`getAgentStartArgs()` Replies the arguments to pass to an agent when it is started.
`String`	`getBootAgent()` Replies the name of the agent to launch at boot time.
`String[]`	`getCommandLineArgs()` Replies the command line arguments that are passed to the program.
`String`	`getProgramName()` Replies the name of the SRE main program from the external point of view.
`RootContextType`	`getRootContextBootType()` Replies the type of id computation for the root context.
`UUID`	`getRootContextID()` Replies the identifier of the root context.
`UUID`	`getRootSpaceID()` Construct an identifier for the root default space.
`Class<? extends Agent>`	`loadBootAgent()` Replies the type of the agent to launch at boot time.
`void`	`setAgentStartArgs(args : String[])` Change the arguments to pass to an agent when it is started.
`void`	`setBootAgent(name : String)` Set the name of the agent to launch at boot time.
`void`	`setCommandLineArgs(args : String[])` Change the command line arguments that are passed to the program.
`void`	`setProgramName(name : String)` Set the name of the SRE main program from the external point of view.
`void`	`setRootContextBootType(type : RootContextType)` Set the type of id computation for the root context.
`void`	`setRootContextID(id : UUID)` Set the identifier of the root context.
`UUID`	`setRootSpaceID(id : UUID)` Set the identifier for the root default space.

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

- Field Detail
  - PREFIX
```
public static val PREFIX : String
```
    Description copied from class: BootConfig
    
    Prefix for the configuration entries of the boot modules.
    
    See Also:
    
    Constant Field Values
  - BOOT_AGENT_NAME
```
public static val BOOT_AGENT_NAME : String
```
    Description copied from class: BootConfig
    
    Name of the property that contains the agent to boot.
    
    See Also:
    
    Constant Field Values
  - ROOT_CONTEXT_ID_NAME
```
public static val ROOT_CONTEXT_ID_NAME : String
```
    Description copied from class: BootConfig
    
    Name of the property that contains the identifier of the root context.
    
    See Also:
    
    BootConfig.ROOT_CONTEXT_ID_VALUE, Constant Field Values
  - ROOT_CONTEXT_ID_VALUE
```
public static val ROOT_CONTEXT_ID_VALUE : String
```
    Description copied from class: BootConfig
    
    The default value for the root context identifier.
    
    See Also:
    
    BootConfig.ROOT_CONTEXT_ID_NAME, Constant Field Values
  - ROOT_DEFAULT_SPACE_ID_NAME
```
public static val ROOT_DEFAULT_SPACE_ID_NAME : String
```
    Description copied from class: BootConfig
    
    Name of the property that contains the identifier for the default space of the root context.
    
    See Also:
    
    BootConfig.ROOT_DEFAULT_SPACE_ID_VALUE, Constant Field Values
  - ROOT_DEFAULT_SPACE_ID_VALUE
```
public static val ROOT_DEFAULT_SPACE_ID_VALUE : String
```
    Description copied from class: BootConfig
    
    The default value for the root default space identifier.
    
    See Also:
    
    BootConfig.ROOT_DEFAULT_SPACE_ID_NAME, Constant Field Values
  - PROGRAM_NAME_NAME
```
public static val PROGRAM_NAME_NAME : String
```
    Description copied from class: BootConfig
    
    Name of the property that contains the name of the SRE main program from the external point of view.
    
    See Also:
    
    BootConfig.PROGRAM_NAME_VALUE, Constant Field Values
  - PROGRAM_NAME_VALUE
```
public static val PROGRAM_NAME_VALUE : String
```
    Description copied from class: BootConfig
    
    Default value of the property that contains the name of the SRE main program from the external point of view.
    
    See Also:
    
    #PROGRAM_NAME, Constant Field Values
  - ROOT_CONTEXT_BOOT_TYPE_NAME
```
public static val ROOT_CONTEXT_BOOT_TYPE_NAME : String
```
    Description copied from class: BootConfig
    
    Name of the property that contains the type of root context at boot.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getBootAgent
```
@Pure
public def getBootAgent() : String 
```
    Description copied from class: BootConfig
    
    Replies the name of the agent to launch at boot time.
    
    Returns:
    
    the qualified name of the name.
  - setBootAgent
```
public def setBootAgent(name : String) : void 
```
    Description copied from class: BootConfig
    
    Set the name of the agent to launch at boot time.
    
    Parameters:
    
    name - the qualified name of the name.
  - loadBootAgent
```
public def loadBootAgent() : Class<? extends Agent> 
```
    Description copied from class: BootConfig
    
    Replies the type of the agent to launch at boot time.
    
    Returns:
    
    the agent type.
  - getCommandLineArgs
```
@Pure
public def getCommandLineArgs() : String[] 
```
    Description copied from class: BootConfig
    
    Replies the command line arguments that are passed to the program.
    This function replies the arguments passed to the program. The arguments that are passed to an agent when it is started are replied by BootConfig.getAgentStartArgs().
    
    Returns:
    
    the command line arguments.
    
    See Also:
    
    BootConfig.getAgentStartArgs()
  - setCommandLineArgs
```
public def setCommandLineArgs(args : String[]) : void 
```
    Description copied from class: BootConfig
    
    Change the command line arguments that are passed to the program.
    The arguments that are passed to an agent when it is started are replied by BootConfig.getAgentStartArgs() and changed by BootConfig.setAgentStartArgs(String[]).
    
    Parameters:
    
    args - the command line arguments.
    
    See Also:
    
    BootConfig.setAgentStartArgs(String[])
  - getAgentStartArgs
```
@Pure
public def getAgentStartArgs() : String[] 
```
    Description copied from class: BootConfig
    
    Replies the arguments to pass to an agent when it is started.
    This function is a subset of the command line arguments that are replied by BootConfig.getCommandLineArgs().
    
    Returns:
    
    the arguments.
    
    See Also:
    
    BootConfig.getCommandLineArgs()
  - setAgentStartArgs
```
public def setAgentStartArgs(args : String[]) : void 
```
    Description copied from class: BootConfig
    
    Change the arguments to pass to an agent when it is started.
    The agent start arguments constitute a subset of the command line arguments that are replied by BootConfig.getCommandLineArgs(). The arguments that are passed to an agent when it is started are replied by BootConfig.getAgentStartArgs() and changed by BootConfig.setAgentStartArgs(String[]).
    
    Parameters:
    
    args - the command line arguments.
  - getRootContextID
```
@Pure
public def getRootContextID() : UUID 
```
    Description copied from class: BootConfig
    
    Replies the identifier of the root context.
    
    Returns:
    
    the context identifier
  - setRootContextID
```
public def setRootContextID(id : UUID) : void 
```
    Description copied from class: BootConfig
    
    Set the identifier of the root context.
    
    Parameters:
    
    id - the context identifier
  - getRootSpaceID
```
@Pure
public def getRootSpaceID() : UUID 
```
    Description copied from class: BootConfig
    
    Construct an identifier for the root default space.
    
    Returns:
    
    the space ID
  - setRootSpaceID
```
public def setRootSpaceID(id : UUID) : UUID 
```
    Description copied from class: BootConfig
    
    Set the identifier for the root default space.
    
    Parameters:
    
    id - the space ID
  - getProgramName
```
@Pure
public def getProgramName() : String 
```
    Description copied from class: BootConfig
    
    Replies the name of the SRE main program from the external point of view.
    
    Returns:
    
    the name of the program.
  - setProgramName
```
public def setProgramName(name : String) : void 
```
    Description copied from class: BootConfig
    
    Set the name of the SRE main program from the external point of view.
    
    Parameters:
    
    name - the name of the program.
  - getRootContextBootType
```
@Pure
public def getRootContextBootType() : RootContextType 
```
    Description copied from class: BootConfig
    
    Replies the type of id computation for the root context.
    
    Returns:
    
    the type of id computation.
  - setRootContextBootType
```
public def setRootContextBootType(type : RootContextType) : void 
```
    Description copied from class: BootConfig
    
    Set the type of id computation for the root context.
    
    Parameters:
    
    type - the type of id computation.

Class BootConfig

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PREFIX

BOOT_AGENT_NAME

ROOT_CONTEXT_ID_NAME

ROOT_CONTEXT_ID_VALUE

ROOT_DEFAULT_SPACE_ID_NAME

ROOT_DEFAULT_SPACE_ID_VALUE

PROGRAM_NAME_NAME

PROGRAM_NAME_VALUE

ROOT_CONTEXT_BOOT_TYPE_NAME

Method Detail

getBootAgent

setBootAgent

loadBootAgent

getCommandLineArgs

setCommandLineArgs

getAgentStartArgs

setAgentStartArgs

getRootContextID

setRootContextID

getRootSpaceID

setRootSpaceID

getProgramName

setProgramName

getRootContextBootType

setRootContextBootType