org.jboss.gravia.runtime

Interface ModuleActivator

public interface ModuleActivator

Customizes the starting and stopping of a module.

ModuleActivator is an interface that may be implemented when a module is started or stopped. The Runtime can create instances of a module's ModuleActivator as required. If an instance's ModuleActivator.start method executes successfully, it is guaranteed that the same instance's ModuleActivator.stop method will be called when the module is to be stopped. The Runtime must not concurrently call a ModuleActivator object.

ModuleActivator is specified through the Module-Activator module header.

The specified ModuleActivator class must have a public constructor that takes no parameters so that a ModuleActivator object can be created by Class.newInstance().

Since:

27-Sep-2013

Author:

thomas.diesler@jboss.com

Thread Safety: Not Thread Safe

Method Summary

Methods

Modifier and Type	Method and Description
void	start(ModuleContext context) Called when this module is started so the Runtime can perform the module-specific activities necessary to start this module.
void	stop(ModuleContext context) Called when this module is stopped so the Runtime can perform the module-specific activities necessary to stop the module.

Method Detail

start

void start(ModuleContext context)
           throws Exception

Called when this module is started so the Runtime can perform the module-specific activities necessary to start this module. This method can be used to register services or to allocate any resources that this module needs.

This method must complete and return to its caller in a timely manner.

Parameters:

context - The execution context of the module being started.

Throws:

Exception - If this method throws an exception, this module is marked as stopped and the Runtime will remove this module's listeners, unregister all services registered by this module, and release all services used by this module.

stop

void stop(ModuleContext context)
          throws Exception

Called when this module is stopped so the Runtime can perform the module-specific activities necessary to stop the module. In general, this method should undo the work that the ModuleActivator.start method started. There should be no active threads that were started by this module when this module returns. A stopped module must not call any Runtime objects.

This method must complete and return to its caller in a timely manner.

Parameters:

context - The execution context of the module being stopped.

Throws:

Exception - If this method throws an exception, the module is still marked as stopped, and the Runtime will remove the module's listeners, unregister all services registered by the module, and release all services used by the module.