org.eclipse.ditto.signals.commands.devops.DevOpsCommand Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2017 Bosch Software Innovations GmbH.
 *
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v2.0
 * which accompanies this distribution, and is available at
 * https://www.eclipse.org/org/documents/epl-2.0/index.php
 *
 * Contributors:
 *    Bosch Software Innovations GmbH - initial contribution
 */
package org.eclipse.ditto.signals.commands.devops;

import java.util.Optional;

import org.eclipse.ditto.json.JsonFactory;
import org.eclipse.ditto.json.JsonFieldDefinition;
import org.eclipse.ditto.json.JsonPointer;
import org.eclipse.ditto.model.base.headers.DittoHeaders;
import org.eclipse.ditto.model.base.json.FieldType;
import org.eclipse.ditto.model.base.json.JsonSchemaVersion;
import org.eclipse.ditto.signals.commands.base.Command;

/**
 * Base interface for all devops commands which are understood by all services.
 *
 * @param  the type of the implementing class.
 */
public interface DevOpsCommand extends Command {

    /**
     * Type Prefix of DevOps commands.
     */
    String TYPE_PREFIX = "devops.commands:";

    /**
     * DevOps resource type.
     */
    String RESOURCE_TYPE = "devops";

    /**
     * Returns the type of this command.
     *
     * @return the type of this command
     */
    String getType();

    @Override
    T setDittoHeaders(DittoHeaders dittoHeaders);

    @Override
    default String getId() {
        return ""; // empty ID for DevOps commands
    }

    @Override
    default String getTypePrefix() {
        return TYPE_PREFIX;
    }

    @Override
    default String getResourceType() {
        return RESOURCE_TYPE;
    }

    @Override
    default JsonPointer getResourcePath() {
        return JsonPointer.empty(); // empty resource path for DevOps commands
    }

    /**
     * @return the service name to which to send the DevOpsCommand.
     */
    Optional getServiceName();

    /**
     * @return the instance index of the serviceName to which to send the DevOpsCommand.
     */
    Optional getInstance();

    /**
     * An enumeration of the known {@link org.eclipse.ditto.json.JsonField}s of a DevOpsCommand.
     */
    class JsonFields extends Command.JsonFields {

        /**
         * JSON field containing the serviceName to which to send the DevOpsCommand.
         */
        public static final JsonFieldDefinition JSON_SERVICE_NAME =
                JsonFactory.newStringFieldDefinition("serviceName", FieldType.REGULAR, JsonSchemaVersion.V_1,
                        JsonSchemaVersion.V_2);

        /**
         * JSON field containing the instance index of the serviceName serviceName to which to send the DevOpsCommand.
         */
        public static final JsonFieldDefinition JSON_INSTANCE =
                JsonFactory.newIntFieldDefinition("instance", FieldType.REGULAR, JsonSchemaVersion.V_1,
                        JsonSchemaVersion.V_2);

    }

}