modules/kernel/src/org/apache/axis2/util/CallbackReceiver.java

/*
* Copyright 2004,2005 The Apache Software Foundation.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*      http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

package org.apache.axis2.util;

import org.apache.axiom.soap.SOAPEnvelope;
import org.apache.axiom.soap.SOAPFault;
import org.apache.axis2.AxisFault;
import org.apache.axis2.addressing.RelatesTo;
import org.apache.axis2.addressing.AddressingConstants;
import org.apache.axis2.client.async.AsyncResult;
import org.apache.axis2.client.async.Callback;
import org.apache.axis2.context.MessageContext;
import org.apache.axis2.engine.MessageReceiver;

import java.util.HashMap;

/**
 * This is a MessageReceiver which is used on the client side to accept the
 * messages (response) that come to the client. This correlates the incoming message to
 * the related messages and makes a call to the appropriate callback.
 */
public class CallbackReceiver implements MessageReceiver {
    public static String SERVICE_NAME = "ClientService";
    private HashMap callbackStore;

    public CallbackReceiver() {
        callbackStore = new HashMap();
    }

    public void addCallback(String MsgID, Callback callback) {
        callbackStore.put(MsgID, callback);
    }

    public void receive(MessageContext messageCtx) throws AxisFault {
        RelatesTo relatesTO = messageCtx.getOptions().getRelatesTo();
        String messageID = relatesTO.getValue();
        Callback callback = (Callback) callbackStore.get(messageID);
		AsyncResult result = new AsyncResult(messageCtx);

		if (callback != null) {
			try {
				// check weather the result is a fault.
				SOAPEnvelope envelope = result.getResponseEnvelope();
				SOAPFault fault = envelope.getBody().getFault();

				if (fault == null) {
					// if there is not fault call the onComplete method
					callback.onComplete(result);
				} else {
					// else call the on error method with the fault
					AxisFault axisFault = new AxisFault(fault.getCode(), fault
							.getReason(), fault.getNode(), fault.getRole(),
							fault.getDetail());

					callback.onError(axisFault);
				}
			} finally {
				callback.setComplete(true);
			}
		} else {
            throw new AxisFault("The Callback realtes to MessageID " + messageID + " is not found");
        }
    }

    //to get the pending request
    public HashMap getCallbackStore() {
        return callbackStore;
    }
}