com.devoteam.srit.xmlloader.msrp.StackMsrp.java Source code

Introduction

Here is the source code for com.devoteam.srit.xmlloader.msrp.StackMsrp.java

Source

/* 
 * Copyright 2012 Devoteam http://www.devoteam.com
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 * 
 * 
 * This file is part of Multi-Protocol Test Suite (MTS).
 * 
 * Multi-Protocol Test Suite (MTS) is free software: you can redistribute
 * it and/or modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation, either version 3 of the
 * License.
 * 
 * Multi-Protocol Test Suite (MTS) is distributed in the hope that it will
 * be useful, but WITHOUT ANY WARRANTY; without even the implied warranty 
 * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with Multi-Protocol Test Suite (MTS).
 * If not, see <http://www.gnu.org/licenses/>.
 * 
 */

package com.devoteam.srit.xmlloader.msrp;

import com.devoteam.srit.xmlloader.core.ParameterPool;
import com.devoteam.srit.xmlloader.core.Runner;
import com.devoteam.srit.xmlloader.core.Tester;
import org.dom4j.Element;

import com.devoteam.srit.xmlloader.core.log.TextEvent;
import com.devoteam.srit.xmlloader.core.protocol.Channel;
import com.devoteam.srit.xmlloader.core.protocol.Listenpoint;
import com.devoteam.srit.xmlloader.core.protocol.Msg;
import com.devoteam.srit.xmlloader.core.protocol.Stack;
import com.devoteam.srit.xmlloader.core.protocol.StackFactory;
import com.devoteam.srit.xmlloader.core.protocol.Trans;
import com.devoteam.srit.xmlloader.core.utils.Config;
import com.devoteam.srit.xmlloader.core.utils.Utils;
import com.devoteam.srit.xmlloader.core.utils.XMLElementReplacer;
import com.devoteam.srit.xmlloader.core.utils.XMLElementTextMsgParser;

import java.io.InputStream;

public class StackMsrp extends Stack {

    public StackMsrp() throws Exception {
        super();

        // initiate a default listenpoint if port is not empty or null
        int port = getConfig().getInteger("listenpoint.LOCAL_PORT", 0);
        if (port > 0) {
            Listenpoint listenpoint = new ListenpointMsrp(this);
            createListenpoint(listenpoint, StackFactory.PROTOCOL_MSRP);
        }
    }

    /** Creates a Listenpoint specific to each Stack */
    @Override
    public Listenpoint parseListenpointFromXml(Element root) throws Exception {
        Listenpoint listenpoint = new ListenpointMsrp(this, root);
        return listenpoint;
    }

    /** Creates a Channel specific to each Stack */
    @Override
    public synchronized Channel parseChannelFromXml(Element root, String protocol) throws Exception {
        String name = root.attributeValue("name");
        String localHost = root.attributeValue("localHost");
        String localPort = root.attributeValue("localPort");
        String remoteHost = root.attributeValue("remoteHost");
        String remotePort = root.attributeValue("remotePort");
        String transport = root.attributeValue("transport");

        if ((remoteHost == null) || (remotePort == null)) {
            throw new Exception("Missing one of the remoteHost or remotePort parameter to create channel.");
        }

        if (localHost == null) {
            localHost = Utils.getLocalAddress().getHostAddress();
        }

        if (null == transport) {
            transport = getConfig().getString("listenpoint.TRANSPORT");
            if (null == transport) {
                throw new Exception("Transport(tcp or tls) not set in openChannelMSRP nor in msrp.properties");
            }
        } else if (!transport.toUpperCase().equals(StackFactory.PROTOCOL_TCP)
                && !transport.toUpperCase().equals(StackFactory.PROTOCOL_TLS)) {
            throw new Exception("Transport in openChannelMSRP must be tcp or tls");
        }

        if (existsChannel(name)) {
            return getChannel(name);
        } else {
            return new ChannelMsrp(name, localHost, localPort, remoteHost, remotePort, protocol,
                    transport.toUpperCase());
        }
    }

    /** Creates a specific Msg */
    public Msg parseMsgFromXml(Boolean request, Element root, Runner runner) throws Exception {
        String text = root.getText();
        return new MsgMsrp(text);
    }

    /** Send a Msg to Stack */
    @Override
    public synchronized boolean sendMessage(Msg msg) throws Exception {

        // copy the channel from the request into the response using the transaction
        Trans trans = msg.getTransaction();
        if (trans != null) {
            Channel channel = trans.getBeginMsg().getChannel();
            msg.setChannel(channel);
        }

        return super.sendMessage(msg);
    }

    /** Returns the Config object to access the protocol config file*/
    public Config getConfig() throws Exception {
        return Config.getConfigByName("msrp.properties");
    }

    /** Returns the replacer used to parse sendMsg Operations */
    public XMLElementReplacer getElementReplacer() {
        return XMLElementTextMsgParser.instance();
    }

    /**
     * Creates a Msg specific to each Channel type
     * should become ABSTRACT later
     */
    @Override
    public Msg readFromStream(InputStream inputStream, Channel channel) throws Exception {
        String text = null;
        synchronized (inputStream) {
            text = this.reader(inputStream);
        }

        if (text != null && text.contains(StackFactory.PROTOCOL_MSRP)) {
            return new MsgMsrp(text);
        }

        Tester.getGlobalLogger().getApplicationLogger().warn(TextEvent.Topic.PROTOCOL,
                "Receive an incomplete message; we ignore it : ", text);
        return null;
    }

    protected String reader(InputStream inputStream) throws Exception {
        StringBuilder message = new StringBuilder();
        String line = "";

        while (!line.startsWith("-------") && (!line.endsWith("$") || !line.endsWith("+") || !line.endsWith("#"))) {
            line = Utils.readLineFromInputStream(inputStream);
            message.append(line);
        }

        return message.toString();
    }
}