X-Git-Url: http://git.argeo.org/?a=blobdiff_plain;f=runtime%2Forg.argeo.slc.detached%2Fsrc%2Fmain%2Fjava%2Forg%2Fargeo%2Fslc%2Fdetached%2FDetachedRequest.java;h=990d2ae45b60db179abbe89ce6990cede5b6f926;hb=e2e168e633c14fa1557ba59261fd900dac1ad70f;hp=99427bf1d12c1f7d56187c4b936590e396cb0116;hpb=8279efc2b92ba454b24ad4d06e7878b00836c07d;p=gpl%2Fargeo-slc.git

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 99427bf1d..990d2ae45 100644
--- 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
@@ -1,7 +1,24 @@
+/*
+ * Copyright (C) 2010 Mathieu Baudier <mbaudier@argeo.org>
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *         http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
 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 +27,8 @@ public class DetachedRequest implements DetachedCommunication {
 	private String ref;
 	private String path = "";
 
+	private Object cachedObject = null;
+
 	public DetachedRequest() {
 
 	}
@@ -18,6 +37,7 @@ public class DetachedRequest implements DetachedCommunication {
 		this.uuid = uuid;
 	}
 
+	/** The properties configuring this request. */
 	public Properties getProperties() {
 		return properties;
 	}
@@ -26,6 +46,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 +58,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 +67,7 @@ public class DetachedRequest implements DetachedCommunication {
 		this.path = path;
 	}
 
+	/** The unique identifier of this request. */
 	public String getUuid() {
 		return uuid;
 	}
@@ -49,4 +75,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;
+	}
+
 }