Completely refactor the way the execution server looks for steps

[gpl/argeo-slc.git] / runtime / org.argeo.slc.detached / src / main / java / org / argeo / slc / detached / DetachedRequest.java

diff --git a/runtime/org.argeo.slc.detached/src/main/java/org/argeo/slc/detached/DetachedRequest.java b/runtime/org.argeo.slc.detached/src/main/java/org/argeo/slc/detached/DetachedRequest.java
index 99427bf1d12c1f7d56187c4b936590e396cb0116..af625acd37c714014894b5b40115fc77d6aa37e5 100644 (file)
--- a/runtime/org.argeo.slc.detached/src/main/java/org/argeo/slc/detached/DetachedRequest.java
+++ b/runtime/org.argeo.slc.detached/src/main/java/org/argeo/slc/detached/DetachedRequest.java
@@ -2,6 +2,7 @@ package org.argeo.slc.detached;
 
 import java.util.Properties;
 
+/** A request sent to the detached server. */
 public class DetachedRequest implements DetachedCommunication {
        static final long serialVersionUID = 1l;
 
@@ -10,6 +11,8 @@ public class DetachedRequest implements DetachedCommunication {
        private String ref;
        private String path = "";
 
+       private Object cachedObject = null;
+
        public DetachedRequest() {
 
        }
@@ -18,6 +21,7 @@ public class DetachedRequest implements DetachedCommunication {
                this.uuid = uuid;
        }
 
+       /** The properties configuring this request. */
        public Properties getProperties() {
                return properties;
        }
@@ -26,6 +30,10 @@ public class DetachedRequest implements DetachedCommunication {
                this.properties = inputParameters;
        }
 
+       /**
+        * A reference to the underlying implementation which will process the
+        * request.
+        */
        public String getRef() {
                return ref;
        }
@@ -34,6 +42,7 @@ public class DetachedRequest implements DetachedCommunication {
                this.ref = stepRef;
        }
 
+       /** A path identifying the request within its source context. */
        public String getPath() {
                return path;
        }
@@ -42,6 +51,7 @@ public class DetachedRequest implements DetachedCommunication {
                this.path = path;
        }
 
+       /** The unique identifier of this request. */
        public String getUuid() {
                return uuid;
        }
@@ -49,4 +59,28 @@ public class DetachedRequest implements DetachedCommunication {
        public void setUuid(String uuid) {
                this.uuid = uuid;
        }
+
+       public String toString() {
+               StringBuffer buf = new StringBuffer("detached request for ref ");
+               buf.append(ref);
+               buf.append(" #").append(uuid);
+               buf.append(" cachedObject=").append((cachedObject != null));
+               buf.append(" path=").append(path);
+               buf.append(" properties=").append(properties);
+               return buf.toString();
+       }
+
+       /**
+        * Optimization. Allows the driver to eagerly cache the object in the
+        * request, in order to relieve the detached server of the task to look for
+        * it. No implementation should rely on this to be set.
+        */
+       public Object getCachedObject() {
+               return cachedObject;
+       }
+
+       public void setCachedObject(Object cachedObject) {
+               this.cachedObject = cachedObject;
+       }
+
 }