-
Notifications
You must be signed in to change notification settings - Fork 642
Expand file tree
/
Copy pathPluginInterface.java
More file actions
643 lines (547 loc) · 29.3 KB
/
PluginInterface.java
File metadata and controls
643 lines (547 loc) · 29.3 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
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
package org.bimserver.shared.interfaces;
/******************************************************************************
* Copyright (C) 2009-2019 BIMserver.org
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 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 Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see {@literal<http://www.gnu.org/licenses/>}.
*****************************************************************************/
import java.util.List;
import java.util.Set;
import javax.activation.DataHandler;
import javax.jws.WebMethod;
import javax.jws.WebParam;
import javax.jws.WebService;
import javax.jws.soap.SOAPBinding;
import javax.jws.soap.SOAPBinding.ParameterStyle;
import javax.jws.soap.SOAPBinding.Style;
import javax.jws.soap.SOAPBinding.Use;
import javax.xml.bind.annotation.XmlMimeType;
import org.bimserver.interfaces.objects.SDeserializerPluginConfiguration;
import org.bimserver.interfaces.objects.SInternalServicePluginConfiguration;
import org.bimserver.interfaces.objects.SModelComparePluginConfiguration;
import org.bimserver.interfaces.objects.SModelMergerPluginConfiguration;
import org.bimserver.interfaces.objects.SObjectDefinition;
import org.bimserver.interfaces.objects.SObjectType;
import org.bimserver.interfaces.objects.SPluginBundle;
import org.bimserver.interfaces.objects.SPluginBundleVersion;
import org.bimserver.interfaces.objects.SPluginDescriptor;
import org.bimserver.interfaces.objects.SPluginInformation;
import org.bimserver.interfaces.objects.SQueryEnginePluginConfiguration;
import org.bimserver.interfaces.objects.SRenderEnginePluginConfiguration;
import org.bimserver.interfaces.objects.SSerializerPluginConfiguration;
import org.bimserver.interfaces.objects.SWebModulePluginConfiguration;
import org.bimserver.shared.exceptions.ServerException;
import org.bimserver.shared.exceptions.UserException;
@WebService(name = "PluginInterface", targetNamespace="org.bimserver")
@SOAPBinding(style = Style.DOCUMENT, use = Use.LITERAL, parameterStyle = ParameterStyle.WRAPPED)
public interface PluginInterface extends PublicInterface {
@WebMethod(action="getDefaultWebModule")
SWebModulePluginConfiguration getDefaultWebModule() throws ServerException, UserException;
@WebMethod(action="getDefaultRenderEngine")
SRenderEnginePluginConfiguration getDefaultRenderEngine() throws ServerException, UserException;
@WebMethod(action="getDefaultQueryEngine")
SQueryEnginePluginConfiguration getDefaultQueryEngine() throws ServerException, UserException;
@WebMethod(action="getDefaultModelCompare")
SModelComparePluginConfiguration getDefaultModelCompare() throws ServerException, UserException;
@WebMethod(action="getDefaultModelMerger")
SModelMergerPluginConfiguration getDefaultModelMerger() throws ServerException, UserException;
@WebMethod(action="getDefaultSerializer")
SSerializerPluginConfiguration getDefaultSerializer() throws ServerException, UserException;
@WebMethod(action="setDefaultRenderEngine")
void setDefaultRenderEngine(
@WebParam(name = "oid", partName = "setDefaultRenderEngine.oid") Long oid) throws UserException, ServerException;
/**
* @param onlyEnabled Whether to only include enabled serializers
* @return A list of Serializers
* @throws ServerException, UserException
*/
@WebMethod(action = "getAllSerializersForRoids")
List<SSerializerPluginConfiguration> getAllSerializersForRoids(
@WebParam(name = "onlyEnabled", partName = "getAllSerializersForRoids.onlyEnabled") Boolean onlyEnabled,
@WebParam(name = "roids", partName = "getAllSerializersForRoids.roids") Set<Long> roids) throws ServerException, UserException;
@WebMethod(action = "getAllSerializersForPoids")
List<SSerializerPluginConfiguration> getAllSerializersForPoids(
@WebParam(name = "onlyEnabled", partName = "getAllSerializersForPoids.onlyEnabled") Boolean onlyEnabled,
@WebParam(name = "poids", partName = "getAllSerializersForPoids.poids") Set<Long> poids) throws ServerException, UserException;
@WebMethod(action="setDefaultWebModule")
void setDefaultWebModule(
@WebParam(name = "oid", partName = "setDefaultWebModule.oid") Long oid) throws UserException, ServerException;
@WebMethod(action="setDefaultQueryEngine")
void setDefaultQueryEngine(
@WebParam(name = "oid", partName = "setDefaultQueryEngine.oid") Long oid) throws UserException, ServerException;
@WebMethod(action="setDefaultModelCompare")
void setDefaultModelCompare(
@WebParam(name = "oid", partName = "setDefaultModelCompare.oid") Long oid) throws UserException, ServerException;
@WebMethod(action="setDefaultModelMerger")
void setDefaultModelMerger(
@WebParam(name = "oid", partName = "setDefaultModelMerger.oid") Long oid) throws UserException, ServerException;
@WebMethod(action="setDefaultSerializer")
void setDefaultSerializer(
@WebParam(name = "oid", partName = "setDefaultSerializer.oid") Long oid) throws UserException, ServerException;
/**
* @return List of all SerializerPluginDescriptors
* @throws ServerException, UserException
*/
@WebMethod(action = "getAllSerializerPluginDescriptors")
List<SPluginDescriptor> getAllSerializerPluginDescriptors() throws ServerException, UserException;
@WebMethod(action = "getPluginDescriptor")
SPluginDescriptor getPluginDescriptor(
@WebParam(name = "oid", partName = "getPluginDescriptor.oid") Long oid) throws ServerException, UserException;
@WebMethod(action = "getPluginDescriptorByName")
SPluginDescriptor getPluginDescriptorByName(
@WebParam(name = "name", partName = "getPluginDescriptorByName.name") String name) throws ServerException, UserException;
/**
* @return List of all SerializerPluginDescriptors
* @throws ServerException, UserException
*/
@WebMethod(action = "getAllWebModulePluginDescriptors")
List<SPluginDescriptor> getAllWebModulePluginDescriptors() throws ServerException, UserException;
/**
* @return List of all SerializerPluginDescriptors
* @throws ServerException, UserException
*/
@WebMethod(action = "getAllRenderEnginePluginDescriptors")
List<SPluginDescriptor> getAllRenderEnginePluginDescriptors() throws ServerException, UserException;
/**
* @return Return the default render engine plugin descriptor, this is the one used to set as the default render engine for new users
* @throws ServerException, UserException
*/
@WebMethod(action = "getDefaultRenderEnginePluginDescriptor")
SPluginDescriptor getDefaultRenderEnginePluginDescriptor() throws ServerException, UserException;
/**
* @return List of all DeserializerPluginDescriptors
* @throws ServerException, UserException
*/
@WebMethod(action = "getAllDeserializerPluginDescriptors")
List<SPluginDescriptor> getAllDeserializerPluginDescriptors() throws ServerException, UserException;
/**
* @return List of all QueryEnginePluginDescriptors
* @throws ServerException, UserException
*/
@WebMethod(action = "getAllQueryEnginePluginDescriptors")
List<SPluginDescriptor> getAllQueryEnginePluginDescriptors() throws ServerException, UserException;
/**
* @return List of all getAllServicePluginDescriptors
* @throws ServerException, UserException
*/
@WebMethod(action = "getAllServicePluginDescriptors")
List<SPluginDescriptor> getAllServicePluginDescriptors() throws ServerException, UserException;
/**
* @return List of all SModelComparePluginDescriptor
* @throws ServerException, UserException
*/
@WebMethod(action = "getAllModelComparePluginDescriptors")
List<SPluginDescriptor> getAllModelComparePluginDescriptors() throws ServerException, UserException;
/**
* @return List of all SModelComparePluginDescriptor
* @throws ServerException, UserException
*/
@WebMethod(action = "getAllModelCheckerPluginDescriptors")
List<SPluginDescriptor> getAllModelCheckerPluginDescriptors() throws ServerException, UserException;
/**
* @return List of all SModelMergerPluginDescriptor
* @throws ServerException, UserException
*/
@WebMethod(action = "getAllModelMergerPluginDescriptors")
List<SPluginDescriptor> getAllModelMergerPluginDescriptors() throws ServerException, UserException;
/**
* @param name Name of the WebModule
* @return WebModule
* @throws ServerException, UserException
*/
@WebMethod(action = "getWebModuleByName")
SWebModulePluginConfiguration getWebModuleByName(
@WebParam(name = "name", partName = "getWebModuleByName.name") String name) throws ServerException, UserException;
@WebMethod(action = "listAllWebModules")
List<SWebModulePluginConfiguration> listAllWebModules() throws ServerException, UserException;
/**
* @param name Name of the RenderEngine
* @return RenderEngine
* @throws ServerException, UserException
*/
@WebMethod(action = "getRenderEngineByName")
SRenderEnginePluginConfiguration getRenderEngineByName(
@WebParam(name = "name", partName = "getRenderEngineByName.name") String name) throws ServerException, UserException;
/**
* @param name Name of the ModelMerger
* @return SModelMerger
* @throws ServerException, UserException
*/
@WebMethod(action = "getModelMergerByName")
SModelMergerPluginConfiguration getModelMergerByName(
@WebParam(name = "name", partName = "getModelMergerByName.name") String name) throws ServerException, UserException;
/**
* @param name Name of the ModelCompare
* @return SModelCompare
* @throws ServerException, UserException
*/
@WebMethod(action = "getModelCompareByName")
SModelComparePluginConfiguration getModelCompareByName(
@WebParam(name = "name", partName = "getModelCompareByName.name") String name) throws ServerException, UserException;
/**
* @param onlyEnabled Whether to only include enabled serializers
* @return A list of Serializers
* @throws ServerException, UserException
*/
@WebMethod(action = "getAllSerializers")
List<SSerializerPluginConfiguration> getAllSerializers(
@WebParam(name = "onlyEnabled", partName = "getAllSerializers.onlyEnabled") Boolean onlyEnabled) throws ServerException, UserException;
/**
* @param onlyEnabled Whether to only include enabled IFC engines
* @return A list of RenderEngines
* @throws ServerException, UserException
*/
@WebMethod(action = "getAllRenderEngines")
List<SRenderEnginePluginConfiguration> getAllRenderEngines(
@WebParam(name = "onlyEnabled", partName = "getAllRenderEngines.onlyEnabled") Boolean onlyEnabled) throws ServerException, UserException;
/**
* @param onlyEnabled Whether to only include enabled IFC engines
* @return A list of RenderEngines
* @throws ServerException, UserException
*/
@WebMethod(action = "getAllWebModules")
List<SWebModulePluginConfiguration> getAllWebModules(
@WebParam(name = "onlyEnabled", partName = "getAllWebModules.onlyEnabled") Boolean onlyEnabled) throws ServerException, UserException;
/**
* @param onlyEnabled Whether to only include enabled query engines
* @return A list of QueryEngines
* @throws ServerException, UserException
*/
@WebMethod(action = "getAllQueryEngines")
List<SQueryEnginePluginConfiguration> getAllQueryEngines(
@WebParam(name = "onlyEnabled", partName = "getAllQueryEngines.onlyEnabled") Boolean onlyEnabled) throws ServerException, UserException;
/**
* @param onlyEnabled Whether to only include enabled model mergers
* @return A list of SModelMerger
* @throws ServerException, UserException
*/
@WebMethod(action = "getAllModelMergers")
List<SModelMergerPluginConfiguration> getAllModelMergers(
@WebParam(name = "onlyEnabled", partName = "getAllModelMergers.onlyEnabled") Boolean onlyEnabled) throws ServerException, UserException;
/**
* @param onlyEnabled Whether to only include enabled model compare
* @return A list of SModelCompare
* @throws ServerException, UserException
*/
@WebMethod(action = "getAllModelCompares")
List<SModelComparePluginConfiguration> getAllModelCompares(
@WebParam(name = "onlyEnabled", partName = "getAllModelCompares.onlyEnabled") Boolean onlyEnabled) throws ServerException, UserException;
/**
* @param oid ObjectID of the RenderEngine
* @return RenderEngine
* @throws ServerException, UserException
*/
@WebMethod(action = "getRenderEngineById")
SRenderEnginePluginConfiguration getRenderEngineById(
@WebParam(name = "oid", partName = "getRenderEngineById.oid") Long oid) throws ServerException, UserException;
/**
* @param oid ObjectID of the ModelMerger
* @return SModelMerger
* @throws ServerException, UserException
*/
@WebMethod(action = "getModelMergerById")
SModelMergerPluginConfiguration getModelMergerById(
@WebParam(name = "oid", partName = "getModelMergerById.oid") Long oid) throws ServerException, UserException;
/**
* @param oid ObjectID of the ModelCompare
* @return SModelCompare
* @throws ServerException, UserException
*/
@WebMethod(action = "getModelCompareById")
SModelComparePluginConfiguration getModelCompareById(
@WebParam(name = "oid", partName = "getModelCompareById.oid") Long oid) throws ServerException, UserException;
/**
* @param oid ObjectID of the Deserializer
* @return Deserializer
* @throws ServerException, UserException
*/
@WebMethod(action = "getWebModuleById")
SWebModulePluginConfiguration getWebModuleById(
@WebParam(name = "oid", partName = "getWebModuleById.oid") Long oid) throws ServerException, UserException;
/**
* @param serializer Serializer to add
* @throws ServerException, UserException
*/
@WebMethod(action = "addSerializer")
Long addSerializer(
@WebParam(name = "serializer", partName = "addSerializer.serializer") SSerializerPluginConfiguration serializer) throws ServerException, UserException;
/**
* @param renderEngine RenderEngine to add
* @throws ServerException, UserException
*/
@WebMethod(action = "addRenderEngine")
Long addRenderEngine(
@WebParam(name = "renderEngine", partName = "addRenderEngine.renderEngine") SRenderEnginePluginConfiguration renderEngine) throws ServerException, UserException;
/**
* @param queryEngine QueryEngine to add
* @throws ServerException, UserException
*/
@WebMethod(action = "addQueryEngine")
Long addQueryEngine(
@WebParam(name = "queryEngine", partName = "addQueryEngine.queryEngine") SQueryEnginePluginConfiguration queryEngine) throws ServerException, UserException;
/**
* @param modelMerger ModelMerger to add
* @throws ServerException, UserException
*/
@WebMethod(action = "addModelMerger")
Long addModelMerger(
@WebParam(name = "modelMerger", partName = "addModelMerger.modelMerger") SModelMergerPluginConfiguration modelMerger) throws ServerException, UserException;
/**
* @param modelCompare ModelCompare to add
* @throws ServerException, UserException
*/
@WebMethod(action = "addModelCompare")
Long addModelCompare(
@WebParam(name = "modelCompare", partName = "addModelCompare.modelCompare") SModelComparePluginConfiguration modelCompare) throws ServerException, UserException;
/**
* @param deserializer Deserializer to add
* @throws ServerException, UserException
*/
@WebMethod(action = "addDeserializer")
Long addDeserializer(
@WebParam(name = "deserializer", partName = "addDeserializer.deserializer") SDeserializerPluginConfiguration deserializer) throws ServerException, UserException;
/**
* @param serializer Serializer to update
* @throws ServerException, UserException
*/
@WebMethod(action = "updateSerializer")
void updateSerializer(
@WebParam(name = "serializer", partName = "updateSerializer.serializer") SSerializerPluginConfiguration serializer) throws ServerException, UserException;
/**
* @param renderEngine RenderEngine to update
* @throws ServerException, UserException
*/
@WebMethod(action = "updateRenderEngine")
void updateRenderEngine(
@WebParam(name = "renderEngine", partName = "updateRenderEngine.renderEngine") SRenderEnginePluginConfiguration renderEngine) throws ServerException, UserException;
/**
* @param queryEngine QueryEngine to update
* @throws ServerException, UserException
*/
@WebMethod(action = "updateQueryEngine")
void updateQueryEngine(
@WebParam(name = "queryEngine", partName = "updateQueryEngine.queryEngine") SQueryEnginePluginConfiguration queryEngine) throws ServerException, UserException;
/**
* @param modelMerger ModelMerger to update
* @throws ServerException, UserException
*/
@WebMethod(action = "updateModelMerger")
void updateModelMerger(
@WebParam(name = "modelMerger", partName = "updateModelMerger.modelMerger") SModelMergerPluginConfiguration modelMerger) throws ServerException, UserException;
/**
* @param modelCompare ModelCompare to update
* @throws ServerException, UserException
*/
@WebMethod(action = "updateModelCompare")
void updateModelCompare(
@WebParam(name = "modelCompare", partName = "updateModelCompare.modelCompare") SModelComparePluginConfiguration modelCompare) throws ServerException, UserException;
/**
* @param deserializer Deserializer to update
* @throws ServerException, UserException
*/
@WebMethod(action = "updateDeserializer")
void updateDeserializer(
@WebParam(name = "deserializer", partName = "updateDeserializer.deserializer") SDeserializerPluginConfiguration deserializer) throws ServerException, UserException;
/**
* @param sid ObjectID of the Serializer to delete
* @throws ServerException, UserException
*/
@WebMethod(action = "deleteSerializer")
void deleteSerializer(
@WebParam(name = "sid", partName = "deleteSerializer.sid") Long sid) throws ServerException, UserException;
/**
* @param oid ObjectID of the Serializer to delete
* @throws ServerException, UserException
*/
@WebMethod(action = "deletePluginConfiguration")
void deletePluginConfiguration(
@WebParam(name = "oid", partName = "deletePluginConfiguration.oid") Long oid) throws ServerException, UserException;
/**
* @param iid ObjectID of the RenderEngine to delete
* @throws ServerException, UserException
*/
@WebMethod(action = "deleteRenderEngine")
void deleteRenderEngine(
@WebParam(name = "iid", partName = "deleteRenderEngine.iid") Long iid) throws ServerException, UserException;
/**
* @param iid ObjectID of the ModelMerger to delete
* @throws ServerException, UserException
*/
@WebMethod(action = "deleteModelMerger")
void deleteModelMerger(
@WebParam(name = "iid", partName = "deleteModelMerger.iid") Long iid) throws ServerException, UserException;
/**
* @param iid ObjectID of the ModelCompare to delete
* @throws ServerException, UserException
*/
@WebMethod(action = "deleteModelCompare")
void deleteModelCompare(
@WebParam(name = "iid", partName = "deleteModelCompare.iid") Long iid) throws ServerException, UserException;
/**
* @param iid ObjectID of the ModelCompare to delete
* @throws ServerException, UserException
*/
@WebMethod(action = "deleteModelChecker")
void deleteModelChecker(
@WebParam(name = "iid", partName = "deleteModelChecker.iid") Long iid) throws ServerException, UserException;
/**
* @param iid ObjectID of the QueryEngine to delete
* @throws ServerException, UserException
*/
@WebMethod(action = "deleteQueryEngine")
void deleteQueryEngine(
@WebParam(name = "iid", partName = "deleteQueryEngine.iid") Long iid) throws ServerException, UserException;
/**
* @param sid ObjectID of the Deserializer to delete
* @throws ServerException, UserException
*/
@WebMethod(action = "deleteDeserializer")
void deleteDeserializer(
@WebParam(name = "sid", partName = "deleteDeserializer.sid") Long sid) throws ServerException, UserException;
@WebMethod(action = "getPluginObjectDefinition")
SObjectDefinition getPluginObjectDefinition(
@WebParam(name = "oid", partName = "getPluginObjectDefinition.oid") Long oid) throws ServerException, UserException;
@WebMethod(action = "getPluginSystemObjectDefinition")
SObjectDefinition getPluginSystemObjectDefinition(
@WebParam(name = "oid", partName = "getPluginSystemObjectDefinition.oid") Long oid) throws ServerException, UserException;
@WebMethod(action = "setPluginSettings")
void setPluginSettings(
@WebParam(name = "poid", partName = "setPluginSettings.poid") Long poid,
@WebParam(name = "settings", partName = "setPluginSettings.settings") SObjectType settings) throws ServerException, UserException;
@WebMethod(action = "setPluginSystemSettings")
void setPluginSystemSettings(
@WebParam(name = "poid", partName = "setPluginSystemSettings.poid") Long poid,
@WebParam(name = "settings", partName = "setPluginSystemSettings.settings") SObjectType settings) throws ServerException, UserException;
@WebMethod(action = "getPluginSettings")
SObjectType getPluginSettings(
@WebParam(name = "poid", partName = "getPluginSettings.poid") Long poid) throws ServerException, UserException;
@WebMethod(action = "getPluginSystemSettings")
SObjectType getPluginSystemSettings(
@WebParam(name = "poid", partName = "getPluginSystemSettings.poid") Long poid) throws ServerException, UserException;
/**
* @param onlyEnabled Whether to only include enabled deserializers
* @return A list of all available deserializers
* @throws ServerException, UserException
*/
@WebMethod(action = "getAllDeserializers")
List<SDeserializerPluginConfiguration> getAllDeserializers(
@WebParam(name = "onlyEnabled", partName = "getAllDeserializers.onlyEnabled") Boolean onlyEnabled) throws ServerException, UserException;
/**
* @param onlyEnabled Whether to only include enabled deserializers
* @return A list of all available deserializers
* @throws ServerException, UserException
*/
@WebMethod(action = "getAllDeserializersForProject")
List<SDeserializerPluginConfiguration> getAllDeserializersForProject (
@WebParam(name = "onlyEnabled", partName = "getAllDeserializersForProject.onlyEnabled") Boolean onlyEnabled,
@WebParam(name = "poid", partName = "getAllDeserializersForProject.poid") Long poid) throws ServerException, UserException;
/**
* @param pluginClassName The name of the plugin class
* @return Serializer implementing given plugin class
* @throws ServerException, UserException
*/
@WebMethod(action = "getSerializerByPluginClassName")
SSerializerPluginConfiguration getSerializerByPluginClassName(
@WebParam(name = "pluginClassName", partName = "getSerializerByPluginClassName.pluginClassName") String pluginClassName) throws ServerException, UserException;
/**
* @param contentType Content type
* @return Whether there is an active Serializer supporting the given ContentType
* @throws ServerException, UserException
*/
@WebMethod(action = "hasActiveSerializer")
Boolean hasActiveSerializer(
@WebParam(name = "contentType", partName = "hasActiveSerializer.contentType") String contentType) throws ServerException, UserException;
@WebMethod(action="getInternalServiceById")
SInternalServicePluginConfiguration getInternalServiceById(
@WebParam(name = "oid", partName = "getEServiceById.oid") Long oid) throws ServerException, UserException;
@WebMethod(action="updateInternalService")
void updateInternalService(
@WebParam(name = "internalService", partName = "updateInternalService.internalService") SInternalServicePluginConfiguration internalService) throws ServerException, UserException;
@WebMethod(action="addInternalService")
Long addInternalService(
@WebParam(name = "internalService", partName = "addInternalService.internalService") SInternalServicePluginConfiguration internalService) throws ServerException, UserException;
@WebMethod(action="deleteInternalService")
void deleteInternalService(
@WebParam(name = "oid", partName = "deleteInternalService.oid") Long oid) throws ServerException, UserException;
@WebMethod(action="getAllInternalServices")
List<SInternalServicePluginConfiguration> getAllInternalServices(
@WebParam(name = "onlyEnabled", partName = "getAllInternalServices.onlyEnabled") Boolean onlyEnabled) throws UserException, ServerException;
@WebMethod(action="getAllInternalServicesOfService")
List<SInternalServicePluginConfiguration> getAllInternalServicesOfService(
@WebParam(name = "name", partName = "getAllInternalServicesOfService.name") String name,
@WebParam(name = "onlyEnabled", partName = "getAllInternalServicesOfService.onlyEnabled") Boolean onlyEnabled) throws UserException, ServerException;
@WebMethod(action = "getAvailablePluginBundles")
List<SPluginBundle> getAvailablePluginBundles() throws UserException, ServerException;
@WebMethod(action = "getPluginBundle")
SPluginBundle getPluginBundle(
@WebParam(name = "repository", partName = "getPluginBundle.repository") String repository,
@WebParam(name = "groupId", partName = "getPluginBundle.groupId") String groupId,
@WebParam(name = "artifactId", partName = "getPluginBundle.artifactId") String artifactId) throws UserException, ServerException;
@WebMethod(action = "getPluginBundleVersionById")
SPluginBundleVersion getPluginBundleVersionById(
@WebParam(name = "pbid", partName = "getPluginBundleVersionById.pbid") Long pbid) throws UserException, ServerException;
@WebMethod(action = "getInstalledPluginBundles")
List<SPluginBundle> getInstalledPluginBundles() throws UserException, ServerException;
@WebMethod(action = "getInstalledPluginBundle")
SPluginBundleVersion getInstalledPluginBundle(
@WebParam(name = "oid", partName = "getInstalledPluginBundle.oid") Long oid) throws UserException, ServerException;
@WebMethod(action = "installPluginBundle")
void installPluginBundle(
@WebParam(name = "repository", partName = "installPluginBundle.repository") String repository,
@WebParam(name = "groupId", partName = "installPluginBundle.groupId") String groupId,
@WebParam(name = "artifactId", partName = "installPluginBundle.artifactId") String artifactId,
@WebParam(name = "version", partName = "installPluginBundle.version") String version,
@WebParam(name = "plugins", partName = "installPluginBundle.plugins") List<SPluginInformation> plugins) throws UserException, ServerException;
@WebMethod(action = "installPluginBundleFromFile")
void installPluginBundleFromFile(
@WebParam(name = "data", partName = "installPluginBundleFromFile.data") @XmlMimeType("application/octet-stream") DataHandler data,
@WebParam(name = "installAllPluginsForAllUsers", partName = "installPluginBundleFromFile.installAllPluginsForAllUsers") Boolean installAllPluginsForAllUsers,
@WebParam(name = "installAllPluginsForNewUsers", partName = "installPluginBundleFromFile.installAllPluginsForNewUsers") Boolean installAllPluginsForNewUsers) throws UserException, ServerException;
@WebMethod(action = "installPluginBundleFromUrl")
void installPluginBundleFromUrl(
@WebParam(name = "url", partName = "installPluginBundleFromUrl.url") String url,
@WebParam(name = "installAllPluginsForAllUsers", partName = "installPluginBundleFromUrl.installAllPluginsForAllUsers") Boolean installAllPluginsForAllUsers,
@WebParam(name = "installAllPluginsForNewUsers", partName = "installPluginBundleFromUrl.installAllPluginsForNewUsers") Boolean installAllPluginsForNewUsers) throws UserException, ServerException;
@WebMethod(action = "uninstallPluginBundle")
void uninstallPluginBundle(
@WebParam(name = "repository", partName = "uninstallPluginBundle.repository") String repository,
@WebParam(name = "groupId", partName = "uninstallPluginBundle.groupId") String groupId,
@WebParam(name = "artifactId", partName = "uninstallPluginBundle.artifactId") String artifactId,
@WebParam(name = "version", partName = "uninstallPluginBundle.version") String version) throws UserException, ServerException;
@WebMethod(action = "updatePluginBundle")
void updatePluginBundle(
@WebParam(name = "repository", partName = "uninstallPluginBundle.repository") String repository,
@WebParam(name = "groupId", partName = "uninstallPluginBundle.groupId") String groupId,
@WebParam(name = "artifactId", partName = "uninstallPluginBundle.artifactId") String artifactId,
@WebParam(name = "version", partName = "uninstallPluginBundle.version") String version) throws UserException, ServerException;
@WebMethod(action = "getPluginInformation")
List<SPluginInformation> getPluginInformation(
@WebParam(name = "repository", partName = "getPluginInformation.repository") String repository,
@WebParam(name = "groupId", partName = "getPluginInformation.groupId") String groupId,
@WebParam(name = "artifactId", partName = "getPluginInformation.artifactId") String artifactId,
@WebParam(name = "version", partName = "getPluginInformation.version") String version) throws UserException, ServerException;
/**
* Removes the maven cache, can be useful if you don't want to wait the default update period (which is 1 day) for new plugins
*
* @throws UserException
* @throws ServerException
*/
@WebMethod(action = "clearMavenCache")
void clearMavenCache() throws UserException, ServerException;
@WebMethod(action = "listPluginsInBundle")
List<SPluginDescriptor> listPluginsInBundle(@WebParam(name = "pluginBundleVersionOid", partName = "listPluginsInBundle.pluginBundleVersionOid") Long pluginBundleVersionOid) throws ServerException, UserException;
@WebMethod(action = "hasPreBuiltPlugins")
Boolean hasPreBuiltPlugins() throws UserException, ServerException;
@WebMethod(action = "installPreBuiltPlugins")
void installPreBuiltPlugins(@WebParam(name = "artifacts", partName = "installPreBuiltPlugins.artifacts") List<String> artifacts) throws UserException, ServerException;
}