forklift.consumer.wrapper

Class RoleInputConsumerWrapper

java.lang.Object

forklift.consumer.wrapper.RoleInputConsumerWrapper

All Implemented Interfaces:

ForkliftConsumerI

public class RoleInputConsumerWrapper
extends java.lang.Object
implements ForkliftConsumerI

A consumer that maps the input from a given consumer according to the serialized format for role messages.
This mapping function for role input is a crucial piece that allows RoleInputSources to be backed by any arbitrary source.

Constructor Summary

Constructors

Constructor and Description
RoleInputConsumerWrapper(ForkliftConsumerI consumer) Creates a consumer that delegates message retrieval to the given consumer and maps whatever the consumer outputs based on the assumption that all of the messages returned from the given consumer were serialized as RoleInputMessages.

Method Summary

Modifier and Type	Method and Description
void	close() Closees the underlying consumer.
ForkliftMessage	receive(long timeout) Delegates to the underlying consumer, and tries to extract a role message from any received messages.

Methods inherited from class java.lang.Object

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

Constructor Detail

RoleInputConsumerWrapper

public RoleInputConsumerWrapper(ForkliftConsumerI consumer)

Creates a consumer that delegates message retrieval to the given consumer and maps whatever the consumer outputs based on the assumption that all of the messages returned from the given consumer were serialized as RoleInputMessages.

Parameters:

consumer - the consumer to get unmapped messages from

Method Detail

receive

public ForkliftMessage receive(long timeout)
                        throws ConnectorException

Delegates to the underlying consumer, and tries to extract a role message from any received messages.

Specified by:

receive in interface ForkliftConsumerI

Parameters:

timeout - the timeout of the underlying consumer

Returns:

the

Throws:

ConnectorException - if a connector error occurs in the underlying consumer

close

public void close()
           throws ConnectorException

Closees the underlying consumer.

Specified by:

close in interface ForkliftConsumerI

Throws:

ConnectorException - if a connector error occurs in the underlying consumer