Package org.objectweb.joram.mom.dest

Class VoidAcquisitionHandler

java.lang.Object

org.objectweb.joram.mom.dest.VoidAcquisitionHandler

All Implemented Interfaces:

AcquisitionHandler

public class VoidAcquisitionHandler
extends Object
implements AcquisitionHandler

An acquisition handler that does nothing and can be used, for instance to configure an alias acquisition destination.

Constructor Summary

Constructors

Constructor	Description
VoidAcquisitionHandler()

Method Summary

Modifier and Type	Method	Description
void	close()	Closes this handler and releases any system resources associated to it.
void	retrieve(ReliableTransmitter transmitter)	Retrieves one or more message from an external source (e-mail, ftp, ...).
void	setProperties(Properties properties)	Configures the handler with the given properties.

Methods inherited from class java.lang.Object

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

Constructor Detail

VoidAcquisitionHandler

public VoidAcquisitionHandler()

Method Detail

retrieve

public void retrieve(ReliableTransmitter transmitter)
              throws Exception

Description copied from interface: AcquisitionHandler

Retrieves one or more message from an external source (e-mail, ftp, ...). Message properties such as priority, expiration or persistence will be set afterwards by the AcquisitionModule.

If the external source is reliable, acknowledgment can be done safely after transmitting the message using the transmitter.

Specified by:

retrieve in interface AcquisitionHandler

Parameters:

transmitter - a transmitter used to transmit retrieved messages to the MOM reliably.

Throws:

Exception

See Also:

AcquisitionHandler.retrieve(ReliableTransmitter)

setProperties

public void setProperties(Properties properties)

Description copied from interface: AcquisitionHandler

Configures the handler with the given properties. This method is called one time before the first call to retrieve and then when the acquisition destination receives a configuration message.

Specified by:

setProperties in interface AcquisitionHandler

Parameters:

properties - The new set of properties.

See Also:

AcquisitionHandler.setProperties(Properties)

close

public void close()

Description copied from interface: AcquisitionHandler

Closes this handler and releases any system resources associated to it. There will be no subsequent call to this handler after it has been closed.

Specified by:

close in interface AcquisitionHandler

See Also:

AcquisitionHandler.close()