SPY-183: Allow touch operations to be cloned.

Motivation
----------
In case a touch  operation needs to be rescheduled, it needs to
be cloneable (like any other keyed operation).

Modifications
-------------
Apply the same clone logic as with any other keyed operation. Also
added getter methods to the operations so that the expiration time
can be extracted on cloning.

Result
------
Correct behavior when a touch op needs to be cloned.

Change-Id: Iad343b4dbdcd5dfd4d9ec53bf5335dcf4775f9c9
Reviewed-on: http://review.couchbase.org/48076
Tested-by: Michael Nitschinger <michael.nitschinger@couchbase.com>
Reviewed-by: Simon Baslé <simon@couchbase.com>

Author: daschl

src/main/java/net/spy/memcached/OperationFactory.java

@@ -23,11 +23,6 @@
 
 package net.spy.memcached;
 
-import java.util.Collection;
-import java.util.Map;
-
-import javax.security.auth.callback.CallbackHandler;
-
 import net.spy.memcached.ops.CASOperation;
 import net.spy.memcached.ops.ConcatenationOperation;
 import net.spy.memcached.ops.ConcatenationType;
@@ -53,11 +48,16 @@
 import net.spy.memcached.ops.StoreOperation;
 import net.spy.memcached.ops.StoreType;
 import net.spy.memcached.ops.TapOperation;
+import net.spy.memcached.ops.TouchOperation;
 import net.spy.memcached.ops.UnlockOperation;
 import net.spy.memcached.ops.VersionOperation;
 import net.spy.memcached.tapmessage.RequestMessage;
 import net.spy.memcached.tapmessage.TapOpcode;
 
+import javax.security.auth.callback.CallbackHandler;
+import java.util.Collection;
+import java.util.Map;
+
 /**
  * Factory that builds operations for protocol handlers.
  */
