io.sarl.sre.janus.boot.configs.subconfigs
Class BootConfig
class BootConfig
extends java.lang.Object
Configuration for specifying the SRE booting parameters.
Maven Group Identifier:
io.sarl.sre.janus
Maven Artifact Identifier:
janus.kernel
Since:
0.8.0
Property Summary
Modifier and type Property and description
java.lang.String agentStartArgs
Replies the arguments to pass to an agent when it is started.
java.lang.String bootAgent
Replies the name of the agent to launch at boot time.
java.lang.String commandLineArgs
Replies the command line arguments that are passed to the program.
java.lang.String programName
Replies the name of the SRE main program from the external point of view.
RootContextType rootContextBootType
Replies the type of id computation for the root context.
java.util.UUID rootContextID
Replies the identifier of the root context.
java.util.UUID rootSpaceID
Construct an identifier for the root default space.
Field Summary
Modifier and type Field and description
public static val java.lang.String BOOT_AGENT_NAME
Name of the property that contains the agent to boot.
public static val java.lang.String PREFIX
Prefix for the configuration entries of the boot modules.
public static val java.lang.String PROGRAM_NAME_NAME
Name of the property that contains the name of the SRE main program from the external point of view.
public static val java.lang.String PROGRAM_NAME_VALUE
Default value of the property that contains the name of the SRE main program from the external point of view.
public static val java.lang.String ROOT_CONTEXT_BOOT_TYPE_NAME
Name of the property that contains the type of root context at boot.
public static val java.lang.String ROOT_CONTEXT_ID_NAME
Name of the property that contains the identifier of the root context.
public static val java.lang.String ROOT_CONTEXT_ID_VALUE
The default value for the root context identifier.
public static val java.lang.String ROOT_DEFAULT_SPACE_ID_NAME
Name of the property that contains the identifier for the default space of the root context.
public static val java.lang.String ROOT_DEFAULT_SPACE_ID_VALUE
The default value for the root default space identifier.
Action Summary
Modifier and type Action and description
java.lang.String getAgentStartArgs
Replies the arguments to pass to an agent when it is started.
java.lang.String getBootAgent
Replies the name of the agent to launch at boot time.
java.lang.String getCommandLineArgs
Replies the command line arguments that are passed to the program.
java.lang.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.
java.util.UUID getRootContextID
Replies the identifier of the root context.
java.util.UUID getRootSpaceID
Construct an identifier for the root default space.
java.lang.Class<T> loadBootAgent
Replies the type of the agent to launch at boot time.
void setAgentStartArgs(String)
Change the arguments to pass to an agent when it is started.
void setBootAgent(String)
Set the name of the agent to launch at boot time.
void setCommandLineArgs(String)
Change the command line arguments that are passed to the program.
void setProgramName(String)
Set the name of the SRE main program from the external point of view.
void setRootContextBootType(RootContextType)
Set the type of id computation for the root context.
void setRootContextID(UUID)
Set the identifier of the root context.
java.util.UUID setRootSpaceID(UUID)
Set the identifier for the root default space.
Property Details
agentStartArgs 
var agentStartArgs : java.lang.String
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 getCommandLineArgs().

This property is an alias for the action: getAgentStartArgs

Returns:
the arguments.
See:
getCommandLineArgs
bootAgent 
var bootAgent : java.lang.String
Replies the name of the agent to launch at boot time.

This property is an alias for the action: getBootAgent

Returns:
the qualified name of the name.
commandLineArgs 
var commandLineArgs : java.lang.String
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 getAgentStartArgs().

This property is an alias for the action: getCommandLineArgs

Returns:
the command line arguments.
See:
getAgentStartArgs
programName 
var programName : java.lang.String
Replies the name of the SRE main program from the external point of view.

This property is an alias for the action: getProgramName

Returns:
the name of the program.
rootContextBootType 
var rootContextBootType : RootContextType
Replies the type of id computation for the root context.

This property is an alias for the action: getRootContextBootType

Returns:
the type of id computation.
rootContextID 
var rootContextID : java.util.UUID
Replies the identifier of the root context.

This property is an alias for the action: getRootContextID

Returns:
the context identifier
rootSpaceID 
val rootSpaceID : java.util.UUID
Construct an identifier for the root default space.

This property is an alias for the action: getRootSpaceID

