net.holmes.core.business.streaming.airplay.command.AirplayCommand.java Source code

Introduction

Here is the source code for net.holmes.core.business.streaming.airplay.command.AirplayCommand.java

Source

/*
 * Copyright (C) 2012-2014  Cedric Cheneau
 *
 * This program 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, or
 * (at your option) any later version.
 *
 * This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.
 */

package net.holmes.core.business.streaming.airplay.command;

import com.google.common.collect.Maps;
import io.netty.handler.codec.http.HttpMethod;
import net.holmes.core.business.streaming.device.CommandFailureHandler;

import java.util.Map;

import static io.netty.handler.codec.http.HttpHeaders.Names.CONTENT_LENGTH;
import static io.netty.handler.codec.http.HttpHeaders.Names.USER_AGENT;
import static io.netty.handler.codec.http.HttpMethod.GET;
import static io.netty.handler.codec.http.HttpMethod.POST;
import static io.netty.handler.codec.http.HttpVersion.HTTP_1_1;

/**
 * Airplay command.
 */
public abstract class AirplayCommand {
    private static final String AIRPLAY_USER_AGENT = "MediaControl/1.0";
    private static final String PARAMETER_SEPARATOR = ": ";
    private static final String EOL = "\n";
    private static final String SPACE = " ";

    private final CommandType type;
    private final CommandFailureHandler failureHandler;
    private final Map<UrlParameter, String> urlParameters;
    private final Map<PostParameter, String> postParameters;

    /**
     * Instantiates a new Airplay command.
     *
     * @param type           command type
     * @param failureHandler failure handler
     */
    public AirplayCommand(final CommandType type, final CommandFailureHandler failureHandler) {
        this.type = type;
        this.failureHandler = failureHandler;
        this.urlParameters = Maps.newHashMap();
        this.postParameters = Maps.newLinkedHashMap();
    }

    /**
     * Add Url parameter.
     *
     * @param parameter Url parameter
     * @param value     Url parameter value
     */
    public void addUrlParameter(final UrlParameter parameter, final String value) {
        urlParameters.put(parameter, value);
    }

    /**
     * Add post parameter.
     *
     * @param parameter post parameter
     * @param value     post parameter value
     */
    public void addPostParameter(final PostParameter parameter, final String value) {
        this.postParameters.put(parameter, value);
    }

    /**
     * Get Http request.
     *
     * @return Http request
     */
    public String getRequest() {
        StringBuilder sbCommand = new StringBuilder();
        String requestContent = getRequestContent();

        // Http command
        sbCommand.append(type.getMethod()).append(SPACE).append(getRequestUrl()).append(SPACE)
                .append(HTTP_1_1.text()).append(EOL);

        // Http headers
        sbCommand.append(CONTENT_LENGTH).append(PARAMETER_SEPARATOR)
                .append(requestContent == null ? 0 : requestContent.length()).append(EOL);
        sbCommand.append(USER_AGENT).append(PARAMETER_SEPARATOR).append(AIRPLAY_USER_AGENT).append(EOL);

        // Http content
        if (requestContent != null) {
            sbCommand.append(EOL).append(requestContent);
        }

        sbCommand.append(EOL);
        return sbCommand.toString();
    }

    /**
     * Command failure.
     *
     * @param message error message
     */
    public final void failure(String message) {
        if (failureHandler != null) {
            failureHandler.handle(message);
        }
    }

    /**
     * Success callback.
     *
     * @param contentParameters content parameters map
     */
    public abstract void success(Map<String, String> contentParameters);

    /**
     * Get request Url.
     *
     * @return request Url
     */
    private String getRequestUrl() {
        StringBuilder sbUrl = new StringBuilder();
        sbUrl.append("/").append(type.getValue());
        if (!urlParameters.isEmpty()) {
            sbUrl.append("?");
            for (UrlParameter param : urlParameters.keySet()) {
                sbUrl.append(param.getValue()).append("=").append(urlParameters.get(param)).append("&");
            }
            sbUrl.deleteCharAt(sbUrl.length() - 1);
        }
        return sbUrl.toString();
    }

    /**
     * Get request content.
     *
     * @return request content
     */
    private String getRequestContent() {
        // Build Http content
        if (!postParameters.isEmpty()) {
            StringBuilder sbContent = new StringBuilder();
            for (PostParameter param : postParameters.keySet()) {
                sbContent.append(param.getValue()).append(PARAMETER_SEPARATOR).append(postParameters.get(param))
                        .append(EOL);
            }
            return sbContent.toString();
        } else {
            return null;
        }
    }

    /**
     * Airplay command type
     */
    public static enum CommandType {
        PLAY("play", POST), PLAY_STATUS("scrub", GET), RATE("rate", POST), SEEK("scrub", POST), STOP("stop", POST);

        private final String value;
        private final HttpMethod method;

        /**
         * Instantiates a new command type.
         *
         * @param value value
         */
        CommandType(final String value, final HttpMethod method) {
            this.value = value;
            this.method = method;
        }

        /**
         * Get command type value.
         *
         * @return command type value
         */
        public String getValue() {
            return value;
        }

        public HttpMethod getMethod() {
            return method;
        }
    }

    /**
     * Url parameter
     */
    public static enum UrlParameter {
        VALUE("value"), POSITION("position");
        private final String value;

        /**
         * Instantiates a new Url parameter
         *
         * @param value value
         */
        private UrlParameter(final String value) {
            this.value = value;
        }

        /**
         * Get Url parameter value.
         *
         * @return Url parameter value
         */
        public String getValue() {
            return value;
        }
    }

    /**
     * Post parameter
     */
    public static enum PostParameter {
        CONTENT_LOCATION("Content-Location"), START_POSITION("Start-Position");
        private final String value;

        /**
         * Instantiates a new post parameter
         *
         * @param value value
         */
        private PostParameter(final String value) {
            this.value = value;
        }

        /**
         * Get post parameter value.
         *
         * @return post parameter value
         */
        public String getValue() {
            return value;
        }
    }
}