Issue #835対応 (#836)

Co-authored-by: m-takata <[email protected]>

Author: m-takata

src/main/java/jp/ossc/nimbus/service/context/DistributedSharedContextService.java

@@ -1523,6 +1523,18 @@ public void putAsynch(Object key, Object value) throws SharedContextSendExceptio
         selectDistributeContext(key).putAsynch(key, value);
     }
 
+    public Object getUpdateTemplate(Object key) throws SharedContextSendException{
+        return getUpdateTemplate(key, defaultTimeout);
+    }
+    
+    public Object getUpdateTemplate(Object key, long timeout) throws SharedContextSendException, SharedContextTimeoutException{
+        return getUpdateTemplate(key, timeout, false);
+    }
+    
+    public Object getUpdateTemplate(Object key, long timeout, boolean withTransaction) throws SharedContextSendException, SharedContextTimeoutException{
+        return selectDistributeContext(key).getUpdateTemplate(key, timeout, withTransaction);
+    }
+    
     public void update(Object key, SharedContextValueDifference diff) throws SharedContextSendException{
         update(key, diff, defaultTimeout);
     }

src/main/java/jp/ossc/nimbus/service/context/SharedContext.java

@@ -222,6 +222,38 @@ public interface SharedContext extends Context{
      */
     public void putAsynch(Object key, Object value) throws SharedContextSendException;
 
+    /**
+     * 指定したキーの値を差分更新するためのテンプレートとなるオブジェクトを取得する。<p>
+     *
+     * @param key キー
+     * @return 差分更新するためのテンプレートとなるオブジェクト
+     * @exception SharedContextSendException 分散サーバへのメッセージ送信に失敗した場合
+     */
+    public Object getUpdateTemplate(Object key) throws SharedContextSendException;
+
+    /**
+     * 指定したキーの値を差分更新するためのテンプレートとなるオブジェクトを取得する。<p>
+     *
+     * @param key キー
+     * @param timeout タイムアウト[ms]
+     * @return 差分更新するためのテンプレートとなるオブジェクト
+     * @exception SharedContextSendException 分散サーバへのメッセージ送信に失敗した場合
+     * @exception SharedContextTimeoutException 分散サーバからの応答待ちでタイムアウトした場合
+     */
+    public Object getUpdateTemplate(Object key, long timeout) throws SharedContextSendException, SharedContextTimeoutException;
+
+    /**
+     * 指定したキーの値を差分更新するためのテンプレートとなるオブジェクトを取得する。<p>
+     *
+     * @param key キー
+     * @param timeout タイムアウト[ms]
+     * @param withTransaction trueの場合、トランザクションを考慮する
+     * @return 差分更新するためのテンプレートとなるオブジェクト
+     * @exception SharedContextSendException 分散サーバへのメッセージ送信に失敗した場合
+     * @exception SharedContextTimeoutException 分散サーバからの応答待ちでタイムアウトした場合
+     */
+    public Object getUpdateTemplate(Object key, long timeout, boolean withTransaction) throws SharedContextSendException, SharedContextTimeoutException;
+    
     /**
      * 指定したキーで、指定した差分を更新する。<p>
      *

src/main/java/jp/ossc/nimbus/service/context/SharedContextRecord.java

@@ -101,6 +101,12 @@ public int getUpdateVersion(){
         return updateVersion;
     }
 
+    public Object getUpdateTemplate(){
+        SharedContextRecord clone = (SharedContextRecord)cloneSchema();
+        clone.updateVersion = updateVersion;
+        return clone;
+    }
+    
     protected static int compareToUpdateVersion(int ver1, int ver2){
         long version1 = ver1;
         long version2 = ver2;

src/main/java/jp/ossc/nimbus/service/context/SharedContextRecordList.java

@@ -175,6 +175,12 @@ public int getUpdateVersion(){
         return updateVersion;
     }
 
+    public Object getUpdateTemplate(){
+        SharedContextRecordList clone = (SharedContextRecordList)cloneSchema();
+        clone.updateVersion = updateVersion;
+        return clone;
+    }
+    
     public Record createRecord(){
         if(recordClass == null){
             SharedContextRecord record = new SharedContextRecord(recordSchema);
@@ -261,6 +267,14 @@ public SharedContextValueDifference updateRemove(int index, SharedContextValueDi
         return diff;
     }
 
+    /**
+     * 指定されたレコードを削除した場合の差分情報を取得する。<p>
+     *
+     * @param record 削除するレコード
+     * @param diff 差分
+     * @return 差分
+     * @exception SharedContextUpdateException 差分情報の取得に失敗した場合
+     */
     public SharedContextValueDifference updateRemove(Record record, SharedContextValueDifference diff) throws SharedContextUpdateException{
         if(diff == null){
             diff = new Difference();
@@ -271,6 +285,13 @@ public SharedContextValueDifference updateRemove(Record record, SharedContextVal
         return diff;
     }
 
+    /**
+     * 全件削除の差分情報を取得する。<p>
+     *
+     * @param diff 差分
+     * @return 差分
+     * @exception SharedContextUpdateException 差分情報の取得に失敗した場合
+     */
     public SharedContextValueDifference updateClear(SharedContextValueDifference diff) throws SharedContextUpdateException{
         if(diff == null){
             diff = new Difference();