Package com.inductiveautomation.ignition.gateway.services

Interface ModuleServicesManager

public interface ModuleServicesManager

The ModuleServicesManager is responsible for managing the lifecycle of ModuleServices and ModuleServiceConsumers.

ModuleServices are services provided by modules that can be requested by other modules. A ModuleService is registered with the ModuleServicesManager and can be requested by a ModuleServiceConsumer by its Class.

ModuleServiceConsumers are interested in using a ModuleService and can subscribe to be notified when the service is ready for use.

Method Summary

Modifier and Type	Method	Description
<T extends ModuleService> T	getService(Class<T> serviceClass)	Retrieves a ModuleService indicated by the given serviceClass.
void	notifyServiceReady(ModuleService service)	To be called by a ModuleService after it is first ready for use.
void	notifyServiceShutdown(ModuleService service)	To be called by a ModuleService when it is longer ready for use.
void	registerService(Class<? extends ModuleService> serviceClass, ModuleService service)	Registers a ModuleService for use.
void	subscribe(Class<? extends ModuleService> serviceClass, ModuleServiceConsumer consumer)	Indicate that the given ModuleServiceConsumer is interested in using the ModuleService indicated by serviceClass.
void	unregisterService(Class<? extends ModuleService> serviceClass)	Unregisters a ModuleService with the given serviceClass.
void	unsubscribe(Class<? extends ModuleService> serviceClass, ModuleServiceConsumer consumer)	Indicate that the given ModuleServiceConsumer is no longer interested in the ModuleService indicated by serviceClass.

Method Details

registerService

void registerService(Class<? extends ModuleService> serviceClass,
 ModuleService service)

Registers a ModuleService for use.

Parameters:

serviceClass - the Class ModuleServiceConsumers will request this service by.

service - the ModuleService provided.

unregisterService

void unregisterService(Class<? extends ModuleService> serviceClass)

Unregisters a ModuleService with the given serviceClass.

Parameters:

serviceClass - the ModuleService Class to unregister.

getService

<T extends ModuleService> T getService(Class<T> serviceClass)

Retrieves a ModuleService indicated by the given serviceClass. A ModuleService should not be retrieved by a ModuleServiceConsumer until it has been notified of its availability.

Parameters:

serviceClass - the Class linked to the desired ModuleService.

Returns:

the ModuleService indicated by serviceClass.

subscribe

void subscribe(Class<? extends ModuleService> serviceClass,
 ModuleServiceConsumer consumer)

Indicate that the given ModuleServiceConsumer is interested in using the ModuleService indicated by serviceClass.

The ModuleServiceConsumer will be notified when the ModuleService is ready for use.

Parameters:

serviceClass - the Class used to indicate the ModuleService.

consumer - the ModuleServiceConsumer interested in the ModuleService.

unsubscribe

void unsubscribe(Class<? extends ModuleService> serviceClass,
 ModuleServiceConsumer consumer)

Indicate that the given ModuleServiceConsumer is no longer interested in the ModuleService indicated by serviceClass.

Parameters:

serviceClass - the Class used to indicate the ModuleService.

consumer - ModuleServiceConsumer to unsubscribe.

notifyServiceReady

void notifyServiceReady(ModuleService service)

To be called by a ModuleService after it is first ready for use.

All ModuleServiceConsumers that subscribed prior to this call will be notified that the service is ready.

Parameters:

service - the ModuleService that is ready.

notifyServiceShutdown

void notifyServiceShutdown(ModuleService service)

To be called by a ModuleService when it is longer ready for use.

All subscribed ModuleServiceConsumers will be notified of the shutdown.

Parameters:

service - the ModuleService that is no longer ready for use.