io.sarl.sre.services.context

Class AbstractContextService

java.lang.Object

com.google.common.util.concurrent.AbstractService

io.sarl.sre.services.AbstractSreService

io.sarl.sre.services.context.AbstractContextService

All Implemented Interfaces:

com.google.common.util.concurrent.Service, ContextService

@Singleton
public abstract class AbstractContextService
extends AbstractSreService
implements ContextService

A service managing the root context and enabling the creation of contexts.

This service is thread-safe.

Version:

io.janusproject.plugin 0.12.0 20210527-171007

Author:

Nicolas Gaud, Sebastian Rodriguez, Stéphane Galland

Maven Group Id:

io.janusproject.sre

Maven Artifact Id:

io.janusproject.plugin

Nested Class Summary

Nested classes/interfaces inherited from interface com.google.common.util.concurrent.Service

com.google.common.util.concurrent.Service.Listener, com.google.common.util.concurrent.Service.State

Nested classes/interfaces inherited from interface com.google.common.util.concurrent.Service

com.google.common.util.concurrent.Service.Listener, com.google.common.util.concurrent.Service.State

Field Summary

Fields

Modifier and Type	Field and Description
protected ReadWriteLock	lock The lock resource.
protected Logger	logger The logger for this service.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractContextService(rootContext : Context, logger : LoggingService, factories : javax.inject.Provider<Factories>) Constructor.

Method Summary

Modifier and Type	Method and Description
Context	createContext(contextID : UUID, defaultSpaceID : UUID, owner : Agent) Create a new context instance and register it into the internal repository.
Context	createContextWithoutRegistration(contextID : UUID, defaultSpaceID : UUID, owner : Agent) Create a new context instance and do not register it into the repository.
protected Logger	createLogger(loggingService : LoggingService) Create the instance of the logger for this service.
Context	getContext(contextID : UUID) Replies an existing context instance.
protected abstract Map<UUID,Context>	getContextInternalStructure() Replies the internal data structure for storing the contexts.
Context	getRootContext() Replies the root context.
protected abstract Context	newContextInstance(contextID : UUID, defaultSpaceID : UUID, owner : Agent) Create a context instance.
void	onStart() Do something when starting the service.
void	onStop() Do something when stopping the service.
Context	removeContext(contextID : UUID) Remove the context instance.

Methods inherited from class io.sarl.sre.services.AbstractSreService

doStart, doStop

Methods inherited from class com.google.common.util.concurrent.AbstractService

addListener, awaitRunning, awaitRunning, awaitTerminated, awaitTerminated, doCancelStart, failureCause, isRunning, notifyFailed, notifyStarted, notifyStopped, startAsync, state, stopAsync, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.sarl.sre.services.context.ContextService

getAllContexts

Methods inherited from interface com.google.common.util.concurrent.Service

addListener, awaitRunning, awaitRunning, awaitTerminated, awaitTerminated, failureCause, isRunning, startAsync, state, stopAsync

Field Detail

lock

protected val lock : ReadWriteLock

Description copied from class: AbstractContextService

The lock resource.

logger

protected val logger : Logger

Description copied from class: AbstractContextService

The logger for this service.

Constructor Detail

AbstractContextService

protected new(rootContext : Context,
              logger : LoggingService,
              factories : javax.inject.Provider<Factories>)

Constructor.

Parameters:

rootContext - the root context.

logger - the logging service to be used.

factories - the provider of factories tool.

Method Detail

createLogger

@Pure
protected def createLogger(loggingService : LoggingService) : Logger 

Description copied from class: AbstractContextService

Create the instance of the logger for this service.

Parameters:

loggingService - the logging service.

Returns:

the logger.

Since:

0.12

onStart

public def onStart() : void 

Description copied from class: AbstractSreService

Do something when starting the service.

This function is called from AbstractSreService.doStart()

Overrides:

onStart in class AbstractSreService

onStop

public def onStop() : void 

Description copied from class: AbstractSreService

Do something when stopping the service.

This function is called from AbstractSreService.doStop()

Overrides:

onStop in class AbstractSreService

getContextInternalStructure

@Pure
protected abstract def getContextInternalStructure() : Map<UUID,Context> 

Description copied from class: AbstractContextService

Replies the internal data structure for storing the contexts.

This function is not thread-safe.

createContextWithoutRegistration

public final def createContextWithoutRegistration(contextID : UUID,
                                                  defaultSpaceID : UUID,
                                                  owner : Agent) : Context 

Description copied from interface: ContextService

Create a new context instance and do not register it into the repository.

Specified by:

createContextWithoutRegistration in interface ContextService

Parameters:

contextID - the id of the context to create.

defaultSpaceID - the id of the default space of the context to create.

owner - is the owner of the context. If null, the context is the root context.

Returns:

the context.

createContext

public final def createContext(contextID : UUID,
                               defaultSpaceID : UUID,
                               owner : Agent) : Context 

Description copied from interface: ContextService

Create a new context instance and register it into the internal repository.

Specified by:

createContext in interface ContextService

Parameters:

contextID - the id of the context to create.

defaultSpaceID - the id of the default space of the context to create.

owner - is the owner of the context. If null, the context is the root context.

Returns:

the context.

getContext

@Pure
public def getContext(contextID : UUID) : Context 

Description copied from interface: ContextService

Replies an existing context instance. This function does not create the instance of the context if it was not created.

Specified by:

getContext in interface ContextService

Parameters:

contextID - the id of the context to create

Returns:

the context, null.

removeContext

public def removeContext(contextID : UUID) : Context 

Description copied from interface: ContextService

Remove the context instance.

Specified by:

removeContext in interface ContextService

Parameters:

contextID - the id of the context to remove

Returns:

the removed context, null if no context with the given ID was found.

newContextInstance

protected abstract def newContextInstance(contextID : UUID,
                                          defaultSpaceID : UUID,
                                          owner : Agent) : Context 

Description copied from class: AbstractContextService

Create a context instance.

This function is not thread-safe.

Parameters:

contextID - the identifier of the context.

defaultSpaceId - the identifier of the default space in the context.

owner - is the owner of the context. If null, the context is the root context

getRootContext

@Pure
public def getRootContext() : Context 

Description copied from interface: ContextService

Replies the root context.

Specified by:

getRootContext in interface ContextService

Returns:

the root context.