Repository navigation
Expand file tree
/
Copy pathTMLCmd.java
More file actions
576 lines (532 loc) · 16.6 KB
/
Copy pathTMLCmd.java
File metadata and controls
576 lines (532 loc) · 16.6 KB
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
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
/*
* libTML: A BEEP based Messaging Suite
* Copyright (C) 2015 wobe-systems GmbH
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public License
* as published by the Free Software Foundation; either version 2.1
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this program; if not, write to the Free
* Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
* 02111-1307 USA
*
* You may find a copy of the license under this software is released
* at COPYING file. This is LGPL software: you are welcome to develop
* proprietary applications using this library without any royalty or
* fee but returning back any change, improvement or addition in the
* form of source code, project image, documentation patches, etc.
*
* Homepage:
* http://www.libtml.org
*
* For professional support contact us:
*
* wobe-systems GmbH
*/
package com.tmlsidex.tml;
import java.text.DateFormat;
import java.text.ParseException;
import java.text.SimpleDateFormat;
import java.util.Date;
import com.tmlsidex.jni.SidexErr;
import com.tmlsidex.jni.Tml;
import com.tmlsidex.jni.TmlJniCmdProgressReplyIF;
import com.tmlsidex.jni.TmlJniCmdStatusReplyIF;
import com.tmlsidex.jni.TmlJniCmdReadyIF;
import com.tmlsidex.jni.TmlSidexException;
import com.tmlsidex.sidex.SDXDocument;
/**
* @ingroup tmlClasses
* @brief The TMLCmd object provides an interface to a TML command and its data.
*/
public class TMLCmd extends Object implements TmlJniCmdProgressReplyIF,
TmlJniCmdStatusReplyIF,
TmlJniCmdReadyIF
{
// Member
long m_var = 0;
Tml m_tml = null;
boolean m_bThisOwn = false;
/**
* @brief command progress handler implementation
*
* The handler implements the low level interface and calls the
* the high level handler method.
*
* @see TMLCmdProgressReplyIF
*/
@Override
public void jniCmdProgressReplyCB(long cmdHandle, Object cbData, int progress) {
Object[] objArr = (Object[]) cbData;
if (null != objArr[0]){
((TMLCmdProgressReplyIF) objArr[0]).cmdProgressReplyCB(this, objArr[1], progress);
}
}
/**
* @brief command status reply handler implementation
*
* The handler implements the low level interface and calls the
* the high level handler method.
*
* @see com.tmlsidex.tml.TMLCmdStatusReplyIF
*/
@Override
public void jniCmdStatusReplyCB(long cmdHandle, Object cbData, int type, String msg) {
Object[] objArr = (Object[]) cbData;
if (null != objArr[0]){
((TMLCmdStatusReplyIF) objArr[0]).cmdStatusReplyCB(this, objArr[1], type, msg);
}
}
/**
* @brief command ready handler implementation
*
* The handler implements the low level interface and calls the
* the high level handler method.
*
* @see com.tmlsidex.tml.TMLCmdReadyIF
*/
@Override
public void jniCmdReadyCB(long cmdHandle, Object cbData) {
Object[] objArr = (Object[]) cbData;
if (null != objArr[0]){
((TMLCmdReadyIF) objArr[0]).cmdReadyCB(this, objArr[1]);
}
}
/**
* @brief constructor of TMLCmd
*
* @param iCmdID command id
*
* @throws TmlSidexException
*/
public TMLCmd(int iCmdID) throws TmlSidexException{
m_tml = new Tml();
m_bThisOwn = true;
m_var = m_tml.tml_Cmd_Create();
m_tml.tml_Cmd_Header_SetCommand(m_var, iCmdID);
}
/**
* @brief constructor of TMLCmd
*
* @param iCmdID command id
* @param cbInstance instance of an implementation of the callback method interface / all TMLCmd callback registrations will be done for the instance
* @param pCBData custom data or null for the callback registrations
*
* @throws TmlSidexException
* @see TMLCmd#registerCmdReady(TMLCmdReadyIF, Object)
* @see TMLCmd#registerCmdProgressReply(TMLCmdProgressReplyIF, Object)
* @see TMLCmd#registerCmdStatusReply(TMLCmdStatusReplyIF, Object)
*/
public TMLCmd(int iCmdID, TMLCmdIF cbInstance, Object pCBData) throws TmlSidexException{
m_tml = new Tml();
m_bThisOwn = true;
m_var = m_tml.tml_Cmd_Create();
m_tml.tml_Cmd_Header_SetCommand(m_var, iCmdID);
registerCmdReady(cbInstance, pCBData);
registerCmdProgressReply(cbInstance, pCBData);
registerCmdStatusReply(cbInstance, pCBData);
}
/**
* @brief constructor of TMLCmd
*
* @param vHandle handle of a TML command variant
* @param thisown instance is owner of the TML command handle
*
* @throws TmlSidexException
*/
public TMLCmd(long vHandle, boolean thisown) throws TmlSidexException{
m_tml = new Tml();
m_bThisOwn = thisown;
m_var = vHandle;
}
/**
* @brief destructor of TMLCmd
*/
protected void finalize() throws Throwable {
// Internal destructrion:
if (m_bThisOwn && 0 != m_var){
m_tml.tml_Cmd_Free(m_var);
m_var = 0;
}
m_tml = null;
m_var = 0;
super.finalize();
}
/**
* @brief get low level command handle
*
* @return TML command variant
*/
public long getVHandle(){
return m_var;
}
/**
* @brief set command id
*
* @param cmdID command id
*
* @throws TmlSidexException
*/
public void setCmdID(int cmdID) throws TmlSidexException{
m_tml.tml_Cmd_Header_SetCommand(m_var, cmdID);
}
/**
* @brief get the command id
*
* @return command id
*
* @throws TmlSidexException
*/
public int getCmdID() throws TmlSidexException{
return m_tml.tml_Cmd_Header_GetCommand(m_var);
}
/**
* @brief get command creation time
*
* @return command creation time
*
* @throws TmlSidexException
*/
public Date getCreationTime() throws TmlSidexException{
Date currentParsed = null;
String sDate = m_tml.tml_Cmd_Header_GetCreationTime(m_var); DateFormat df = null;
try {
df = new SimpleDateFormat("yyyyMMddHHmmssSSS");
currentParsed = df.parse(sDate);
} catch (ParseException e) {
df = null;
e.printStackTrace();
TmlSidexException tmlExcept = new TmlSidexException("TMLCmd::getCreationTime / parsing error", SidexErr.SIDEX_ERR_INVALID_DATETIME);
throw tmlExcept;
}
df = null;
return currentParsed;
}
/**
* @brief set error code
*
* If a custom error code is set while command processing it
* will not be overwritten by TML specific standard error codes.
*
* @param error command execution error code
*
* @throws TmlSidexException
*/
public void setError(int error) throws TmlSidexException{
m_tml.tml_Cmd_Header_SetError(m_var, error);
}
/**
* @brief get error code
*
* There are a number of predefined error codes that are set automatically.
* Besides that a custom error code can be set while processing a command to inform
* the caller about implementation specific problems.
*
* @return command execution error code
*
* @throws TmlSidexException
*/
public int getError() throws TmlSidexException{
return m_tml.tml_Cmd_Header_GetError(m_var);
}
/**
* @brief set error message
*
* If a custom error message is set while command processing
* it will not be overwritten by TML specific standard error messages.
*
* @param msg command execution error message
*
* @throws TmlSidexException
*/
public void setErrorMessage(String msg) throws TmlSidexException{
m_tml.tml_Cmd_Header_SetErrorMessage(m_var, msg);
}
/**
* @brief get error message
*
* @return command execution error message
*
* @throws TmlSidexException
*/
public String getErrorMessage() throws TmlSidexException{
return m_tml.tml_Cmd_Header_GetErrorMessage(m_var);
}
/**
* @brief get execution mode
*
* @return execution mode
*
* @throws TmlSidexException
* @see Tml#tml_Cmd_Header_GetMode(long)
*/
public int getMode() throws TmlSidexException{
return m_tml.tml_Cmd_Header_GetMode(m_var);
}
/**
* @brief set progress
*
* @param progress progress value (0-100)
*
* @throws TmlSidexException
*/
public void setProgress(int progress) throws TmlSidexException{
m_tml.tml_Cmd_Header_SetProgress(m_var, progress);
}
/**
* @brief get progress
*
* If a progress reply is received, the command execution state is
* TMLCOM_CSTATE_PENDING and the reply type is TMLCOM_RPY_PROGRESS.
* In that case a progress is valid. Progress is also valid if
* a progress was explicitly set.
*
* @return command execution progress (in percent).
*
* @throws TmlSidexException
*/
public int getProgress() throws TmlSidexException{
return m_tml.tml_Cmd_Header_GetProgress(m_var);
}
/**
* @brief get status reply message
*
* If a status reply is received, the command execution state is
* TMLCOM_CSTATE_PENDING and the reply type is TMLCOM_RPY_WARNING,
* TMLCOM_RPY_ERROR or TMLCOM_RPY_INFORMATION.
* In that case a reply message is valid. A reply message is also
* valid if a reply message was explicitly set.
*
* @return reply message.
*
* @throws TmlSidexException
*/
public String getReplyMessage() throws TmlSidexException{
return m_tml.tml_Cmd_Header_GetReplyMessage(m_var);
}
/**
* @brief get reply type
*
* If a progress or status reply is received, the command execution state is
* TMLCOM_CSTATE_PENDING. In that case the reply type can be used to
* determine the kind of reply.
*
* @return reply type
*
* @throws TmlSidexException
* @see Tml#tml_Cmd_Header_GetReplyType(long)
*/
public int getReplyType() throws TmlSidexException{
return m_tml.tml_Cmd_Header_GetReplyType(m_var);
}
/**
* @brief get execution state
*
* @return execution state
*
* @throws TmlSidexException
* @see Tml#tml_Cmd_Header_GetState(long)
*/
public int getState() throws TmlSidexException{
return m_tml.tml_Cmd_Header_GetState(m_var);
}
/**
* @brief acquire command data (SDXDocument)
*
* @note This is a lock mechanism to protect the message data from changes by
* other threads while accessed. If the call to TMLCmd#releaseData() is missing,
* a deadlock situation may be the result.
*
* @return SDXDocument
*
* @throws TmlSidexException
* @see TMLCmd#releaseData()
*/
public SDXDocument acquireData() throws TmlSidexException{
long sHandle = m_tml.tml_Cmd_Acquire_Sidex_Handle(m_var);
SDXDocument doc = new SDXDocument(sHandle, false);
return doc;
}
/**
* @brief release command data
*
* @throws TmlSidexException
* @see TMLCmd#acquireData()
*/
public void releaseData() throws TmlSidexException{
m_tml.tml_Cmd_Release_Sidex_Handle(m_var);
}
/**
* @brief send status reply
*
* @param rType status reply type
*
* @param rMsg status reply message
*
* @throws TmlSidexException
* @see Tml#tml_Send_AsyncStatusReply(long , int , String)
*/
public void sendStatusReply(int rType, String rMsg) throws TmlSidexException{
m_tml.tml_Send_AsyncStatusReply(m_var, rType, rMsg);
}
/**
* @brief send progress reply
*
* @param progress progress value (0-100)
*
* @throws TmlSidexException
*/
public void sendProgressReply(int progress) throws TmlSidexException{
m_tml.tml_Send_AsyncProgressReply(m_var, progress);
}
/**
* @brief register command ready handler
*
* The result of a command is passed to a command ready handler. In case of asynchronous commands
* this is the only way to process the reply.
*
* @param cbInstance instance of an implementation of the callback method interface / set null for deregistration
* @param pCBData custom data or null
*
* @throws TmlSidexException
* @see TMLCmdReadyIF
*/
public void registerCmdReady(TMLCmdReadyIF cbInstance, Object pCBData) throws TmlSidexException {
if (null != cbInstance){
Object[] objArr = new Object[2];
objArr[0] = cbInstance;
objArr[1] = pCBData;
m_tml.tml_Cmd_Register_CommandReady(m_var, this, objArr);
}
else{
m_tml.tml_Cmd_Register_CommandReady(m_var, null, null);
}
}
/**
* @brief register progress reply handler
*
* The progress reply handler is called if a progress reply was received.
*
* @param cbInstance instance of an implementation of the callback method interface / set null for deregistration
* @param pCBData custom data or null
*
* @throws TmlSidexException
* @see TMLCmdProgressReplyIF
*/
public void registerCmdProgressReply(TMLCmdProgressReplyIF cbInstance, Object pCBData) throws TmlSidexException {
if (null != cbInstance){
Object[] objArr = new Object[2];
objArr[0] = cbInstance;
objArr[1] = pCBData;
m_tml.tml_Cmd_Register_Progress(m_var, this, objArr);
}
else{
m_tml.tml_Cmd_Register_Progress(m_var, null, null);
}
}
/**
* @brief register status reply handler
*
* The status reply handler is called if a status reply was received.
*
* @param cbInstance instance of an implementation of the callback method interface / set null for deregistration
* @param pCBData custom data or null
*
* @throws TmlSidexException
* @see TMLCmdStatusReplyIF
*/
public void registerCmdStatusReply(TMLCmdStatusReplyIF cbInstance, Object pCBData) throws TmlSidexException {
if (null != cbInstance){
Object[] objArr = new Object[2];
objArr[0] = cbInstance;
objArr[1] = pCBData;
m_tml.tml_Cmd_Register_StatusReply(m_var, this, objArr);
}
else{
m_tml.tml_Cmd_Register_StatusReply(m_var, null, null);
}
}
/**
* @brief get registered command ready handler and custom data
*
* @param cbInstance array of size 1 containing command ready handler
* @param pCBData array of size 1 - returns custom data
*
* @throws TmlSidexException
* @see TMLCmdReadyIF
*/
public void registeredCmdReady(TMLCmdReadyIF[] cbInstance, Object[] pCBData) throws TmlSidexException {
Object[] objArrInstance = new Object[2];
Object[] objArrData = new Object[2];
m_tml.tml_Cmd_Registered_CommandReady(m_var, objArrInstance, objArrData);
if (null != objArrInstance[0]){
Object[] objArr = (Object[]) objArrData[0];
cbInstance[0] = (TMLCmdReadyIF)objArr[0];
pCBData[0] = objArr[1];
}
else{
cbInstance[0] = null;
pCBData[0] = null;
}
objArrInstance = null;
objArrData = null;
}
/**
* @brief get registered progress reply handler and custom data
*
* @param cbInstance array of size 1 containing progress reply handler
* @param pCBData array of size 1 - returns custom data
*
* @throws TmlSidexException
* @see TMLCmdProgressReplyIF
*/
public void registeredCmdProgressReply(TMLCmdProgressReplyIF[] cbInstance, Object[] pCBData) throws TmlSidexException{
Object[] objArrInstance = new Object[2];
Object[] objArrData = new Object[2];
m_tml.tml_Cmd_Registered_Progress(m_var, objArrInstance, objArrData);
if (null != objArrInstance[0]){
Object[] objArr = (Object[]) objArrData[0];
cbInstance[0] = (TMLCmdProgressReplyIF)objArr[0];
pCBData[0] = objArr[1];
}
else{
cbInstance[0] = null;
pCBData[0] = null;
}
objArrInstance = null;
objArrData = null;
}
/**
* @brief get registered status reply handler and custom data
*
* @param cbInstance array of size 1 containing status reply handler
* @param pCBData array of size 1 - returns custom data
*
* @throws TmlSidexException
* @see TMLCmdStatusReplyIF
*/
public void registeredCmdStatusReply(TMLCmdStatusReplyIF[] cbInstance, Object[] pCBData) throws TmlSidexException{
Object[] objArrInstance = new Object[2];
Object[] objArrData = new Object[2];
m_tml.tml_Cmd_Registered_StatusReply(m_var, objArrInstance, objArrData);
if (null != objArrInstance[0]){
Object[] objArr = (Object[]) objArrData[0];
cbInstance[0] = (TMLCmdStatusReplyIF)objArr[0];
pCBData[0] = objArr[1];
}
else{
cbInstance[0] = null;
pCBData[0] = null;
}
objArrInstance = null;
objArrData = null;
}
}