Merge pull request eclipse-che#2234 from eclipse/CHE-1818

CHE-1818: change workspace environment model

Author: Alexander Garagatyi

assembly/assembly-wsmaster-war/pom.xml

@@ -26,6 +26,10 @@
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
     </properties>
     <dependencies>
+        <dependency>
+            <groupId>aopalliance</groupId>
+            <artifactId>aopalliance</artifactId>
+        </dependency>
         <dependency>
             <groupId>com.google.guava</groupId>
             <artifactId>guava</artifactId>

assembly/assembly-wsmaster-war/src/main/java/org/eclipse/che/api/deploy/WsMasterModule.java

@@ -14,9 +14,18 @@
 import com.google.inject.multibindings.Multibinder;
 import com.google.inject.name.Names;
 
+import org.eclipse.che.api.core.rest.CheJsonProvider;
+import org.eclipse.che.api.core.rest.MessageBodyAdapter;
+import org.eclipse.che.api.core.rest.MessageBodyAdapterInterceptor;
 import org.eclipse.che.api.machine.shared.Constants;
+import org.eclipse.che.api.workspace.server.stack.StackMessageBodyAdapter;
+import org.eclipse.che.api.workspace.server.WorkspaceConfigMessageBodyAdapter;
+import org.eclipse.che.api.workspace.server.WorkspaceMessageBodyAdapter;
 import org.eclipse.che.inject.DynaModule;
 
