Package org.dspace.event

Class TestConsumer

java.lang.Object

org.dspace.event.TestConsumer

All Implemented Interfaces:

Consumer

public class TestConsumer
extends Object
implements Consumer

Demonstration and test consumer for the event system. This consumer only makes an entry in the log, and on an output stream, for each event it receives. It also logs when consume() and end() get called. It is intended for testing, exploring, and debugging the event system.

Version:

$Revision$

Constructor Summary

Constructors

Constructor	Description
TestConsumer()

Method Summary

Modifier and Type	Method	Description
void	consume(Context ctx, Event event)	Consume a content event - display it in detail.
void	end(Context ctx)	Signal that there are no more events queued in this event stream and event processing for the preceding consume calls should be finished up.
void	finish(Context ctx)	Finish - free any allocated resources.
void	initialize()	Allocate any resources required to operate.

Methods inherited from class java.lang.Object

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

Constructor Detail

TestConsumer

public TestConsumer()

Method Detail

initialize

public void initialize()
                throws Exception

Description copied from interface: Consumer

Allocate any resources required to operate. This may include initializing any pooled JMS resources. Called ONCE when created by the dispatcher pool. This should be used to set up expensive resources that will remain for the lifetime of the consumer.

Specified by:

initialize in interface Consumer

Throws:

Exception - if error

consume

public void consume(Context ctx,
                    Event event)
             throws Exception

Consume a content event - display it in detail.

Specified by:

consume in interface Consumer

Parameters:

ctx - DSpace context

event - Content event

Throws:

Exception - if error

end

public void end(Context ctx)
         throws Exception

Description copied from interface: Consumer

Signal that there are no more events queued in this event stream and event processing for the preceding consume calls should be finished up.

Specified by:

end in interface Consumer

Parameters:

ctx - the execution context object

Throws:

Exception - if error

finish

public void finish(Context ctx)
            throws Exception

Description copied from interface: Consumer

Finish - free any allocated resources. Called when consumer (via it's parent dispatcher) is going to be destroyed by the dispatcher pool.

Specified by:

finish in interface Consumer

Parameters:

ctx - the execution context object

Throws:

Exception - if error