Returns:
the space ID
Field Details
BOOT_AGENT_NAME 
public static val BOOT_AGENT_NAME : java.lang.String = "sre.boot.bootAgent"
Name of the property that contains the agent to boot.
PREFIX 
public static val PREFIX : java.lang.String = "sre.boot"
Prefix for the configuration entries of the boot modules.
PROGRAM_NAME_NAME 
public static val PROGRAM_NAME_NAME : java.lang.String = "sre.boot.programName"
Name of the property that contains the name of the SRE main program from the external point of view.
See:
PROGRAM_NAME_VALUE
PROGRAM_NAME_VALUE 
public static val PROGRAM_NAME_VALUE : java.lang.String = "SARL Run-time Environment"
Default value of the property that contains the name of the SRE main program from the external point of view.
See:
PROGRAM_NAME_NAME
ROOT_CONTEXT_BOOT_TYPE_NAME 
public static val ROOT_CONTEXT_BOOT_TYPE_NAME : java.lang.String = "sre.boot.rootContextBootType"
Name of the property that contains the type of root context at boot.
ROOT_CONTEXT_ID_NAME 
public static val ROOT_CONTEXT_ID_NAME : java.lang.String = "sre.boot.rootContextId"
Name of the property that contains the identifier of the root context.
See:
ROOT_CONTEXT_ID_VALUE
ROOT_CONTEXT_ID_VALUE 
public static val ROOT_CONTEXT_ID_VALUE : java.lang.String = "2c38fb7f-f363-4f6e-877b-110b1f07cc77"
The default value for the root context identifier.
See:
ROOT_CONTEXT_ID_NAME
ROOT_DEFAULT_SPACE_ID_NAME 
public static val ROOT_DEFAULT_SPACE_ID_NAME : java.lang.String = "sre.boot.rootSpaceId"
Name of the property that contains the identifier for the default space of the root context.
See:
ROOT_DEFAULT_SPACE_ID_VALUE
ROOT_DEFAULT_SPACE_ID_VALUE 
public static val ROOT_DEFAULT_SPACE_ID_VALUE : java.lang.String = "7ba8885d-545b-445a-a0e9-b655bc15ebe0"
The default value for the root default space identifier.
See:
ROOT_DEFAULT_SPACE_ID_NAME
Action Details
getAgentStartArgs 
def getAgentStartArgs : java.lang.String
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 getCommandLineArgs().
Returns:
the arguments.
See:
getCommandLineArgs
getBootAgent 
def getBootAgent : java.lang.String
Replies the name of the agent to launch at boot time.
Returns:
the qualified name of the name.
getCommandLineArgs 
def getCommandLineArgs : java.lang.String
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 getAgentStartArgs().
Returns:
the command line arguments.
See:
getAgentStartArgs
getProgramName 
def getProgramName : java.lang.String
Replies the name of the SRE main program from the external point of view.
Returns:
the name of the program.
getRootContextBootType 
def getRootContextBootType : RootContextType
Replies the type of id computation for the root context.
Returns:
the type of id computation.
getRootContextID 
def getRootContextID : java.util.UUID
Replies the identifier of the root context.
Returns:
the context identifier
getRootSpaceID 
def getRootSpaceID : java.util.UUID
Construct an identifier for the root default space.
Returns:
the space ID
loadBootAgent 
def loadBootAgent : java.lang.Class<T>
Replies the type of the agent to launch at boot time.
Returns:
the agent type.
setAgentStartArgs(String) 
def setAgentStartArgs(String)
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 getCommandLineArgs(). The arguments that are passed to an agent when it is started are replied by getAgentStartArgs() and changed by setAgentStartArgs(String[]).
Parameters:
args - the command line arguments.
setBootAgent(String) 
def setBootAgent(String)
Set the name of the agent to launch at boot time.
Parameters:
name - the qualified name of the name.
setCommandLineArgs(String) 
def setCommandLineArgs(String)
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 getAgentStartArgs() and changed by setAgentStartArgs(String[]).
Parameters:
args - the command line arguments.
See:
setAgentStartArgs(String)
setProgramName(String) 
def setProgramName(String)
Set the name of the SRE main program from the external point of view.
Parameters:
name - the name of the program.
setRootContextBootType(RootContextType) 
def setRootContextBootType(RootContextType)
Set the type of id computation for the root context.
Parameters:
type - the type of id computation.
setRootContextID(UUID) 
def setRootContextID(UUID)
Set the identifier of the root context.
Parameters:
id - the context identifier
setRootSpaceID(UUID) 
def setRootSpaceID(UUID) : java.util.UUID
Set the identifier for the root default space.
Parameters:
id - the space ID