+import static com.google.inject.matcher.Matchers.subclassesOf;
+import static org.eclipse.che.inject.Matchers.names;
+
 /** @author andrew00x */
 @DynaModule
 public class WsMasterModule extends AbstractModule {
@@ -84,6 +93,9 @@ protected void configure() {
                 Multibinder.newSetBinder(binder(), org.eclipse.che.api.machine.server.spi.InstanceProvider.class);
         machineImageProviderMultibinder.addBinding().to(org.eclipse.che.plugin.docker.machine.DockerInstanceProvider.class);
 
+        bind(org.eclipse.che.api.environment.server.compose.ComposeMachineInstanceProvider.class)
+                .to(org.eclipse.che.plugin.docker.machine.ComposeMachineProviderImpl.class);
+
         install(new org.eclipse.che.api.core.rest.CoreRestModule());
         install(new org.eclipse.che.api.core.util.FileCleaner.FileCleanerModule());
         install(new org.eclipse.che.plugin.docker.machine.local.LocalDockerModule());
@@ -95,5 +107,14 @@ protected void configure() {
         install(new org.eclipse.che.plugin.machine.ssh.SshMachineModule());
         install(new org.eclipse.che.plugin.docker.machine.proxy.DockerProxyModule());
         install(new org.eclipse.che.commons.schedule.executor.ScheduleModule());
+
+        final Multibinder<MessageBodyAdapter> adaptersMultibinder = Multibinder.newSetBinder(binder(), MessageBodyAdapter.class);
+        adaptersMultibinder.addBinding().to(WorkspaceConfigMessageBodyAdapter.class);
+        adaptersMultibinder.addBinding().to(WorkspaceMessageBodyAdapter.class);
+        adaptersMultibinder.addBinding().to(StackMessageBodyAdapter.class);
+
+        final MessageBodyAdapterInterceptor interceptor = new MessageBodyAdapterInterceptor();
+        requestInjection(interceptor);
+        bindInterceptor(subclassesOf(CheJsonProvider.class), names("readFrom"), interceptor);
     }
 }

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

@@ -26,6 +26,10 @@
         <findbugs.failonerror>false</findbugs.failonerror>
     </properties>
     <dependencies>
+        <dependency>
+            <groupId>aopalliance</groupId>
+            <artifactId>aopalliance</artifactId>
+        </dependency>
         <dependency>
             <groupId>com.google.code.gson</groupId>
             <artifactId>gson</artifactId>

core/che-core-api-core/src/main/java/org/eclipse/che/api/core/rest/MessageBodyAdapter.java

@@ -0,0 +1,46 @@
+/*******************************************************************************
+ * Copyright (c) 2012-2016 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.rest;
+
+import com.google.common.annotations.Beta;
+
+import javax.ws.rs.WebApplicationException;
+import java.io.IOException;
+import java.io.InputStream;
+import java.util.Set;
+
+/**
+ * Adapts an entity stream in an implementation specific way.
+ *
+ * <p>To bind custom adapter:
+ * <pre>
+ *  Multibinder<MessageBodyAdapter> adaptersBinder = Multibinder.newSetBinder(binder(), MessageBodyAdapter.class);
+ *  adaptersBinder.addBinding().to(CustomMessageBodyAdapter.class);
+ * </pre>
+ *
+ * @author Yevhenii Voevodin
+ */
+@Beta
+public interface MessageBodyAdapter {
+
+    /** Returns classes for which adaption will be triggered. */
+    Set<Class<?>> getTriggers();
+
+    /**
+     * Adapts entity stream to a new one, if necessary.
+     *
+     * @param entityStream
+     *         an entity stream
+     * @return a new stream with an adapted data or the same {@code entityStream}
+     * if there is nothing to adapt
+     */
+    InputStream adapt(InputStream entityStream) throws WebApplicationException, IOException;
+}

core/che-core-api-core/src/main/java/org/eclipse/che/api/core/rest/MessageBodyAdapterInterceptor.java

@@ -0,0 +1,58 @@
+/*******************************************************************************
+ * Copyright (c) 2012-2016 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.rest;
+
+import com.google.common.annotations.Beta;
+
+import org.aopalliance.intercept.MethodInterceptor;
+import org.aopalliance.intercept.MethodInvocation;
+
+import javax.inject.Inject;
+import javax.ws.rs.core.MediaType;
+import javax.ws.rs.core.MultivaluedMap;
+import javax.ws.rs.ext.MessageBodyReader;
+import java.io.InputStream;
+import java.lang.annotation.Annotation;
+import java.lang.reflect.Type;
+import java.util.HashMap;
+import java.util.Map;
+import java.util.Set;
+
+/**
+ * This interceptor must be bound for the method
+ * {@link MessageBodyReader#readFrom(Class, Type, Annotation[], MediaType, MultivaluedMap, InputStream)}
+ *
+ * @author Yevhenii Voevodin
+ */
+@Beta
+public class MessageBodyAdapterInterceptor implements MethodInterceptor {
+
+    private final Map<Class<?>, MessageBodyAdapter> adapters = new HashMap<>();
+
+    @Inject
+    public void init(Set<MessageBodyAdapter> adapters) {
+        for (MessageBodyAdapter adapter : adapters) {
+            for (Class<?> trigger : adapter.getTriggers()) {
+                this.adapters.put(trigger, adapter);
+            }
+        }
+    }
+
+    @Override
+    public Object invoke(MethodInvocation invocation) throws Throwable {
+        final Object[] args = invocation.getArguments();
+        final MessageBodyAdapter adapter = adapters.get((Class<?>)args[0]);
+        if (adapter != null) {
+            args[args.length - 1] = adapter.adapt((InputStream)args[args.length - 1]);
+        }
+        return invocation.proceed();
+    }
+}

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

@@ -18,6 +18,7 @@
 /**
  * @author gazarenkov
  */
+@Deprecated
 public interface MachineConfig {
 
     /**
@@ -44,7 +45,7 @@ public interface MachineConfig {
      * Machine limits such as RAM size.
      */
     @Nullable
-    Limits getLimits();
+    MachineLimits getLimits();
 
     /**
      * Get configuration of servers inside of machine.

…e/che/api/core/model/machine/Limits.java …pi/core/model/machine/MachineLimits.javacore/che-core-api-model/src/main/java/org/eclipse/che/api/core/model/machine/Limits.java renamed to core/che-core-api-model/src/main/java/org/eclipse/che/api/core/model/machine/MachineLimits.java core/che-core-api-model/src/main/java/org/eclipse/che/api/core/model/machine/Limits.java renamed to core/che-core-api-model/src/main/java/org/eclipse/che/api/core/model/machine/MachineLimits.java

@@ -15,7 +15,8 @@
  *
  * @author Alexander Garagatyi
  */
-public interface Limits {
+@Deprecated
+public interface MachineLimits {
     /** Get memory size (in megabytes) that is allocated for starting machine. */
     int getRam();
 }

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

@@ -13,6 +13,7 @@
 /**
  * @author gazarenkov
  */
+@Deprecated
 public interface MachineSource {
 
     /**

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

@@ -17,6 +17,7 @@
  *
  * @author Alexander Garagatyi
  */
+@Deprecated
 public interface ServerConf {
     /**
      * Reference to this server.

core/che-core-api-model/src/main/java/org/eclipse/che/api/core/model/workspace/Environment.java

@@ -10,34 +10,23 @@
  *******************************************************************************/
 package org.eclipse.che.api.core.model.workspace;
 
-import org.eclipse.che.api.core.model.machine.MachineConfig;
-import org.eclipse.che.api.core.model.machine.Recipe;
-
-import java.util.List;
+import java.util.Map;
 
 /**
  * Defines environment for machines network.
  *
  * @author gazarenkov
+ * @author Alexander Garagatyi
  */
 public interface Environment {
-
-    /**
-     * Returns environment display name. It is mandatory and unique per workspace
-     */
-    String getName();
-
     /**
      * Returns the recipe (the main script) to define this environment (compose, kubernetes pod).
-     * Type of this recipe defines engine for composing machines network runtime
+     * Type of this recipe defines engine for composing machines network runtime.
      */
-    Recipe getRecipe();
+    EnvironmentRecipe getRecipe();
 
     /**
-     * Returns list of Machine configs defined by this environment
-     * Note: it may happen that we are not able to provide this info for particular environment type
-     * or for particular time (for example this information may be reasonable accessible only when we start network or so)
-     * to investigate
+     * Returns mapping of machine name to additional configuration of machine.
      */
-    List<? extends MachineConfig> getMachineConfigs();
+    Map<String, ? extends ExtendedMachine> getMachines();
 }