com.endeca.infront.assembler.event
Interface AssemblerEventListener

All Superinterfaces:

EventListener

All Known Implementing Classes:

AssemblerEventAdapter, CanonicalLinkBuilder, ContentItemAugmentAdapter, LogServerAdapter, RequestEventListener

public interface AssemblerEventListener
extends EventListener

Listener for assembler events. Listeners typically extend class AssemblerEventAdapter

Method Summary

void	assemblyComplete(AssemblerEvent event) An evaluation process has completed.
void	assemblyError(AssemblerEvent event) An assembly has been aborted due to an unrecoverable error.
void	assemblyStarting(AssemblerEvent event) A new assembly is about to start.
void	cartridgeError(AssemblerEvent event) Processing of a cartridge has failed due to a local error.
void	cartridgeInitializeComplete(AssemblerEvent event) A cartridge handler has finished its CartridgeHandler.initialize(ContentItem) method.
void	cartridgeInitializeStarting(AssemblerEvent event) A cartridge handler is about to start its CartridgeHandler.initialize(ContentItem) method.
void	cartridgePreprocessComplete(AssemblerEvent event) A cartridge handler has finished its CartridgeHandler.preprocess(ContentItem) method.
void	cartridgePreprocessStarting(AssemblerEvent event) A cartridge handler is about to start its CartridgeHandler.preprocess(ContentItem) method.
void	cartridgeProcessComplete(AssemblerEvent event) A cartridge handler has finished its CartridgeHandler.process(ContentItem) method.
void	cartridgeProcessStarting(AssemblerEvent event) A cartridge handler is about to start its CartridgeHandler.process(ContentItem) method.

Method Detail

assemblyStarting

void assemblyStarting(AssemblerEvent event)

A new assembly is about to start.

Parameters:

event - an event object that describes the request context and input content item

assemblyComplete

void assemblyComplete(AssemblerEvent event)

An evaluation process has completed.

Parameters:

event - an event object that describes the request context and returned content item

assemblyError

void assemblyError(AssemblerEvent event)

An assembly has been aborted due to an unrecoverable error. An unrecoverable error may occur, for example, if a cartridge handler throws a RuntimeException. On the other hand, if a cartridge handler throws a CartridgeHandlerException, this method will not be called; cartridgeError(AssemblerEvent) will be called instead.

Parameters:

event - an event object that describes the request context, partially assembled item, and error

See Also:

CartridgeHandler.preprocess(ContentItem), CartridgeHandler.process(ContentItem)

cartridgeInitializeStarting

void cartridgeInitializeStarting(AssemblerEvent event)

A cartridge handler is about to start its CartridgeHandler.initialize(ContentItem) method.

Parameters:

event - event object that describes the request context, local content item, and handler

cartridgeInitializeComplete

void cartridgeInitializeComplete(AssemblerEvent event)

A cartridge handler has finished its CartridgeHandler.initialize(ContentItem) method.

Parameters:

event - event object that describes the request context, local content item, and handler

cartridgePreprocessStarting

void cartridgePreprocessStarting(AssemblerEvent event)

A cartridge handler is about to start its CartridgeHandler.preprocess(ContentItem) method.

Parameters:

event - event object that describes the request context, local content item, and handler

cartridgePreprocessComplete

void cartridgePreprocessComplete(AssemblerEvent event)

A cartridge handler has finished its CartridgeHandler.preprocess(ContentItem) method.

Parameters:

event - event object that describes the request context, local content item, and handler

cartridgeProcessStarting

void cartridgeProcessStarting(AssemblerEvent event)

A cartridge handler is about to start its CartridgeHandler.process(ContentItem) method.

Parameters:

event - event object that describes the request context, local content item, and handler

cartridgeProcessComplete

void cartridgeProcessComplete(AssemblerEvent event)

A cartridge handler has finished its CartridgeHandler.process(ContentItem) method.

Parameters:

event - event object that describes the request context, local content item, and handler. Note that the event may contain a null content item if the process method resulted in item removal.

cartridgeError

void cartridgeError(AssemblerEvent event)

Processing of a cartridge has failed due to a local error. A local error occurs when a cartridge handler throws a CartridgeHandlerException. If a cartridge handler throws a RuntimeException, or some other problem occurs during execution, assemblyError(AssemblerEvent) will be called instead.

Parameters:

event - event object that describes the request context, local content item, and handler, if any

See Also:

CartridgeHandler.preprocess(ContentItem), CartridgeHandler.process(ContentItem)