/*
 * Copyright (c) 2013 Pantheon Technologies s.r.o. and others. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
 * and is available at http://www.eclipse.org/legal/epl-v10.html
 */

package org.opendaylight.openflowjava.protocol.impl.clients;

import java.util.Stack;

import org.opendaylight.openflowjava.util.ByteBufUtils;

/**
 * Class for providing prepared handshake scenario
 * 
 * @author michal.polkorab
 */
public final class ScenarioFactory {

    private ScenarioFactory() {
        throw new UnsupportedOperationException("Utility class shouldn't be instantiated");
    }

    /**
     * Creates stack with handshake needed messages.
     * <ol> XID of messages:
     *   <li> hello sent - 00000001
     *   <li> hello waiting - 00000002
     *   <li> featuresrequest waiting - 00000003
     *   <li> featuresreply sent - 00000003
     * </ol>
     * @return stack filled with Handshake messages
     */
    public static Stack<ClientEvent> createHandshakeScenario() {
        Stack<ClientEvent> stack = new Stack<>();
        stack.add(0, new SendEvent(ByteBufUtils.hexStringToBytes("04 00 00 08 00 00 00 01")));
        stack.add(0, new WaitForMessageEvent(ByteBufUtils.hexStringToBytes("04 00 00 08 00 00 00 02")));
        stack.add(0, new WaitForMessageEvent(ByteBufUtils.hexStringToBytes("04 05 00 08 00 00 00 03")));
        stack.add(0, new SendEvent(ByteBufUtils.hexStringToBytes("04 06 00 20 00 00 00 03 "
                + "00 01 02 03 04 05 06 07 00 01 02 03 01 00 00 00 00 01 02 03 00 01 02 03")));
        return stack;
    }

    /**
     * Creates stack with handshake needed messages.
     * <ol> XID of messages:
     *   <li> hello sent - 00000001
     *   <li> hello waiting - 00000002
     *   <li> featuresrequest waiting - 00000003
     *   <li> featuresreply sent - 00000003
     * </ol>
     * @param auxiliaryId auxiliaryId wanted in featuresReply message
     * @return stack filled with Handshake messages (featuresReply with auxiliaryId set)
     */
    public static Stack<ClientEvent> createHandshakeScenarioWithAuxiliaryId(byte auxiliaryId) {
        Stack<ClientEvent> stack = new Stack<>();
        stack.add(0, new SendEvent(ByteBufUtils.hexStringToBytes("04 00 00 08 00 00 00 01")));
        stack.add(0, new WaitForMessageEvent(ByteBufUtils.hexStringToBytes("04 00 00 08 00 00 00 02")));
        stack.add(0, new WaitForMessageEvent(ByteBufUtils.hexStringToBytes("04 05 00 08 00 00 00 03")));
        stack.add(0, new SendEvent(ByteBufUtils.hexStringToBytes("04 06 00 20 00 00 00 03 "
                + "00 01 02 03 04 05 06 07 00 01 02 03 01 " + String.format("%02x ", auxiliaryId) + " 00 00 00 01 02 03 00 01 02 03")));
        return stack;
    }

}