/
persistence.html
217 lines (212 loc) · 9.37 KB
/
persistence.html
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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
<!DOCTYPE doctype PUBLIC "-//w3c//dtd html 4.0 transitional//en">
<html>
<head>
<title>Persistence for Hashtables</title>
<link rel="important stylesheet"
href="chrome://messenger/skin/messageBody.css">
<meta http-equiv="Content-Type" content="text/html; ">
<meta name="GENERATOR"
content="Mozilla/4.78 [en] (X11; U; Linux 2.4.8-26mdk i586) [Netscape]">
</head>
<body>
<br>
<h1><dt><font size="+4">Persistence</font></dt>
</h1>
<h2>Using Persistence</h2>
<ul>
<li>The package is meant for users who need to maintain the state of their
Serializable name-value pair sets for better fault tolerance. Using this package
will improve usability but will affect performance depending on the usage
of the persist API.</li>
<li>The current package will support only 2 known implementations, the
DB storage way (which is vendor independant) and an ad-hoc (or some open
source) implementation.</li>
<li>The Persistence package assumes that the user will provide appropriate
properties to initialize and use the storage mechanism.</li>
</ul>
<h2>Code Example</h2>
Code examples make it easy to comprehend the package.
<p><samp><font face="Courier New, Courier, monospace"><code><br>
</code></font></samp></p>
<font face="Courier New, Courier, monospace">import org.jgroups.persistence.*;</font>
<br>
<br>
<font face="Courier New, Courier, monospace">// getting default factor</font><br>
<dt><font face="Courier New, Courier, monospace"><b>PersistenceFactory</b>
<b>factory</b> = <b>PersistenceFactory();</b><br>
</font></dt>
<dt><font face="Courier New, Courier, monospace">//get reference to
PersistenceManager (handle Exception as required by application)</font></dt>
<dt><font face="Courier New, Courier, monospace">// if user defines own properties</font></dt>
<dt><font face="Courier New, Courier, monospace"> try</font></dt>
<dt><font face="Courier New, Courier, monospace">{</font></dt>
<dt><font face="Courier New, Courier, monospace"> String
filepath = "/home/user/userdefined.properties"</font></dt>
<dt><font face="Courier New, Courier, monospace"> <b>PersistenceManager
manager = factory.createPersistenceManager(filepath);</b></font></dt>
<dt><font face="Courier New, Courier, monospace"> <br>
//if user used existing properties by filling the values
(default properties)</font></dt>
<dt><font face="Courier New, Courier, monospace"> // <b>PersistenceManager
manager = factory.createPersistenceManager();</b></font></dt>
<dt><font face="Courier New, Courier, monospace">}catch (Exception e)</font></dt>
<dt><font face="Courier New, Courier, monospace">{</font></dt>
<dt><font face="Courier New, Courier, monospace"> //handle
Exception</font></dt>
<dt><font face="Courier New, Courier, monospace">}</font></dt>
<dt><br>
</dt>
<dt><br>
</dt>
<dt><font face="Courier New, Courier, monospace">//once the persistencemanager
reference is obtained, use available</font></dt>
<dt><font face="Courier New, Courier, monospace">// to save a NV</font></dt>
<dt><font face="Courier New, Courier, monospace">HashMap map = new HashMap();</font></dt>
<dt><font face="Courier New, Courier, monospace">map.put("bela", "bela");</font></dt>
<dt><font face="Courier New, Courier, monospace">map.put("mandar", "mandar");</font></dt>
<dt><font face="Courier New, Courier, monospace">try</font></dt>
<dt><font face="Courier New, Courier, monospace">{</font></dt>
<dt><font face="Courier New, Courier, monospace"> <b>manager.saveAll(map);</b>
// will store all values from map into storage</font></dt>
<dt><font face="Courier New, Courier, monospace">}catch (CannotPersistException
cpe)</font></dt>
<dt><font face="Courier New, Courier, monospace">{</font></dt>
<dt><font face="Courier New, Courier, monospace"> //handle
exception</font></dt>
<dt><font face="Courier New, Courier, monospace">}</font></dt>
<dt><br>
</dt>
<dt><br>
</dt>
<dt><font face="Courier New, Courier, monospace">//to update a value;</font></dt>
<dt><font face="Courier New, Courier, monospace">try</font></dt>
<dt><font face="Courier New, Courier, monospace">{</font></dt>
<dt><font face="Courier New, Courier, monospace"> map.put("bela",
"geek");</font></dt>
<dt><font face="Courier New, Courier, monospace"> <b>manager.save("bela",
"geek");</b>
// will update { {bela,bela}, {mandar,mandar})</font></dt>
<dt><font face="Courier New, Courier, monospace">
// to { {bela,geek},
{mandar,mandar})</font></dt>
<dt><font face="Courier New, Courier, monospace">}catch (CannotPersistException
cpe)</font></dt>
<dt><font face="Courier New, Courier, monospace">{</font></dt>
<dt><font face="Courier New, Courier, monospace"> //handle
exception</font></dt>
<dt><font face="Courier New, Courier, monospace">}</font></dt>
<dt><br>
</dt>
<dt><br>
</dt>
<dt><font face="Courier New, Courier, monospace">// to remove an entry</font></dt>
<dt><font face="Courier New, Courier, monospace">try</font></dt>
<dt><font face="Courier New, Courier, monospace">{</font></dt>
<dt><font face="Courier New, Courier, monospace"> <b>map.remove("mandar");</b></font></dt>
<dt><font face="Courier New, Courier, monospace"> String
value = (String) <b>manager.remove("mandar");</b>// will update {{bela,geek},
{mandar, mandar}}</font></dt>
<dt><font face="Courier New, Courier, monospace"> //use
value if required
// to {bela,geek}</font></dt>
<dt><font face="Courier New, Courier, monospace">}catch (CannotRemoveException
cre)</font></dt>
<dt><font face="Courier New, Courier, monospace">{</font></dt>
<dt><font face="Courier New, Courier, monospace"> // handle
exception</font></dt>
<dt><font face="Courier New, Courier, monospace">}</font></dt>
<dt><br>
</dt>
<dt><font face="Courier New, Courier, monospace">//**************************************************************************</font></dt>
<dt><br>
</dt>
<dt><font face="Courier New, Courier, monospace">// say, at start of application
, need to get back stored state</font></dt>
<dt><font face="Courier New, Courier, monospace">//use above example to get
back reference to "manager"</font></dt>
<dt><font face="Courier New, Courier, monospace">try</font></dt>
<dt><font face="Courier New, Courier, monospace">{</font></dt>
<dt><font face="Courier New, Courier, monospace"> HashMap
map = (HashMap) <b>manager.retrieveAll();</b> // map will
get {{bela,geek}}</font></dt>
<dt><font face="Courier New, Courier, monospace">}catch (CannotRetrieveException
cree)</font></dt>
<dt><font face="Courier New, Courier, monospace">{</font></dt>
<dt><font face="Courier New, Courier, monospace"> // handle
exception</font></dt>
<dt><font face="Courier New, Courier, monospace">}</font></dt>
<dt><br>
</dt>
<h2>Entering Properties (persist.properties)</h2>
Currently, the properties reflect only the DB related, as the FILE based implementation
is not in place.<br>
<table border="1" cols="3" width="100%" nosave="">
<tbody>
<tr>
<td>Name</td>
<td>Description</td>
<td>Typical Value</td>
</tr>
<tr>
<td>persist</td>
<td>Used to decide between DB or FILE.</td>
<td>DB/FILE (No default assumed)</td>
</tr>
<tr>
<td>jdbc.table</td>
<td>Lets the user dictate the schema used to storage purposes on the
database.</td>
<td>create table replhashmap(key varchar(100), keybin blob, valbin
blob) </td>
</tr>
<tr>
<td>jdbc.Driver</td>
<td>Classname for driver that needs to be loaded for DB storage.</td>
<td>oracle.jdbc.driver.OracleDriver</td>
</tr>
<tr>
<td>jdbc.Conn</td>
<td>Connection string required for user to connect to Db instance</td>
<td>jdbc:oracle:oci8:@instance</td>
</tr>
<tr>
<td>jdbc.User</td>
<td>User name required to connect to provided DB instance</td>
<td>user</td>
</tr>
<tr>
<td>jdbc.Pass</td>
<td>Password wrt to User provided</td>
<td>pass</td>
</tr>
</tbody>
</table>
<dt><br>
</dt>
<dt><br>
</dt>
<dt><br>
</dt>
<h2>Using org.jgroups.blocks.DistributedHashtable with PersistenceManager</h2>
<dt>// Example of how to setup and use DistributedHashtable<br>
</dt>
<ul>
<li>Create persist.properties (classpath or home dir)<br>
</li>
<li>Start one instance with -persist</li>
<li>Start another instance with -persist</li>
<li>Add a couple of values</li>
<li>Delete both instances</li>
<li>Start first instance again: previous values should be available</li>
</ul>
<br>
<dt><br>
</dt>
<dt><br>
</dt>
<dt><br>
</dt>
<br>
</body>
</html>