abs.ixi.client.core

Class ResponseCorrelator

java.lang.Object

abs.ixi.client.core.ResponseCorrelator

All Implemented Interfaces:

PacketCollector

public final class ResponseCorrelator
extends Object
implements PacketCollector

Stringflow programming model is not synchronous in nature; It allows to pipeline requests on same connection without waiting for response. While this feature is called 'Request Pipelining', it complicates response correlation in application layer. ResponseCorrelator comes to the rescue here and correlates response to the requests for applications.

When a request is sent to the server, the request carries an id and server response will also contain the same id which ResponseCorrelator uses to correlate the response to the request.

Constructor Summary

Constructors

Constructor and Description
ResponseCorrelator()

Method Summary

Modifier and Type	Method and Description
void	collect(Packet packet) This collector takes the given packet.
void	correlate(String id) Correlates given request id with a response
Packet	getCorrelatedResponse(String id) Returns IQ packet received as the response of the request sent to server with given id.
String	getCorrelationId() Generates a request id which is added response awaiting requests list

Methods inherited from class java.lang.Object

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

Constructor Detail

ResponseCorrelator

public ResponseCorrelator()

Method Detail

correlate

public void correlate(String id)

Correlates given request id with a response

Parameters:

id - correlationid

getCorrelationId

public String getCorrelationId()

Generates a request id which is added response awaiting requests list

Returns:

String string

getCorrelatedResponse

public Packet getCorrelatedResponse(String id)
                             throws TimeoutException

Returns IQ packet received as the response of the request sent to server with given id. If server fails to respond within the time specified by timeout property, TimeoutException is thrown.

Parameters:

id - corelation id

Returns:

Packet Packet

Throws:

TimeoutException - timeout

collect

public void collect(Packet packet)

Description copied from interface: PacketCollector

This collector takes the given packet. The collector may employ further filtering and may decide to ignore/drop this packet.

Specified by:

collect in interface PacketCollector

Parameters:

packet - packet instance to be collected