io.sarl.sre.services.probing

Class AbstractProbeService

java.lang.Object

com.google.common.util.concurrent.AbstractService

io.sarl.sre.services.AbstractSreService

io.sarl.sre.services.probing.AbstractProbeService

All Implemented Interfaces:

com.google.common.util.concurrent.Service, IProbeReleaseListener, ProbeService, EventListener

public abstract class AbstractProbeService
extends AbstractSreService
implements ProbeService, IProbeReleaseListener

This class is the standard implementation of a probe service.

Since:

0.10

Version:

0.12.0-SNAPSHOT 2020-06-30 17:45:08

Author:

Stéphane Galland

Maven Group Id:

io.janusproject

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractProbeService(internalStructure : Map<URI,Probe<?>>, namespaceService : NamespaceService, nameParser : NameParser, listenerCollectionProvider : javax.inject.Provider<SmartListenerCollection<?>>) Constructor.

Method Summary

Modifier and Type	Method and Description
Collection<Probe<?>>	getProbes() Replies all the probes.
protected <T> Probe<T>	newProbe(probedElement : Object, valueType : Class<T>, probeUri : URI, probeName : String) Create an instance of the probe.
protected void	onFirstProbe() Invoked when the first probe is added into the service.
protected void	onLastProbe() Invoked when the last probe is removed from the service.
void	onProbeReleasedProbe(probe : Probe<?>) Invoked when a probe was released.
protected void	onStop() Do something when stopping the service.
<T> Probe<T>	probe(valueName : SarlName, valueType : Class<T>, [probeName : String]) Create a probe.
<T> Probe<T>	probe(valueName : String, valueType : Class<T>, [probeName : String]) Create a probe.
<T> Probe<T>	probe(valueName : URI, valueType : Class<T>, [probeName : String]) Create a probe.
void	releaseAllProbes() Release all the probes.
void	sync() Force the synchronization of the probes.

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

doStart, doStop, onStart

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 com.google.common.util.concurrent.Service

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

Constructor Detail

AbstractProbeService

protected new(internalStructure : Map<URI,Probe<?>>,
              namespaceService : NamespaceService,
              nameParser : NameParser,
              listenerCollectionProvider : javax.inject.Provider<SmartListenerCollection<?>>)

Constructor.

Parameters:

internalStructure - is the internal structure for storing the probes.

namespaceService - the service that is giving access to the namespaces.

nameParser - the object that is able to parse resource names.

listenerCollectionProvider - the provider of listener collections.

lockProvider - the provider of synchronization locks.

Method Detail

onStop

protected 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

probe

public def probe(valueName : String,
                 valueType : Class<T>,
                 [probeName : String]) : Probe<T>  with <T> 

Description copied from interface: ProbeService

Create a probe.

If a probe with the same name name exists, a composed probe with the probe name is created with the probes as composite.

Specified by:

probe in interface ProbeService

Parameters:

valueName - the probed element.

valueType - the expected type of the value.

probeName - is the optional name of the probe.

probe

public def probe(valueName : URI,
                 valueType : Class<T>,
                 [probeName : String]) : Probe<T>  with <T> 

Description copied from interface: ProbeService

Create a probe.

If a probe with the same name name exists, a composed probe with the probe name is created with the probes as composite.

Specified by:

probe in interface ProbeService

Parameters:

valueName - the probed element.

valueType - the expected type of the value.

probeName - is the optional name of the probe.

probe

public def probe(valueName : SarlName,
                 valueType : Class<T>,
                 [probeName : String]) : Probe<T>  with <T> 

Description copied from interface: ProbeService

Create a probe.

If a probe with the same name name exists, a composed probe with the probe name is created with the probes as composite.

Specified by:

probe in interface ProbeService

Parameters:

valueName - the probed element.

valueType - the expected type of the value.

probeName - is the optional name of the probe.

onFirstProbe

protected def onFirstProbe() : void 

Description copied from class: AbstractProbeService

Invoked when the first probe is added into the service.

onLastProbe

protected def onLastProbe() : void 

Description copied from class: AbstractProbeService

Invoked when the last probe is removed from the service.

newProbe

@Pure
protected def newProbe(probedElement : Object,
                             valueType : Class<T>,
                             probeUri : URI,
                             probeName : String) : Probe<T>  with <T> 

Description copied from class: AbstractProbeService

Create an instance of the probe.

Type Parameters:

T - the expected type of the probed values.

Parameters:

probedElement - the element to which the probe must be associated, never null.

valueType - the expected type of the probed values, never null.

probeUri - the URI of the probe, never null.

probeName - the name of the probe, never null.

getProbes

@Pure
public def getProbes() : Collection<Probe<?>> 

Description copied from interface: ProbeService

Replies all the probes.

Specified by:

getProbes in interface ProbeService

Returns:

the iterable on probes

releaseAllProbes

public def releaseAllProbes() : void 

Description copied from interface: ProbeService

Release all the probes.

Specified by:

releaseAllProbes in interface ProbeService

sync

public def sync() : void 

Description copied from interface: ProbeService

Force the synchronization of the probes.

Specified by:

sync in interface ProbeService

onProbeReleasedProbe

public def onProbeReleasedProbe(probe : Probe<?>) : void 

Description copied from interface: IProbeReleaseListener

Invoked when a probe was released.

Specified by:

onProbeReleasedProbe in interface IProbeReleaseListener

Parameters:

probe - is the released probe.