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
|
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2008 by Sun Microsystems, Inc.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* $RCSfile: checkdispatchapi.java,v $
* $Revision: 1.5 $
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org 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 version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
package complex.dispatches;
import com.sun.star.frame.*;
import com.sun.star.lang.*;
import com.sun.star.util.*;
import com.sun.star.beans.*;
import com.sun.star.uno.*;
import java.util.*;
import complexlib.ComplexTestCase;
import helper.*;
//-----------------------------------------------
/** @short Check the interface XDispatchInformationProvider
@descr Because there exists more then one implementation of a dispatch
object, we have to test all these implementations ...
*/
public class checkdispatchapi extends ComplexTestCase
{
//-------------------------------------------
// some const
//-------------------------------------------
// member
/** points to the global uno service manager. */
private XMultiServiceFactory m_xMSF = null;
private connectivity.tools.HsqlDatabase db;
/** can be used to create new test frames. */
private XFrame m_xDesktop = null;
/** provides XDispatchInformationProvider interface. */
private XFrame m_xFrame = null;
//-------------------------------------------
// test environment
//-------------------------------------------
/** @short A function to tell the framework,
which test functions are available.
@return All test methods.
@todo Think about selection of tests from outside ...
*/
public String[] getTestMethodNames()
{
return new String[]
{
"checkDispatchInfoOfWriter",
"checkDispatchInfoOfCalc",
"checkDispatchInfoOfDraw",
"checkDispatchInfoOfImpress",
"checkDispatchInfoOfMath",
"checkDispatchInfoOfChart",
"checkDispatchInfoOfBibliography",
"checkDispatchInfoOfQueryDesign",
"checkDispatchInfoOfTableDesign",
"checkDispatchInfoOfFormGridView",
"checkDispatchInfoOfDataSourceBrowser",
"checkDispatchInfoOfRelationDesign",
"checkDispatchInfoOfBasic",
"checkDispatchInfoOfStartModule",
"checkInterceptorLifeTime",
"checkInterception"
};
}
//-------------------------------------------
/** @short Create the environment for following tests.
@descr create an empty test frame, where we can load
different components inside.
*/
public void before()
{
try
{
// get uno service manager from global test environment
m_xMSF = (XMultiServiceFactory)param.getMSF();
db = new connectivity.tools.HsqlDatabase(m_xMSF);
// create desktop
m_xDesktop = (XFrame)UnoRuntime.queryInterface(
XFrame.class,
m_xMSF.createInstance("com.sun.star.frame.Desktop"));
m_xFrame = impl_createNewFrame();
}
catch(java.lang.Throwable ex)
{
failed("Cant initialize test environment.");
}
}
//-------------------------------------------
/** @short close the environment.
*/
public void after()
{
db.close();
impl_closeFrame(m_xFrame);
m_xFrame = null;
}
//-------------------------------------------
public void checkDispatchInfoOfWriter()
{
impl_checkDispatchInfoOfXXX("private:factory/swriter");
}
//-------------------------------------------
public void checkDispatchInfoOfCalc()
{
impl_checkDispatchInfoOfXXX("private:factory/scalc");
}
//-------------------------------------------
public void checkDispatchInfoOfDraw()
{
impl_checkDispatchInfoOfXXX("private:factory/sdraw");
}
//-------------------------------------------
public void checkDispatchInfoOfImpress()
{
impl_checkDispatchInfoOfXXX("private:factory/simpress");
}
//-------------------------------------------
public void checkDispatchInfoOfChart()
{
impl_checkDispatchInfoOfXXX("private:factory/schart");
}
//-------------------------------------------
public void checkDispatchInfoOfMath()
{
impl_checkDispatchInfoOfXXX("private:factory/smath");
}
//-------------------------------------------
public void checkDispatchInfoOfDataBase()
{
impl_checkDispatchInfoOfXXX("private:factory/sdatabase");
}
//-------------------------------------------
public void checkDispatchInfoOfBibliography()
{
impl_checkDispatchInfoOfXXX(".component:Bibliography/View1");
}
//-------------------------------------------
public void checkDispatchInfoOfQueryDesign()
{
callDatabaseDispatch(".component:DB/QueryDesign");
}
//-------------------------------------------
public void checkDispatchInfoOfTableDesign()
{
callDatabaseDispatch(".component:DB/TableDesign");
}
//-------------------------------------------
public void checkDispatchInfoOfFormGridView()
{
impl_checkDispatchInfoOfXXX(".component:DB/FormGridView");
}
//-------------------------------------------
public void checkDispatchInfoOfDataSourceBrowser()
{
impl_checkDispatchInfoOfXXX(".component:DB/DataSourceBrowser");
}
//-------------------------------------------
public void checkDispatchInfoOfRelationDesign()
{
callDatabaseDispatch(".component:DB/RelationDesign");
}
//-------------------------------------------
private void callDatabaseDispatch(String url)
{
try
{
final PropertyValue args = new PropertyValue();
args.Name = "ActiveConnection";
args.Value = (Object)db.defaultConnection();
XFrame xFrame = impl_createNewFrame();
impl_loadIntoFrame(xFrame, url, new PropertyValue[] { args });
impl_checkDispatchInfo(xFrame);
impl_closeFrame(xFrame);
} catch(java.lang.Exception e ) {
}
}
//-------------------------------------------
public void checkDispatchInfoOfBasic()
{
Object aComponent = impl_createUNOComponent("com.sun.star.script.BasicIDE");
impl_checkDispatchInfo(aComponent);
}
//-------------------------------------------
public void checkDispatchInfoOfStartModule()
{
Object aComponent = impl_createUNOComponent("com.sun.star.frame.StartModule");
impl_checkDispatchInfo(aComponent);
}
//-------------------------------------------
public void checkInterceptorLifeTime()
{
// Note: It's important for the following test, that aInterceptor will be hold alive by the uno reference
// xInterceptor. Otherwhise we cant check some internal states of aInterceptor at the end of this method, because
// it was already killed .-)
Interceptor aInterceptor = new Interceptor(log);
com.sun.star.frame.XDispatchProviderInterceptor xInterceptor = (com.sun.star.frame.XDispatchProviderInterceptor)UnoRuntime.queryInterface(
com.sun.star.frame.XDispatchProviderInterceptor.class,
aInterceptor);
com.sun.star.frame.XFrame xFrame = impl_createNewFrame();
com.sun.star.frame.XDispatchProviderInterception xInterception = (com.sun.star.frame.XDispatchProviderInterception)UnoRuntime.queryInterface(
com.sun.star.frame.XDispatchProviderInterception.class,
xFrame);
xInterception.registerDispatchProviderInterceptor(xInterceptor);
impl_closeFrame(xFrame);
int nRegCount = aInterceptor.getRegistrationCount();
boolean bIsRegistered = aInterceptor.isRegistered();
log.println("registration count = "+nRegCount );
log.println("is registered ? = "+bIsRegistered);
if (nRegCount < 1)
failed("Interceptor was never registered.");
if (bIsRegistered)
failed("Interceptor was not deregistered automaticly on closing the corresponding frame.");
log.println("Destruction of interception chain works as designed .-)");
}
//-------------------------------------------
public void checkInterception()
{
String [] lDisabledURLs = new String [1];
lDisabledURLs[0] = ".uno:Open";
log.println("create and initialize interceptor ...");
Interceptor aInterceptor = new Interceptor(log);
aInterceptor.setURLs4URLs4Blocking(lDisabledURLs);
com.sun.star.frame.XDispatchProviderInterceptor xInterceptor = (com.sun.star.frame.XDispatchProviderInterceptor)UnoRuntime.queryInterface(
com.sun.star.frame.XDispatchProviderInterceptor.class,
aInterceptor);
log.println("create and initialize frame ...");
com.sun.star.frame.XFrame xFrame = impl_createNewFrame();
impl_loadIntoFrame(xFrame, "private:factory/swriter", null);
com.sun.star.frame.XDispatchProviderInterception xInterception = (com.sun.star.frame.XDispatchProviderInterception)UnoRuntime.queryInterface(
com.sun.star.frame.XDispatchProviderInterception.class,
xFrame);
log.println("register interceptor ...");
xInterception.registerDispatchProviderInterceptor(xInterceptor);
log.println("deregister interceptor ...");
xInterception.releaseDispatchProviderInterceptor(xInterceptor);
}
//-------------------------------------------
private void impl_checkDispatchInfoOfXXX(String sXXX)
{
XFrame xFrame = impl_createNewFrame();
impl_loadIntoFrame(xFrame, sXXX,null);
impl_checkDispatchInfo(xFrame);
impl_closeFrame(xFrame);
}
//-------------------------------------------
/** @short load an URL into the current test frame.
*/
private void impl_loadIntoFrame(XFrame xFrame, String sURL,PropertyValue args[])
{
XComponentLoader xLoader = (XComponentLoader)UnoRuntime.queryInterface(
XComponentLoader.class,
xFrame);
if (xLoader == null)
failed("Frame does not provide required interface XComponentLoader.");
XComponent xDoc = null;
try
{
xDoc = xLoader.loadComponentFromURL(sURL, "_self", 0, args);
}
catch(java.lang.Throwable ex)
{
xDoc = null;
}
if (xDoc == null)
failed("Could not load \""+sURL+"\".");
}
//-------------------------------------------
/** @short create an uno implementation directly.
*/
private Object impl_createUNOComponent(String sName)
{
Object aComponent = null;
try
{
aComponent = m_xMSF.createInstance(sName);
}
catch(java.lang.Throwable ex)
{
aComponent = null;
}
if (aComponent == null)
failed("Could not create UNO component \""+sName+"\".");
return aComponent;
}
//-------------------------------------------
/** @short check the interface XDispatchInformationProvider
at the specified component.
*/
private void impl_checkDispatchInfo(Object aComponent)
{
XDispatchInformationProvider xInfoProvider = (XDispatchInformationProvider)UnoRuntime.queryInterface(
XDispatchInformationProvider.class,
aComponent);
if (xInfoProvider == null)
{
// Warning
log.println("Warning:\tComponent does not provide the [optional!] interface XDispatchInformationProvider.");
return;
}
try
{
short[] lGroups = xInfoProvider.getSupportedCommandGroups();
int c1 = lGroups.length;
int i1 = 0;
for (i1=0; i1<c1; ++i1)
{
short nGroup = lGroups[i1];
DispatchInformation[] lInfos = xInfoProvider.getConfigurableDispatchInformation(nGroup);
int c2 = lInfos.length;
int i2 = 0;
// check for empty lists
// Warning
if (lInfos.length < 1)
log.println("Warning:\tCould not get any DispatchInformation for group ["+nGroup+"].");
// check for duplicates (and by the way, if the info item match the requested group)
HashMap aCheckMap = new HashMap(c2);
for (i2=0; i2<c2; ++i2)
{
DispatchInformation aInfo = lInfos[i2];
if (aInfo.GroupId != nGroup)
{
// Error
failed("At least one DispatchInformation item does not match the requested group.\n\trequested group=["+nGroup+
"] returned groupd=["+aInfo.GroupId+"] command=\""+aInfo.Command+"\"", true); // true => dont break this test
continue;
}
if (aCheckMap.containsKey(aInfo.Command))
{
// Error
failed("Found a duplicate item: group=["+aInfo.GroupId+"] command=\""+aInfo.Command+"\"", true); // true => dont break this test
continue;
}
aCheckMap.put(aInfo.Command, aInfo.Command);
log.println("\t["+aInfo.GroupId+"] \""+aInfo.Command+"\"");
}
}
}
catch(java.lang.Throwable ex)
{
failed("Exception caught during using XDispatchInformationProvider.");
ex.printStackTrace();
}
}
//-------------------------------------------
private synchronized com.sun.star.frame.XFrame impl_createNewFrame()
{
com.sun.star.frame.XFrame xFrame = null;
try
{
xFrame = m_xDesktop.findFrame("_blank", 0);
xFrame.getContainerWindow().setVisible(true);
}
catch(java.lang.Throwable ex)
{
failed("Could not create the frame instance.");
}
return xFrame;
}
//-------------------------------------------
private synchronized void impl_closeFrame(com.sun.star.frame.XFrame xFrame)
{
com.sun.star.util.XCloseable xClose = (com.sun.star.util.XCloseable)UnoRuntime.queryInterface(
com.sun.star.util.XCloseable.class,
xFrame);
try
{
xClose.close(false);
}
catch(com.sun.star.util.CloseVetoException exVeto)
{
failed("Test frame couldn't be closed successfully.");
}
}
}
|