io.sarl.sre.services.context

Interface ContextService

All Superinterfaces:

com.google.common.util.concurrent.Service

All Known Implementing Classes:

AbstractContextService, AbstractContextService, AbstractContextService, AbstractContextService, AbstractInjectionBasedContextService, AbstractInjectionBasedContextService, AbstractInjectionBasedContextService, HazelcastContextService, MemoryBasedContextService, MemoryBasedContextService

public interface ContextService
extends com.google.common.util.concurrent.Service

This service enables to store the contexts and to manage the spaces in the SRE platform.

Version:

io.janusproject.plugin 0.12.0 20210527-171007

Author:

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

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.
Collection<Context>	getAllContexts() Replies all the known contexts.
Context	getContext(contextID : UUID) Replies an existing context instance.
Context	getRootContext() Replies the root context.
Context	removeContext(contextID : UUID) Remove the context instance.

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

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

Method Detail

getRootContext

@Pure
def getRootContext() : Context 

Description copied from interface: ContextService

Replies the root context.

Returns:

the root context.

createContextWithoutRegistration

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.

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

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.

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
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.

Parameters:

contextID - the id of the context to create

Returns:

the context, null.

removeContext

def removeContext(contextID : UUID) : Context 

Description copied from interface: ContextService

Remove the context instance.

Parameters:

contextID - the id of the context to remove

Returns:

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

getAllContexts

@Pure
def getAllContexts() : Collection<Context> 

Description copied from interface: ContextService

Replies all the known contexts.

Returns:

a view on all the contexts.

Since:

0.10