io.sarl.sre.boot.configs.subconfigs

Class BootConfigModule

java.lang.Object

com.google.inject.AbstractModule

io.sarl.sre.boot.configs.subconfigs.BootConfigModule

All Implemented Interfaces:

com.google.inject.Module

public class BootConfigModule
extends com.google.inject.AbstractModule

Module for the SRE booting parameters.

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
static String	BOOT_TYPE_OPTION
static String	DEFAULT_SPACE_ID_OPTION
static String	NAME_OPTION
static String	ROOT_CONTEXT_ID_OPTION

Method Summary

Modifier and Type	Method and Description
void	configure()
Class<? extends Agent>	getBootAgentType(config : javax.inject.Provider<SreConfig>) Replies the type's name of the agent to boot.
static SREBootstrap	getProgrammaticBootstrap() Replies the programmatic bootstrap for the SRE.
UUID	getRootContextID(config : javax.inject.Provider<SreConfig>) Replies the identifier of the root context.
UUID	getRootSpaceID(config : javax.inject.Provider<SreConfig>) Construct an identifier for the root default space.

Methods inherited from class com.google.inject.AbstractModule

addError, addError, addError, bind, bind, bind, bindConstant, binder, bindListener, bindListener, bindScope, configure, convertToTypes, currentStage, getMembersInjector, getMembersInjector, getProvider, getProvider, install, requestInjection, requestStaticInjection, requireBinding, requireBinding

Methods inherited from class java.lang.Object

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

Field Detail

ROOT_CONTEXT_ID_OPTION

public static val ROOT_CONTEXT_ID_OPTION : String

See Also:

Constant Field Values

DEFAULT_SPACE_ID_OPTION

public static val DEFAULT_SPACE_ID_OPTION : String

See Also:

Constant Field Values

NAME_OPTION

public static val NAME_OPTION : String

See Also:

Constant Field Values

BOOT_TYPE_OPTION

public static val BOOT_TYPE_OPTION : String

See Also:

Constant Field Values

Method Detail

configure

public def configure() : void 

Overrides:

configure in class com.google.inject.AbstractModule

getBootAgentType

@Provides
 @Named(value="sre.boot.bootAgent")
 @Pure
public def getBootAgentType(config : javax.inject.Provider<SreConfig>) : Class<? extends Agent> 

Description copied from class: BootConfigModule

Replies the type's name of the agent to boot.

Parameters:

configFactory - accessor to the bootique factory.

Returns:

the name of the agent to boot.

getProgrammaticBootstrap

@Provides
 @Singleton
 @Pure
public static def getProgrammaticBootstrap() : SREBootstrap 

Description copied from class: BootConfigModule

Replies the programmatic bootstrap for the SRE.

Returns:

the provider of the bootstrap.

getRootContextID

@Provides
 @Named(value="sre.boot.rootContextId")
 @Singleton
 @Pure
public def getRootContextID(config : javax.inject.Provider<SreConfig>) : UUID 

Description copied from class: BootConfigModule

Replies the identifier of the root context.

Parameters:

config - accessor to the bootique factory.

Returns:

the context identifier

getRootSpaceID

@Provides
 @Named(value="sre.boot.rootSpaceId")
 @Singleton
 @Pure
public def getRootSpaceID(config : javax.inject.Provider<SreConfig>) : UUID 

Description copied from class: BootConfigModule

Construct an identifier for the root default space.

Parameters:

configFactory - accessor to the bootique factory.

Returns:

the space ID