com.ibm.jaggr.core.impl

Class AggregatorLayerListener

java.lang.Object

com.ibm.jaggr.core.impl.AggregatorLayerListener

All Implemented Interfaces:

ILayerListener

public class AggregatorLayerListener
extends Object
implements ILayerListener

Nested Class Summary

Nested classes/interfaces inherited from interface com.ibm.jaggr.core.layer.ILayerListener

ILayerListener.EventType

Field Summary

Fields

Modifier and Type	Field and Description
static String	PREAMBLEFMT

Constructor Summary

Constructors

Constructor and Description
AggregatorLayerListener(IAggregator aggregator)

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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PREAMBLEFMT

public static final String PREAMBLEFMT

See Also:

Constant Field Values

Constructor Detail

AggregatorLayerListener

public AggregatorLayerListener(IAggregator aggregator)

Method Detail

layerBeginEndNotifier

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

Description copied from interface: ILayerListener

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.

Specified by:

layerBeginEndNotifier in interface ILayerListener

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.