Package org.dspace.versioning

Class VersioningConsumer

java.lang.Object

org.dspace.versioning.VersioningConsumer

All Implemented Interfaces:

Consumer

public class VersioningConsumer
extends Object
implements Consumer

Author:

Fabio Bolognesi (fabio at atmire dot com), Mark Diggory (markd at atmire dot com), Ben Bosman (ben at atmire dot com)

Constructor Summary

Constructors

Constructor	Description
VersioningConsumer()

Method Summary

Modifier and Type	Method	Description
void	consume(Context ctx, Event event)	Consume an event; events may get filtered at the dispatcher level, hiding it from the consumer.
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()	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

VersioningConsumer

public VersioningConsumer()

Method Detail

initialize

public void initialize()
                throws Exception

Description copied from interface: Consumer

Initialize - 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

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

consume

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

Description copied from interface: Consumer

Consume an event; events may get filtered at the dispatcher level, hiding it from the consumer. This behavior is based on the dispatcher/consumer configuration. Should include logic to initialize any resources required for a batch of events.

Specified by:

consume in interface Consumer

Parameters:

ctx - the execution context object

event - the 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