org.apache.synapse.core.axis2

Class SynapseCallbackReceiver

java.lang.Object

org.apache.synapse.core.axis2.SynapseCallbackReceiver

All Implemented Interfaces:

org.apache.axis2.engine.MessageReceiver

public class SynapseCallbackReceiver
extends Object
implements org.apache.axis2.engine.MessageReceiver

This is the message receiver that receives the responses for outgoing messages sent out by Synapse. It holds a callbackStore that maps the [unique] messageID of each message to a callback object that gets executed on timeout or when a response is received (before timeout) The AnonymousServiceFactory uses this MessageReceiver for all Anonymous services created by it. This however - effectively - is a singleton class

Method Summary

Modifier and Type	Method and Description
void	addCallback(String MsgID, org.apache.axis2.client.async.AxisCallback callback)
void	destroy() Destroy and cleanup this callback receiver instance
int	getCallbackCount()
static SynapseCallbackReceiver	getInstance() Get the singleton SynapseCallbackReceiver instance
String[]	getPendingCallbacks()
void	init(SynapseConfiguration synCfg, ServerContextInformation contextInformation) Initialize the singleton instance of this class that would be used by all anonymous services used for outgoing messaging.
void	receive(org.apache.axis2.context.MessageContext messageCtx) Every time a response message is received this method gets invoked.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static SynapseCallbackReceiver getInstance()

Get the singleton SynapseCallbackReceiver instance

Returns:

A SynapseCallbackReceiver

init

public void init(SynapseConfiguration synCfg,
                 ServerContextInformation contextInformation)

Initialize the singleton instance of this class that would be used by all anonymous services used for outgoing messaging.

Parameters:

synCfg - the Synapse configuration

contextInformation - server runtime information

destroy

public void destroy()

Destroy and cleanup this callback receiver instance

getCallbackCount

public int getCallbackCount()

getPendingCallbacks

public String[] getPendingCallbacks()

addCallback

public void addCallback(String MsgID,
                        org.apache.axis2.client.async.AxisCallback callback)

receive

public void receive(org.apache.axis2.context.MessageContext messageCtx)
             throws org.apache.axis2.AxisFault

Every time a response message is received this method gets invoked. It will then select the outgoing *Synapse* message context for the reply we received, and determine what action to take at the Synapse level

Specified by:

receive in interface org.apache.axis2.engine.MessageReceiver

Parameters:

messageCtx - the Axis2 message context of the reply received

Throws:

org.apache.axis2.AxisFault