1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
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;
}
|
