1 files changed, 96 insertions, 0 deletions
diff --git a/tags/java/sca/1.5.1-RC1/modules/core-spi/src/main/java/org/apache/tuscany/sca/store/Store.java b/tags/java/sca/1.5.1-RC1/modules/core-spi/src/main/java/org/apache/tuscany/sca/store/Store.java
new file mode 100644
index 0000000000..b15cde066a
--- /dev/null
+++ b/tags/java/sca/1.5.1-RC1/modules/core-spi/src/main/java/org/apache/tuscany/sca/store/Store.java
@@ -0,0 +1,96 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you 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.apache.tuscany.sca.store;
+
+import org.apache.tuscany.sca.event.EventPublisher;
+import org.apache.tuscany.sca.runtime.RuntimeComponent;
+
+/**
+ * Implementations provide a persistent store for runtime data such as conversational state. A persistent store could be
+ * implemented in a durable fashion using JDBC or a journaling system, or using a non-durable mechanism such as an
+ * in-memory map.
+ *
+ * @version $Rev$ $Date$
+ */
+public interface Store extends EventPublisher {
+
+    /* Used to indicate an the default expiration offset for records for the store */
+    long DEFAULT_EXPIRATION_OFFSET = -1;
+
+    /* Used to indicate an entry should not expire */
+    long NEVER = -2;
+
+    /**
+     * Adds the given record to the store. Implementations may choose different strategies for writing data such as
+     * write-through or write-behind.
+     *
+     * @param owner      the instance owner
+     * @param id         the unique id of the record
+     * @param object     the object representing the data to write
+     * @param expiration the time in milliseconds when the entry expires
+     * @throws StoreWriteException if an error occurs during the write operation
+     */
+    void insertRecord(RuntimeComponent owner, String id, Object object, long expiration) throws StoreWriteException;
+
+    /**
+     * Updates a given record in the store, overwriting previous information.
+     *
+     * @param owner      the instance owner
+     * @param id         the unique id of the record
+     * @param object     the object representing the data to write
+     * @param expiration the time in milliseconds when the entry expires
+     * @throws StoreWriteException
+     */
+    void updateRecord(RuntimeComponent owner, String id, Object object, long expiration) throws StoreWriteException;
+
+    /**
+     * Returns the deserialized object in the store corresponding to the given id
+     *
+     * @param owner the instance owner
+     * @param id    the unique id of the record
+     * @return the deserialized object or null if one is not found
+     * @throws StoreReadException
+     */
+    Object readRecord(RuntimeComponent owner, String id) throws StoreReadException;
+
+    /**
+     * Removes a record from the store
+     *
+     * @param owner the instance owner
+     * @param id    the unique id of the record
+     * @throws StoreWriteException
+     */
+    void removeRecord(RuntimeComponent owner, String id) throws StoreWriteException;
+
+    /**
+     * Removes all records from the store
+     *
+     * @throws StoreWriteException
+     */
+    void removeRecords() throws StoreWriteException;
+
+    /**
+     * Initiates a recovery operation, for example during restart after a crash
+     *
+     * @param listener the listener to receive recovery callback events
+     * @throws StoreReadException
+     */
+    void recover(RecoveryListener listener) throws StoreReadException;
+
+}