001/*
002 * VM-Operator
003 * Copyright (C) 2023 Michael N. Lipp
004 * 
005 * This program is free software: you can redistribute it and/or modify
006 * it under the terms of the GNU Affero General Public License as
007 * published by the Free Software Foundation, either version 3 of the
008 * License, or (at your option) any later version.
009 *
010 * This program is distributed in the hope that it will be useful,
011 * but WITHOUT ANY WARRANTY; without even the implied warranty of
012 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
013 * GNU Affero General Public License for more details.
014 *
015 * You should have received a copy of the GNU Affero General Public License
016 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
017 */
018
019package org.jdrupes.vmoperator.runner.qemu.commands;
020
021import com.fasterxml.jackson.databind.JsonNode;
022import com.fasterxml.jackson.databind.node.ObjectNode;
023
024// TODO: Auto-generated Javadoc
025/**
026 * A {@link QmpCommand} that causes a CDROM drive's tray to be opened.
027 */
028public class QmpOpenTray extends QmpCommand {
029
030    @SuppressWarnings({ "PMD.FieldNamingConventions" })
031    private static final JsonNode jsonTemplate
032        = parseJson("{ \"execute\": \"blockdev-open-tray\",\"arguments\": {"
033            + "\"id\": \"\" } }");
034    private final String driveId;
035
036    /**
037     * Instantiates a new qmp open tray.
038     *
039     * @param driveId the drive id
040     */
041    public QmpOpenTray(String driveId) {
042        this.driveId = driveId;
043    }
044
045    @Override
046    public JsonNode toJson() {
047        var cmd = jsonTemplate.deepCopy();
048        ((ObjectNode) cmd.get("arguments")).put("id", driveId);
049        return cmd;
050    }
051
052    @Override
053    public String toString() {
054        return "QmpOpenTray(" + driveId + ")";
055    }
056
057}