com.endeca.infront.assembler.event

Class AssemblerEventAdapter

java.lang.Object

com.endeca.infront.assembler.event.AssemblerEventAdapter

All Implemented Interfaces:

AssemblerEventListener, EventListener

Direct Known Subclasses:

RequestEventListener

public class AssemblerEventAdapter
extends Object
implements AssemblerEventListener

Contains an empty implementation of each method on the AssemblerEventListener interface. Implementations can extend this class and only override the methods corresponding to the events that they wish to process.

Constructor Summary

Constructors

Constructor and Description
AssemblerEventAdapter()

Method Summary

Methods

Modifier and Type	Method and Description
void	assemblyComplete(AssemblerEvent event) An assembly 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.

Methods inherited from class java.lang.Object

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

Constructor Detail

AssemblerEventAdapter

public AssemblerEventAdapter()

Method Detail

assemblyStarting

public void assemblyStarting(AssemblerEvent event)

Description copied from interface: AssemblerEventListener

A new assembly is about to start.

Specified by:

assemblyStarting in interface AssemblerEventListener

Parameters:

event - an event object that describes activity within the Assembler

assemblyComplete

public void assemblyComplete(AssemblerEvent event)

Description copied from interface: AssemblerEventListener

An assembly process has completed.

Specified by:

assemblyComplete in interface AssemblerEventListener

Parameters:

event - an event object that describes activity within the Assembler

assemblyError

public void assemblyError(AssemblerEvent event)

Description copied from interface: AssemblerEventListener

An assembly has been aborted due to an unrecoverable error. This means that the content item's assembly has stopped and no further listener methods will be invoked. 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; AssemblerEventListener.cartridgeError(AssemblerEvent) will be called instead.

Specified by:

assemblyError in interface AssemblerEventListener

Parameters:

event - an event object that describes activity within the Assembler

See Also:

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

cartridgeInitializeStarting

public void cartridgeInitializeStarting(AssemblerEvent event)

Description copied from interface: AssemblerEventListener

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

Specified by:

cartridgeInitializeStarting in interface AssemblerEventListener

Parameters:

event - an event object that describes activity within the Assembler

cartridgeInitializeComplete

public void cartridgeInitializeComplete(AssemblerEvent event)

Description copied from interface: AssemblerEventListener

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

Specified by:

cartridgeInitializeComplete in interface AssemblerEventListener

Parameters:

event - an event object that describes activity within the Assembler

cartridgePreprocessStarting

public void cartridgePreprocessStarting(AssemblerEvent event)

Description copied from interface: AssemblerEventListener

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

Specified by:

cartridgePreprocessStarting in interface AssemblerEventListener

Parameters:

event - an event object that describes activity within the Assembler

cartridgePreprocessComplete

public void cartridgePreprocessComplete(AssemblerEvent event)

Description copied from interface: AssemblerEventListener

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

Specified by:

cartridgePreprocessComplete in interface AssemblerEventListener

Parameters:

event - an event object that describes activity within the Assembler

cartridgeProcessStarting

public void cartridgeProcessStarting(AssemblerEvent event)

Description copied from interface: AssemblerEventListener

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

Specified by:

cartridgeProcessStarting in interface AssemblerEventListener

Parameters:

event - an event object that describes activity within the Assembler

cartridgeProcessComplete

public void cartridgeProcessComplete(AssemblerEvent event)

Description copied from interface: AssemblerEventListener

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

Specified by:

cartridgeProcessComplete in interface AssemblerEventListener

Parameters:

event - an event object that describes activity within the Assembler Note that the event may contain a null content item if the process method resulted in item removal.

cartridgeError

public void cartridgeError(AssemblerEvent event)

Description copied from interface: AssemblerEventListener

Processing of a cartridge has failed due to a local error. A local error occurs when a cartridge handler throws a CartridgeHandlerException. If this event fires, the content item's assembly will stop and no other events particular to the content item will fire. If a cartridge handler throws a RuntimeException, AssemblerEventListener.assemblyError(AssemblerEvent) will be called instead.

Specified by:

cartridgeError in interface AssemblerEventListener

Parameters:

event - an event object that describes activity within the Assembler

See Also:

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