link.thingscloud.freeswitch.esl.transport.SendMsg Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of freeswitch-esl Show documentation
Freeswitch Esl
There is a newer version: 2.1.0
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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 link.thingscloud.freeswitch.esl.transport;

import java.util.ArrayList;
import java.util.List;

/**
 * SendMsg class.
 *
 * @author : zhouhailin
 * @version 1.0.0
 */
public class SendMsg {

    private final List msgLines = new ArrayList<>();
    private final boolean hasUuid;

    /**
     * Constructor for use with outbound socket client only.  This client mode does not need a call
     * UUID for context.
     */
    public SendMsg() {
        msgLines.add("sendmsg");
        hasUuid = false;
    }

    /**
     * Constructor for use with the inbound client.
     *
     * @param uuid of the call to send message to (it should be in 'park' to be operated on).
     */
    public SendMsg(String uuid) {
        msgLines.add("sendmsg " + uuid);
        hasUuid = true;
    }

    /**
     * Adds the following line to the message:
     *      *   call-command: command
     * 
     *
     * @param command the string command [ execute | hangup ]
     * @return a {@link link.thingscloud.freeswitch.esl.transport.SendMsg} object.
     */
    public SendMsg addCallCommand(String command) {
        msgLines.add("call-command: " + command);
        return this;
    }

    /**
     * Adds the following line to the message:
     *      *   execute-app-name: appName
     * 
     *
     * @param appName the string app name to execute
     * @return a {@link link.thingscloud.freeswitch.esl.transport.SendMsg} object.
     */
    public SendMsg addExecuteAppName(String appName) {
        msgLines.add("execute-app-name: " + appName);
        return this;
    }

    /**
     * Adds the following line to the message:
     *      *   execute-app-arg: arg
     * 
     *
     * @param arg the string arg
     * @return a {@link link.thingscloud.freeswitch.esl.transport.SendMsg} object.
     */
    public SendMsg addExecuteAppArg(String arg) {
        msgLines.add("execute-app-arg: " + arg);
        return this;
    }

    /**
     * Adds the following line to the message:
     *      *   loops: count
     * 
     *
     * @param count the int number of times to loop
     * @return a {@link link.thingscloud.freeswitch.esl.transport.SendMsg} object.
     */
    public SendMsg addLoops(int count) {
        msgLines.add("loops: " + count);
        return this;
    }

    /**
     * Adds the following line to the message:
     *      *   hangup-cause: cause
     * 
     *
     * @param cause the string cause
     * @return a {@link link.thingscloud.freeswitch.esl.transport.SendMsg} object.
     */
    public SendMsg addHangupCause(String cause) {
        msgLines.add("hangup-cause: " + cause);
        return this;
    }

    /**
     * Adds the following line to the message:
     *      *   nomedia-uid: value
     * 
     *
     * @param value the string value part of the line
     * @return a {@link link.thingscloud.freeswitch.esl.transport.SendMsg} object.
     */
    public SendMsg addNomediaUuid(String value) {
        msgLines.add("nomedia-uuid: " + value);
        return this;
    }

    /**
     * Adds the following line to the message:
     *      *    event-lock: true
     *  
     *
     * @return a {@link link.thingscloud.freeswitch.esl.transport.SendMsg} object.
     */
    public SendMsg addEventLock() {
        msgLines.add("event-lock: true");
        return this;
    }

    /**
     * A generic method to add a message line. The constructed line in the sent message will be in the
     * form:
     *      *   name: value
     * 
     *
     * @param name  part of line
     * @param value part of line
     * @return a {@link link.thingscloud.freeswitch.esl.transport.SendMsg} object.
     */
    public SendMsg addGenericLine(String name, String value) {
        msgLines.add(name + ": " + value);
        return this;
    }

    /**
     * The list of strings that make up the message to send to FreeSWITCH.
     *
     * @return list of strings, as they were added to this message.
     */
    public List getMsgLines() {
        return msgLines;
    }

    /**
     * Indicate if message was constructed with a UUID.
     *
     * @return true if constructed with a UUID.
     */
    public boolean hasUuid() {
        return hasUuid;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public String toString() {
        StringBuilder sb = new StringBuilder("SendMsg: ");
        if (msgLines.size() > 1) {
            sb.append(msgLines.get(1));
        } else if (msgLines.size() > 0) {
            sb.append(0);
        }

        return sb.toString();
    }


}