StackSource.java

/*******************************************************************************
 * Copyright (c) 2012-2017 Codenvy, S.A.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *   Codenvy, S.A. - initial API and implementation
 *******************************************************************************/
package org.eclipse.che.api.workspace.shared.stack;

/**
 * Defines the interface that describes the stack source. It is a part of the {@link Stack}
 *
 * Example:
 * "source" : {
 * "type":"image",
 * "origin":"codenvy/ubuntu_jdk8"
 * }
 *
 * @author Alexander Andrienko
 */
public interface StackSource {

    /**
     * Returns type for the StackSource.
     * <p>There are three available types of the StackSource:
     * <ul>
     * <li>"recipe"</li>
     * <li>"image"</li>
     * <li>"location"</li>
     * </ul>
     */
    String getType();

    /**
     * Returns origin data for the Stack Source.
     * Origin data can be:
     * <ul>
     * <li>text/plain - when the type is "recipe" (e.g. "FROM codenvy/ubuntu_jdk8"})</li>
     * <li>image tag - when the type is "image" (e.g. "codenvy/ubuntu_jdk8")</li>
     * <li>url - when the type is "location" (e.g. "https://raw.githubusercontent.com/codenvy/dockerfiles/master/php/debian/Dockerfile")
     * </li>
     * </ul>
     */
    String getOrigin();
}