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
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
|
/*
* Copyright 2006 Phidgets Inc. All rights reserved.
*/
package com.phidgets;
import com.phidgets.event.*;
import java.util.Iterator;
import java.util.LinkedList;
import java.util.Vector;
/**
* This class represents the Phidget Dictionary.
* <p>
* The Phidget Dictionary is a service provided by the Phidget Webservice.
* The Webservice maintains a centralized dictionary of key-value pairs that can be accessed and changed from any number of clients.
* <p>
* Note that the Webservice uses this dictionary to control access to Phidgets through the openRemote and openRemoteIP interfaces,
* and as such, you should never add or modify a key that starts with /PSK/ or /PCK/, unless you want to explicitly modify Phidget
* specific data -- and this is highly discouraged, as it's very easy to break things. Listening to these keys is fine if so desired.
* <p>
* The intended use for the dictionary is as a central repository for communication and persistent storage of data between several
* client applications. As an example - a higher level interface exposed by one application -- which controls the Phidgets, for
* others to access -- rather then every client talking directly to the Phidgets themselves.
* <p>
* The dictionary makes use of extended regular expressions for key matching.
*
* @author Phidgets Inc.
*/
public class Dictionary
{
static
{
try
{
System.loadLibrary("phidget21");
}
catch(UnsatisfiedLinkError ex)
{
String os = System.getProperty("os.name");
if(os.startsWith("Linux"))
{
throw new ExceptionInInitializerError(ex.getMessage()
+"\nCould not locate the Phidget C library (libphidget21.so)."
+"\nMake sure it is installed, and add it's path to LD_LIBRARY_PATH.");
}
else if(os.startsWith("Windows"))
{
throw new ExceptionInInitializerError(ex.getMessage()
+"\nCould not locate the Phidget C library."
+"\nThe Windows Phidget21 MSI must be installed.");
}
else if(os.startsWith("Mac"))
{
throw new ExceptionInInitializerError(ex.getMessage()
+"\nCould not locate the Phidget C library."
+"\nThe Mac Phidget21 DMG must be installed.");
}
else
{
throw new ExceptionInInitializerError(ex.getMessage()
+"\nCould not locate the Phidget C library.");
}
}
}
public long handle = 0;
/**
* The default constructor. Creating a Phidget Dictionary object will initialize the
* dictionary handle internally, but {@link #open(String, int) open} still needs to be called
* to actually work with it.
*/
public Dictionary() throws PhidgetException
{
handle = create();
}
private final native long create() throws PhidgetException;
private final native void nativeClose() throws PhidgetException;
private final native void nativeDelete() throws PhidgetException;
private final native void nativeOpenRemote(String serverID, String pass) throws PhidgetException;
private final native void nativeOpenRemoteIP(String ipAddress, int port, String pass) throws PhidgetException;
private final native void nativeAddKey(String key, String val, int persistent) throws PhidgetException;
private final native void nativeRemoveKey(String keyPattern) throws PhidgetException;
private final native String nativeGetKey(String key) throws PhidgetException;
/**
* Returns the Address of a Phidget Webservice when this Dictionary was opened as remote. This may be an IP Address or a hostname.
*
* @return Server Address
* @throws PhidgetException if this Dictionary was not opened.
*/
public final native String getServerAddress() throws PhidgetException;
/**
* Returns the Server ID of a Phidget Webservice when this Dictionary was opened as remote. This is an arbitrary server identifier,
* independant of IP address and Port.
*
* @return Server ID
* @throws PhidgetException if this Dictionary was not opened.
*/
public final native String getServerID() throws PhidgetException;
/**
* Returns the Port of a Phidget Webservice when this Dictionary was opened as remote.
*
* @return Server Port
* @throws PhidgetException if this Dictionary was not opened.
*/
public final native int getServerPort() throws PhidgetException;
/**
* Returns the attached status of this Dictionary.
*
* @return Status
* @throws PhidgetException If this Dictionary is not opened.
*/
public final native boolean isAttached() throws PhidgetException;
/**
* Returns the network attached status for remotely opened Phidgets. This method returns True or False, depending on whether a connection to the
* Phidget WebService is open - or not. If this is false for a remote Phidget then the connection is not active - either because a connection
* has not yet been established, or because the connection was terminated.
*
* @return Status
* @throws PhidgetException If this Phidget is not opened.
*/
public final native boolean isAttachedToServer() throws PhidgetException;
/**
* Adds a new key to the Dictionary, or modifies the value of an existing key.
* <p>
* The key can only contain numbers, letters, "/", ".", "-", "_", and must begin with a letter, "_" or "/".
* <p>
* The value can contain any value.
* <p>
* The key will stay in the dictionary until explicitly removed.
*
*
*/
public final void add(String key, String val) throws PhidgetException
{
nativeAddKey(key, val, 1);
}
/**
* Adds a new key to the Dictionary, or modifies the value of an existing key.
* <p>
* The key can only contain numbers, letters, "/", ".", "-", "_", and must begin with a letter, "_" or "/".
* <p>
* The value can contain any value.
* <p>
* The persistent value controls whether a key will stay in the dictionary after the client that created it disconnects.
* If persistent == 0, the key is removed when the connection closes. Otherwise the key remains in the dictionary until
* it is explicitly removed.
*
*/
public final void add(String key, String val, boolean persistent) throws PhidgetException
{
if (persistent) nativeAddKey(key, val, 1);
else nativeAddKey(key, val, 0);
}
/**
* Removes a key, or set of keys, from the Dictionary.
* <p>
* The key name is a regular expressions pattern, and so care must be taken to only have it match the specific keys you want to remove.
*/
public final void remove(String pattern) throws PhidgetException
{
nativeRemoveKey(pattern);
}
/**
* Gets the value for a key.
*/
public final String get(String key) throws PhidgetException
{
return nativeGetKey(key);
}
/**
* Open this Dictionary remotely and securely, using an IP Address.
* <p>
* This method is the same as {@link #open(String, int) open(String ipAddress, int port)}, except that it specifies a password.
* This password can be set as a parameter when starting the Phidget Webservice.
*/
public final void open(String ipAddress, int port, String password) throws PhidgetException
{
enableEvents(true);
nativeOpenRemoteIP(ipAddress, port, password);
}
/**
* Open this Dictionary remotely using an IP Address.
* <p>
* This version of open is network based, and relies on the Phidget Webservice running at the specified Address and Port
* before open is called.
* <p>
* @param ipAddress IP Address or hostname of the Phidget Webservice
* @param port Port of the Phidget Webservice
* @throws PhidgetException if the Phidget Webservice cannot be contacted
*/
public final void open(String ipAddress, int port) throws PhidgetException
{
enableEvents(true);
nativeOpenRemoteIP(ipAddress, port, "");
}
/**
* Open this Dictionary remotely and securely, using a Server ID.
* <p>
* This method is the same as {@link #open(String) open(String serverID)}, except that it specifies a password.
* This password can be set as a parameter when starting the Phidget Webservice.
*/
public final void open(String serverID, String password) throws PhidgetException
{
enableEvents(true);
nativeOpenRemote(serverID, password);
}
/**
* Open this Dictionary remotely using a Server ID.
* <p>
* This version of open is network based.
*
* @param serverID ServerID of the Phidget Webservice
*/
public final void open(String serverID) throws PhidgetException
{
enableEvents(true);
nativeOpenRemote(serverID, "");
}
/**
* Closes this Dictionary.
* This will shut down all threads dealing with this Dictionary and you won't recieve any more events.
*
* @throws PhidgetException If this Dictionary is not opened.
*/
public final void close() throws PhidgetException
{
enableEvents(false);
nativeClose();
}
private void enableEvents(boolean b)
{
enableServerConnectEvents(b && serverConnectListeners.size() > 0);
enableServerDisconnectEvents(b && serverDisconnectListeners.size() > 0);
}
private LinkedList serverConnectListeners = new LinkedList();
private long nativeServerConnectHandler = 0;
/**
* Adds an serverConnect listener. The serverConnect handler is a method that will be called when a connection to a server is made
* <p>
* There is no limit on the number of serverConnect handlers that can be registered for a particular Manager.
*
* @param l An implemetation of the {@link com.phidgets.event.ServerConnectListener ServerConnectListener} interface
*/
public final void addServerConnectListener(ServerConnectListener l)
{
synchronized (serverConnectListeners)
{
serverConnectListeners.add(l);
enableServerConnectEvents(true);
}
}
/**
* Removes an serverConnect listener. This will remove a previously added serverConnect listener.
*/
public final void removeServerConnectListener(ServerConnectListener l)
{
synchronized (serverConnectListeners)
{
serverConnectListeners.remove(l);
enableServerConnectEvents(serverConnectListeners.size() > 0);
}
}
private void fireServerConnect(ServerConnectEvent e)
{
synchronized (serverConnectListeners)
{
for (Iterator it = serverConnectListeners.iterator();
it.hasNext(); )
((ServerConnectListener)it.next()).serverConnected(e);
}
}
private native void enableServerConnectEvents(boolean b);
private LinkedList serverDisconnectListeners = new LinkedList();
private long nativeServerDisconnectHandler = 0;
/**
* Adds an serverDisconnect listener. The serverDisconnect handler is a method that will be called when a connection to a server is terminated.
* <p>
* There is no limit on the number of serverDisconnect handlers that can be registered for a particular Manager.
*
* @param l An implemetation of the {@link com.phidgets.event.ServerDisconnectListener ServerDisconnectListener} interface
*/
public final void addServerDisconnectListener(ServerDisconnectListener l)
{
synchronized (serverDisconnectListeners)
{
serverDisconnectListeners.add(l);
enableServerDisconnectEvents(true);
}
}
/**
* Removes an serverDisconnect listener. This will remove a previously added serverDisconnect listener.
*/
public final void removeServerDisconnectListener(ServerDisconnectListener l)
{
synchronized (serverDisconnectListeners)
{
serverDisconnectListeners.remove(l);
enableServerDisconnectEvents(serverDisconnectListeners.size() > 0);
}
}
private void fireServerDisconnect(ServerDisconnectEvent e)
{
synchronized (serverDisconnectListeners)
{
for (Iterator it = serverDisconnectListeners.iterator();
it.hasNext(); )
((ServerDisconnectListener)it.next()).serverDisconnected(e);
}
}
private native void enableServerDisconnectEvents(boolean b);
/**
* Return a Sring describing this dictionary.
*/
public String toString()
{
return "PhidgetDictionary: ";
}
protected void finalize() {
try
{
close();
nativeDelete();
handle = 0;
} catch (Exception e) {
;
}
}
}
|