io.sarl.bootstrap

Class SRE

java.lang.Object

io.sarl.bootstrap.SRE

public final class SRE
extends Object

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.

For declaring a SRE bootstrap, the library that contains the contributing SRE must declared a specific service implementation of SRE. The declaration of this service must be done by creating a file into the folder META-INF/services/io.sarl.lang.core.SREBootstrap. This file contains a single line that is the fully qualified name of the SRE's implementation.

Since:

0.6

Version:

io.sarl.lang.core 0.12.0 20210527-171007

Author:

Stéphane Galland

See Also:

ServiceLoader

Maven Group Id:

io.sarl.lang

Maven Artifact Id:

io.sarl.lang.core

Method Summary

Modifier and Type	Method and Description
static SREBootstrap	getBootstrap() Find and reply the current SRE.
static Iterable<URL>	getBootstrappedLibraries() Replies all the libraries that contains a SRE bootstrap.
static Iterable<URL>	getServiceLibraries(libraryName : String) Replies all the libraries that contains a Java service for the given service name.
static ServiceLoader<SREBootstrap>	getServiceLoader() Replies all the installed SRE into the class path.
static ServiceLoader<SREBootstrap>	getServiceLoader(onlyInstalledInJRE : boolean) Replies all the installed SRE into the class path.
static void	main(args : String[]) Launch the SRE from a declared bootstrap within the JRE services.
static void	resetServiceLoader() Reset the service loader for the SRE bootstrap.
static void	setBootstrap(sre : SREBootstrap) Change the current SRE.

Methods inherited from class java.lang.Object

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

Method Detail

resetServiceLoader

public static def resetServiceLoader() : void 

Description copied from class: SRE

Reset the service loader for the SRE bootstrap.

getServiceLoader

@Pure
public static def getServiceLoader() : ServiceLoader<SREBootstrap> 

Description copied from class: SRE

Replies all the installed SRE into the class path.

Returns:

the installed SRE.

getServiceLoader

@Pure
public static def getServiceLoader(onlyInstalledInJRE : boolean) : ServiceLoader<SREBootstrap> 

Description copied from class: SRE

Replies all the installed SRE into the class path.

Parameters:

onlyInstalledInJRE - indicates if the services will be considered only into the libraries that are installed into the JRE. If true, only the libraries into the JRE will be considered and the application libraries will be ignored. If false, the application libraries will be considered as well.

Returns:

the installed SRE.

getBootstrappedLibraries

@Pure
public static def getBootstrappedLibraries() : Iterable<URL> 

Description copied from class: SRE

Replies all the libraries that contains a SRE bootstrap.

Returns:

the set of libraries.

Since:

0.7

getServiceLibraries

@Pure
public static def getServiceLibraries(libraryName : String) : Iterable<URL> 

Description copied from class: SRE

Replies all the libraries that contains a Java service for the given service name.

Parameters:

libraryName - the name of the service that is the fully qualified name of the service class.

Returns:

the set of libraries.

Since:

0.12

setBootstrap

public static def setBootstrap(sre : SREBootstrap) : void 

Description copied from class: SRE

Change the current SRE.

Parameters:

sre - the current SRE.

main

public static def main(args : String[]) : void 
                throws Exception

Description copied from class: SRE

Launch the SRE from a declared bootstrap within the JRE services. This execution entry point does not provide advanced interface, e.g. command line options.

Parameters:

args - the command-line arguments. The first argument must be the qualified name of the agent to be launched. The other values are directly given to the launched agent as initialization parameter.

Throws:

Exception - in case of error.

Since:

0.7

getBootstrap

@Pure
public static def getBootstrap() : SREBootstrap 

Description copied from class: SRE

Find and reply the current SRE.

Returns:

the current SRE, never null.

Throws:

IllegalStateException - if a SRE cannot be found.