WorkspaceConfig.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.core.model.workspace;

import org.eclipse.che.api.core.model.machine.Command;
import org.eclipse.che.api.core.model.project.ProjectConfig;
import org.eclipse.che.commons.annotation.Nullable;

import java.util.List;
import java.util.Map;

/**
 * Defines workspace configuration.
 *
 * @author gazarenkov
 * @author Yevhenii Voevodin
 */
public interface WorkspaceConfig {

    /**
     * Returns the name of the current workspace instance.
     * Workspace name is unique per namespace.
     */
    String getName();

    /**
     * Returns description of workspace.
     */
    @Nullable
    String getDescription();

    /**
     * Returns default environment name.
     * It is mandatory, implementation should guarantee that environment
     * with returned name exists for current workspace config.
     */
    String getDefaultEnv();

    /**
     * Returns commands which are related to workspace,
     * when workspace doesn't contain commands returns empty list.
     * It is optional, workspace may contain 0 or N commands.
     */
    List<? extends Command> getCommands();

    /**
     * Returns project configurations which are related to workspace,
     * when workspace doesn't contain projects returns empty list.
     * It is optional, workspace may contain 0 or N project configurations.
     */
    List<? extends ProjectConfig> getProjects();

    /**
     * Returns mapping of environment names to environment configurations.
     * Workspace must contain at least 1 default environment and may contain N environments.
     */
    Map<String, ? extends Environment> getEnvironments();
}