Merge pull request eclipse-che#350 from eclipse/IDEX-4222

IDEX-4222: Change model of machine & workspace

Author: Alexander Garagatyi

core/che-core-api-model/pom.xml

@@ -21,6 +21,12 @@
     <artifactId>che-core-api-model</artifactId>
     <packaging>jar</packaging>
     <name>Che Core :: API :: Model</name>
+    <dependencies>
+        <dependency>
+            <groupId>org.eclipse.che.core</groupId>
+            <artifactId>che-core-commons-annotations</artifactId>
+        </dependency>
+    </dependencies>
     <build>
         <resources>
             <resource>

core/che-core-api-model/src/main/java/org/eclipse/che/api/core/model/machine/Channels.java

@@ -10,14 +10,50 @@
  *******************************************************************************/
 package org.eclipse.che.api.core.model.machine;
 
+import org.eclipse.che.commons.annotation.Nullable;
+
 /**
  * Defines runtime machine.
  *
  * @author gazarenkov
+ * @author Alexander Garagatyi
  */
-public interface Machine extends MachineState {
+public interface Machine {
+    /**
+     * Returns configuration used to create this machine
+     */
+    MachineConfig getConfig();
+
+    /**
+     * Returns machine identifier. It is unique and mandatory.
+     */
+    String getId();
+
+    /**
+     * Returns ID of workspace this machine belongs to. It is mandatory.
+     */
+    String getWorkspaceId();
+
+    /**
+     * Returns name of environment that started this machine. It is mandatory.
+     */
+    String getEnvName();
+
+    /**
+     * Returns machine owner (users identifier). It is mandatory.
+     */
+    String getOwner();
+
+    /**
+     * Runtime status of the machine
+     */
+    MachineStatus getStatus();
+
     /**
-     * Returns machine specific metadata
+     * Runtime information about machine.
+     * <p>
+     * Is available only when {@link #getStatus()} returns {@link MachineStatus#RUNNING}
      */
-    MachineMetadata getMetadata();
+    @Nullable
+    MachineRuntimeInfo getRuntime();
 }

core/che-core-api-model/src/main/java/org/eclipse/che/api/core/model/machine/Machine.java

@@ -13,11 +13,11 @@
 import java.util.Map;
 
 /**
- * Describe metadata of machine.
+ * Runtime information about machine.
  *
  * @author Alexander Garagatyi
  */
-public interface MachineMetadata {
+public interface MachineRuntimeInfo {
     /**
      * Returns environment variables of machine.
      */

…/core/model/machine/MachineMetadata.java …re/model/machine/MachineRuntimeInfo.javacore/che-core-api-model/src/main/java/org/eclipse/che/api/core/model/machine/MachineMetadata.java renamed to core/che-core-api-model/src/main/java/org/eclipse/che/api/core/model/machine/MachineRuntimeInfo.java core/che-core-api-model/src/main/java/org/eclipse/che/api/core/model/machine/MachineMetadata.java renamed to core/che-core-api-model/src/main/java/org/eclipse/che/api/core/model/machine/MachineRuntimeInfo.java

@@ -8,7 +8,8 @@
  * Contributors:
  *   Codenvy, S.A. - initial API and implementation
  *******************************************************************************/
-package org.eclipse.che.api.core.model.workspace;
+
+package org.eclipse.che.api.core.model.project;
 
 import org.eclipse.che.api.core.model.project.fs.Folder;
 

core/che-core-api-model/src/main/java/org/eclipse/che/api/core/model/machine/MachineState.java

@@ -8,9 +8,8 @@
  * Contributors:
  *   Codenvy, S.A. - initial API and implementation
  *******************************************************************************/
-package org.eclipse.che.api.core.model.workspace;
 
-import org.eclipse.che.api.core.model.project.SourceStorage;
+package org.eclipse.che.api.core.model.project;
 
 import java.util.List;
 import java.util.Map;

…he/api/core/model/workspace/Project.java …/che/api/core/model/project/Project.javacore/che-core-api-model/src/main/java/org/eclipse/che/api/core/model/workspace/Project.java renamed to core/che-core-api-model/src/main/java/org/eclipse/che/api/core/model/project/Project.java core/che-core-api-model/src/main/java/org/eclipse/che/api/core/model/workspace/Project.java renamed to core/che-core-api-model/src/main/java/org/eclipse/che/api/core/model/project/Project.java

@@ -26,7 +26,7 @@ public interface RuntimeWorkspace extends UsersWorkspace {
      * Returns active environment name, implementation should guarantee that environment
      * with returned name exists for current runtime workspace
      */
-    String getActiveEnvName();
+    String getActiveEnv();
 
     /**
      * Returns development machine.
@@ -35,6 +35,8 @@ public interface RuntimeWorkspace extends UsersWorkspace {
     Machine getDevMachine();
 
     /**
+     * Machines included in this environment.
+     * <p>
      * Returns non empty list which contains at least one dev machine and other machines related to workspace.
      */
     List<? extends Machine> getMachines();

…/core/model/workspace/ProjectConfig.java …pi/core/model/project/ProjectConfig.javacore/che-core-api-model/src/main/java/org/eclipse/che/api/core/model/workspace/ProjectConfig.java renamed to core/che-core-api-model/src/main/java/org/eclipse/che/api/core/model/project/ProjectConfig.java core/che-core-api-model/src/main/java/org/eclipse/che/api/core/model/workspace/ProjectConfig.java renamed to core/che-core-api-model/src/main/java/org/eclipse/che/api/core/model/project/ProjectConfig.java

@@ -10,15 +10,16 @@
  *******************************************************************************/
 package org.eclipse.che.api.core.model.workspace;
 
-
-import java.util.List;
-
 /**
  * Defines workspace owned by user.
  *
  * @author gazarenkov
  */
-public interface UsersWorkspace extends WorkspaceConfig {
+public interface UsersWorkspace {
+    /**
+     * Configuration used to create this workspace
+     */
+    WorkspaceConfig getConfig();
 
     /**
      * Returns workspace identifier. It is unique and mandatory.
@@ -35,9 +36,6 @@ public interface UsersWorkspace extends WorkspaceConfig {
      */
     boolean isTemporary();
 
-    @Override
-    List<? extends EnvironmentState> getEnvironments();
-
     /**
      * Returns workspace status.
      */