com.ibm.jaggr.core.layer

Interface ILayerListener

All Known Implementing Classes:

AggregatorLayerListener, I18nModuleBuilder, JavaScriptModuleBuilder

public interface ILayerListener

Listener interface for Layer events. To receive notification of layer events, register an instance of the implementing class as an OSGi service. The listener registration should specify a filter using the name property with the value obtained by calling IAggregator.getName().

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ILayerListener.EventType

Method Summary

Methods

Modifier and Type	Method and Description
String	layerBeginEndNotifier(ILayerListener.EventType type, javax.servlet.http.HttpServletRequest request, List<IModule> modules, Set<String> dependentFeatures) Listener notification callback that is called for the event specified by type.

Method Detail

layerBeginEndNotifier

String layerBeginEndNotifier(ILayerListener.EventType type,
                           javax.servlet.http.HttpServletRequest request,
                           List<IModule> modules,
                           Set<String> dependentFeatures)

Listener notification callback that is called for the event specified by type. If the returned string is not null, then the value will be added to the response stream either before, or after, the layer content, depending on the event type.

Parameters:

type - Indicates whether a layer is starting or finishing.

request - The HTTP request object.

modules - The list of modules in the layer. Note that modules added to the layer by module builders using the ModuleBuild.addExtraModule(String) in the list. For the BEGIN_MODULE event, the list contains only the single module that is being added to the layer.

dependentFeatures - Output - If the returned value depends on any features specified in the request, then those features should be added to dependentFeatures. These will be included in the construction of the cache key for the layer.

Returns:

The string to be added to the response, or null.