org.esigate.extension.parallelesi

Class Esi

java.lang.Object

org.esigate.extension.parallelesi.Esi

All Implemented Interfaces:

IEventListener, Extension

public class Esi
extends Object
implements Extension, IEventListener

This extension processes ESI directives, like :

<esi:include src="$(PROVIDER{cms})/news" fragment="news_1"/>

This extension implements multi-threaded processing, aka Parallel ESI.

It uses the following parameters :

• esi_max_threads : Maximum number of thread allocated to run parallel esi requests. Default is 0 : parallel esi is disabled.
• esi_min_threads : Minimun number of allocated threads.
• esi_max_idle : Release threads after X seconds of idle.
• esi_max_queue : Maximum waiting esi requests (waiting for threads). When the limit is reached, new requests are refused.

Author:

Nicolas Richeton

Field Summary

Fields

Modifier and Type	Field and Description
static String[]	CAPABILITIES
static Parameter<Integer>	IDLE
static Parameter<Integer>	MAX_QUEUE
static Parameter<Integer>	MAX_THREADS
static Parameter<Integer>	MIN_THREADS

Constructor Summary

Constructors

Constructor and Description
Esi()

Method Summary

Modifier and Type	Method and Description
boolean	event(EventDefinition id, Event event) Handle an event.
void	init(Driver driver, Properties properties) Initialize the extension using the given properties.

Methods inherited from class java.lang.Object

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

Field Detail

MAX_THREADS

public static final Parameter<Integer> MAX_THREADS

MIN_THREADS

public static final Parameter<Integer> MIN_THREADS

IDLE

public static final Parameter<Integer> IDLE

MAX_QUEUE

public static final Parameter<Integer> MAX_QUEUE

CAPABILITIES

public static final String[] CAPABILITIES

Constructor Detail

Esi

public Esi()

Method Detail

event

public boolean event(EventDefinition id,
                     Event event)

Description copied from interface: IEventListener

Handle an event.

Specified by:

event in interface IEventListener

Returns:

false to stop the processing of event listeners for this event

init

public void init(Driver driver,
                 Properties properties)

Description copied from interface: Extension

Initialize the extension using the given properties.

Extensions may register to events during the init phase.

Specified by:

init in interface Extension