/*
 * Created on 17-May-2004
 */
package ca.uhn.hl7v2.protocol;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import ca.uhn.hl7v2.protocol.impl.AbstractTransport;

/**
 * A mock <code>TransportLayer</code> with which you ca specify messages 
 * that the caller receives, and check messages the caller sends.  
 * 
 * @author <a href="mailto:bryan.tripp@uhn.on.ca">Bryan Tripp</a>
 * @version $Revision: 1.1 $ updated on $Date: 2007/02/19 02:24:38 $ by $Author: jamesagnew $
 */
public class MockTransport extends AbstractTransport implements TransportLayer {

    private List mySentMessages; 
    //private Transportable myNextReceived;
    private List myNextReceivedMsgs; 
    private Map myMetadata;
    
    /**
     * @param theMessagesToBeReceived a list of <code>Transportable</code>s that 
     *      should be returned by receive() (in the order they are to be returned)
     */
    public MockTransport() {
        mySentMessages = new ArrayList();
        myNextReceivedMsgs = new ArrayList();
        myMetadata = new HashMap();
        myMetadata.put("MOCK", "This is a mock transport layer");
    }

    /*
     * Stores message for subsequent availability via getSentMessages()
     */
    public void doSend(Transportable arg0) throws TransportException {
        mySentMessages.add(arg0);
    }
    
    public void setNextReceived(Transportable toBeReceived) {
        //myNextReceived = toBeReceived;
        myNextReceivedMsgs.add(toBeReceived);
    }
    
    public List getSentMessages() {
        return mySentMessages;
    }
    
    public Transportable getLastSent() {
        return (Transportable) mySentMessages.get(mySentMessages.size()-1);
    }

    /**
     * Returns the next message in the to be received list (as provided in 
     * the constructor). 
     */
    public synchronized Transportable doReceive() throws TransportException {
        Transportable next = null;
        if (myNextReceivedMsgs.size() > 0) {
            next = (Transportable) myNextReceivedMsgs.remove(0);
        }
        return next;
        //return (Transportable) myMessagesToBeReceived.get(myNumberReceived++);
    }

    /** 
     * Returns a map with an entry saying this is a mock transport layer.  
     */
    public Map getCommonMetadata() {
        return myMetadata;
    }

    /** 
     * Does nothing
     */
    public void doConnect() throws TransportException {
    }

    /**
     * Does nothing
     */
    public void doDisconnect() throws TransportException {
    }

}