@@ -247,7 +247,7 @@ StoreOperation store(StoreType storeType, String key, int flags, int exp,
    * @param cb The status callback
    * @return A touch operation
    */
-  KeyedOperation touch(String key, int expiration, OperationCallback cb);
+  TouchOperation touch(String key, int expiration, OperationCallback cb);
 
   /**
    * Get a concatenation operation.

src/main/java/net/spy/memcached/ops/BaseOperationFactory.java

@@ -92,7 +92,10 @@ public Collection<Operation> clone(KeyedOperation op) {
     } else if(op instanceof GetAndTouchOperation) {
       GetAndTouchOperation gt = (GetAndTouchOperation) op;
       rv.add(getAndTouch(first(gt.getKeys()), gt.getExpiration(),
-          (GetAndTouchOperation.Callback) gt.getCallback()));
+        (GetAndTouchOperation.Callback) gt.getCallback()));
+    } else if (op instanceof TouchOperation) {
+      TouchOperation tt = (TouchOperation) op;
+      rv.add(touch(first(tt.getKeys()), tt.getExpiration(), tt.getCallback()));
     } else if (op instanceof GetlOperation) {
       GetlOperation gl = (GetlOperation) op;
       rv.add(getl(first(gl.getKeys()), gl.getExpiration(),

src/main/java/net/spy/memcached/ops/TouchOperation.java

@@ -27,6 +27,10 @@
  * Touch operation marker.
  **/
 public interface TouchOperation extends KeyedOperation {
-  // TODO: hook this in with binary protocol
+
+  /**
+   * Get the expiration to set in case of a new entry.
+   */
+  int getExpiration();
 }
 

src/main/java/net/spy/memcached/protocol/ascii/AsciiOperationFactory.java

@@ -23,12 +23,6 @@
 
 package net.spy.memcached.protocol.ascii;
 
-import java.util.ArrayList;
-import java.util.Collection;
-import java.util.Map;
-
-import javax.security.auth.callback.CallbackHandler;
-
 import net.spy.memcached.ops.BaseOperationFactory;
 import net.spy.memcached.ops.CASOperation;
 import net.spy.memcached.ops.ConcatenationOperation;
@@ -57,11 +51,17 @@
 import net.spy.memcached.ops.StoreOperation;
 import net.spy.memcached.ops.StoreType;
 import net.spy.memcached.ops.TapOperation;
+import net.spy.memcached.ops.TouchOperation;
 import net.spy.memcached.ops.UnlockOperation;
 import net.spy.memcached.ops.VersionOperation;
 import net.spy.memcached.tapmessage.RequestMessage;
 import net.spy.memcached.tapmessage.TapOpcode;
 
+import javax.security.auth.callback.CallbackHandler;
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.Map;
+
 /**
  * Operation factory for the ascii protocol.
  */
@@ -133,7 +133,7 @@ public StoreOperation store(StoreType storeType, String key, int flags,
     return new StoreOperationImpl(storeType, key, flags, exp, data, cb);
   }
 
-  public KeyedOperation touch(String key, int expiration,
+  public TouchOperation touch(String key, int expiration,
       OperationCallback cb) {
     return new TouchOperationImpl(key, expiration, cb);
   }

src/main/java/net/spy/memcached/protocol/ascii/TouchOperationImpl.java

@@ -23,16 +23,16 @@
 
 package net.spy.memcached.protocol.ascii;
 
-import java.nio.ByteBuffer;
-import java.util.Collection;
-import java.util.Collections;
-
 import net.spy.memcached.KeyUtil;
-import net.spy.memcached.ops.StatusCode;
-import net.spy.memcached.ops.TouchOperation;
+import net.spy.memcached.ops.OperationCallback;
 import net.spy.memcached.ops.OperationState;
 import net.spy.memcached.ops.OperationStatus;
-import net.spy.memcached.ops.OperationCallback;
+import net.spy.memcached.ops.StatusCode;
+import net.spy.memcached.ops.TouchOperation;
+
+import java.nio.ByteBuffer;
+import java.util.Collection;
+import java.util.Collections;
 
 
 /**
@@ -46,9 +46,9 @@ final class TouchOperationImpl extends OperationImpl implements TouchOperation {
     new OperationStatus(true, "TOUCHED", StatusCode.SUCCESS);
 
   private final String key;
-  private final long exp;
+  private final int exp;
 
-  public TouchOperationImpl(String k, long t, OperationCallback cb) {
+  public TouchOperationImpl(String k, int t, OperationCallback cb) {
     super(cb);
     key = k;
     exp = t;
@@ -77,6 +77,11 @@ public void initialize() {
     setBuffer(b);
   }
 
+  @Override
+  public int getExpiration() {
+    return exp;
+  }
+
   @Override
   public String toString() {
     return "Cmd: touch key: " + key + " exp: " + exp;

src/main/java/net/spy/memcached/protocol/binary/BinaryOperationFactory.java

@@ -53,6 +53,7 @@
 import net.spy.memcached.ops.StoreOperation;
 import net.spy.memcached.ops.StoreType;
 import net.spy.memcached.ops.TapOperation;
+import net.spy.memcached.ops.TouchOperation;
 import net.spy.memcached.ops.UnlockOperation;
 import net.spy.memcached.ops.VersionOperation;
 import net.spy.memcached.tapmessage.RequestMessage;
@@ -140,7 +141,7 @@ public StoreOperation store(StoreType storeType, String key, int flags,
     return new StoreOperationImpl(storeType, key, flags, exp, data, 0, cb);
   }
 
-  public KeyedOperation touch(String key, int expiration,
+  public TouchOperation touch(String key, int expiration,
       OperationCallback cb) {
     return new TouchOperationImpl(key, expiration, cb);
   }

src/main/java/net/spy/memcached/protocol/binary/TouchOperationImpl.java

@@ -24,12 +24,13 @@
 package net.spy.memcached.protocol.binary;
 
 import net.spy.memcached.ops.OperationCallback;
-import static net.spy.memcached.protocol.binary.OperationImpl.STATUS_OK;
+import net.spy.memcached.ops.TouchOperation;
 
 /**
  * Operation to reset a timeout in Membase server.
  */
-public class TouchOperationImpl extends SingleKeyOperationImpl {
+public class TouchOperationImpl extends SingleKeyOperationImpl
+  implements TouchOperation {
 
   static final byte CMD = 0x1c;
 
@@ -50,6 +51,11 @@ protected void decodePayload(byte[] pl) {
     getCallback().receivedStatus(STATUS_OK);
   }
 
+  @Override
+  public int getExpiration() {
+    return exp;
+  }
+
   @Override
   public String toString() {
     return super.toString() + " Exp: " + exp;

src/test/java/net/spy/memcached/protocol/binary/OperationFactoryTest.java

@@ -25,6 +25,8 @@
 import net.spy.memcached.OperationFactory;
 import net.spy.memcached.OperationFactoryTestBase;
 import net.spy.memcached.ops.GetAndTouchOperation;
+import net.spy.memcached.ops.OperationCallback;
+import net.spy.memcached.ops.TouchOperation;
 
 /**
  * An OperationFactoryTest.
@@ -46,4 +48,15 @@ public void testGetAndTouchOperationCloning() {
     assertSame(callback, op2.getCallback());
   }
 
+  public void testTouchOperationCloning() {
+    OperationCallback callback =
+      (OperationCallback) mock(OperationCallback.class).proxy();
+
+    TouchOperation op = ofact.touch(TEST_KEY, 0, callback);
+
+    TouchOperation op2 = cloneOne(TouchOperation.class, op);
+    assertKey(op2);
+    assertSame(callback, op2.getCallback());
+  }
+
 }