-
Notifications
You must be signed in to change notification settings - Fork 477
/
ControlService.java
1723 lines (1571 loc) · 58.5 KB
/
ControlService.java
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
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* Copyright 2014-2016 CyberVision, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.kaaproject.kaa.server.control.service;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import org.apache.avro.Schema;
import org.kaaproject.avro.ui.shared.Fqn;
import org.kaaproject.kaa.common.dto.*;
import org.kaaproject.kaa.common.dto.admin.RecordKey;
import org.kaaproject.kaa.common.dto.admin.SdkPlatform;
import org.kaaproject.kaa.common.dto.admin.SdkProfileDto;
import org.kaaproject.kaa.common.dto.credentials.CredentialsDto;
import org.kaaproject.kaa.common.dto.ctl.CTLSchemaDto;
import org.kaaproject.kaa.common.dto.ctl.CTLSchemaMetaInfoDto;
import org.kaaproject.kaa.common.dto.event.AefMapInfoDto;
import org.kaaproject.kaa.common.dto.event.ApplicationEventFamilyMapDto;
import org.kaaproject.kaa.common.dto.event.EcfInfoDto;
import org.kaaproject.kaa.common.dto.event.EventClassDto;
import org.kaaproject.kaa.common.dto.event.EventClassFamilyDto;
import org.kaaproject.kaa.common.dto.event.EventClassType;
import org.kaaproject.kaa.common.dto.file.FileData;
import org.kaaproject.kaa.common.dto.logs.LogAppenderDto;
import org.kaaproject.kaa.common.dto.logs.LogSchemaDto;
import org.kaaproject.kaa.common.dto.user.UserVerifierDto;
import org.kaaproject.kaa.server.control.service.exception.ControlServiceException;
/**
* The Interface ControlService.
*/
public interface ControlService {
/**
* Gets the tenants.
*
* @return the tenants
* @throws ControlServiceException
* the control service exception
*/
List<TenantDto> getTenants() throws ControlServiceException;
/**
* Gets the tenant.
*
* @param tenantId
* the tenant id
* @return the tenant
* @throws ControlServiceException
* the control service exception
*/
TenantDto getTenant(String tenantId) throws ControlServiceException;
/**
* Edits the tenant.
*
* @param tenant
* the tenant
* @return the tenant dto
* @throws ControlServiceException
* the control service exception
*/
TenantDto editTenant(TenantDto tenant) throws ControlServiceException;
/**
* Delete tenant.
*
* @param tenantId
* the tenant id
* @throws ControlServiceException
* the control service exception
*/
void deleteTenant(String tenantId) throws ControlServiceException;
/**
* Gets the users.
*
* @return the users
* @throws ControlServiceException
* the control service exception
*/
List<UserDto> getUsers() throws ControlServiceException;
/**
* Gets the tenant users.
*
* @param tenantId
* the tenant id
* @return the tenant users
* @throws ControlServiceException
* the control service exception
*/
List<UserDto> getTenantUsers(String tenantId) throws ControlServiceException;
/**
* Gets the user.
*
* @param userId
* the user id
* @return the user
* @throws ControlServiceException
* the control service exception
*/
UserDto getUser(String userId) throws ControlServiceException;
/**
* Gets the user by external uid.
*
* @param uid
* the uid
* @return the user by external uid
* @throws ControlServiceException
* the control service exception
*/
UserDto getUserByExternalUid(String uid) throws ControlServiceException;
/**
* Edits the user.
*
* @param user
* the user
* @return the user dto
* @throws ControlServiceException
* the control service exception
*/
UserDto editUser(UserDto user) throws ControlServiceException;
/**
* Delete user.
*
* @param userId
* the user id
* @throws ControlServiceException
* the control service exception
*/
void deleteUser(String userId) throws ControlServiceException;
/**
* Gets the tenant admins by tenant id.
*
* @return the tenant admins
* @throws ControlServiceException
* the control service exception
*/
List<UserDto> findAllTenantAdminsByTenantId(String tenantId) throws ControlServiceException;
/**
* Gets the application.
*
* @param applicationId
* the application id
* @return the application
* @throws ControlServiceException
* the control service exception
*/
ApplicationDto getApplication(String applicationId) throws ControlServiceException;
/**
* Gets the application by application token.
*
* @param applicationToken
* the application token
* @return the application by application token
* @throws ControlServiceException
* the control service exception
*/
ApplicationDto getApplicationByApplicationToken(String applicationToken) throws ControlServiceException;
/**
* Gets the applications by tenant id.
*
* @param tenantId
* the tenant id
* @return the applications by tenant id
* @throws ControlServiceException
* the control service exception
*/
List<ApplicationDto> getApplicationsByTenantId(String tenantId) throws ControlServiceException;
/**
* Edits the application.
*
* @param application
* the application
* @return the application dto
* @throws ControlServiceException
* the control service exception
*/
ApplicationDto editApplication(ApplicationDto application) throws ControlServiceException;
/**
* Delete application.
*
* @param applicationId
* the application id
* @throws ControlServiceException
* the control service exception
*/
void deleteApplication(String applicationId) throws ControlServiceException;
/**
* Gets the configuration schemas by application id.
*
* @param applicationId
* the application id
* @return the configuration schemas by application id
* @throws ControlServiceException
* the control service exception
*/
List<ConfigurationSchemaDto> getConfigurationSchemasByApplicationId(String applicationId) throws ControlServiceException;
/**
* Gets the configuration schema.
*
* @param configurationSchemaId
* the configuration schema id
* @return the configuration schema
* @throws ControlServiceException
* the control service exception
*/
ConfigurationSchemaDto getConfigurationSchema(String configurationSchemaId) throws ControlServiceException;
/**
* Edits the configuration schema.
*
* @param configurationSchema
* the configuration schema
* @return the configuration schema dto
* @throws ControlServiceException
* the control service exception
*/
ConfigurationSchemaDto editConfigurationSchema(ConfigurationSchemaDto configurationSchema) throws ControlServiceException;
/**
* Gets the profile schemas by application id.
*
* @param applicationId
* the application id
* @return the profile schemas by application id
* @throws ControlServiceException
* the control service exception
*/
List<EndpointProfileSchemaDto> getProfileSchemasByApplicationId(String applicationId) throws ControlServiceException;
/**
* Gets the profile schema.
*
* @param profileSchemaId
* the profile schema id
* @return the profile schema
* @throws ControlServiceException
* the control service exception
*/
EndpointProfileSchemaDto getProfileSchema(String profileSchemaId) throws ControlServiceException;
/**
* Gets the profile schema by application id and profile schema version.
*
* @param applicationId
* the application id
* @param version
* the profile schema version
* @return the profile schema
* @throws ControlServiceException
* the control service exception
*/
EndpointProfileSchemaDto getProfileSchemaByApplicationIdAndVersion(String applicationId, int version) throws ControlServiceException;
/**
* Edits the profile schema.
*
* @param profileSchema
* the profile schema
* @return the profile schema dto
* @throws ControlServiceException
* the control service exception
*/
EndpointProfileSchemaDto editProfileSchema(EndpointProfileSchemaDto profileSchema) throws ControlServiceException;
/**
* Gets the server profile schemas by application id.
*
* @param applicationId
* the application id
* @return the server profile schemas by application id
* @throws ControlServiceException
* the control service exception
*/
List<ServerProfileSchemaDto> getServerProfileSchemasByApplicationId(String applicationId) throws ControlServiceException;
/**
* Gets the server profile schema.
*
* @param serverProfileSchemaId
* the server profile schema id
* @return the server profile schema dto
* @throws ControlServiceException
* the control service exception
*/
ServerProfileSchemaDto getServerProfileSchema(String serverProfileSchemaId) throws ControlServiceException;
/**
* Gets the server profile schema by application id and server profile
* schema version.
*
* @param applicationId
* the application id
* @param version
* the server profile schema version
* @return the server profile schema
* @throws ControlServiceException
* the control service exception
*/
ServerProfileSchemaDto getServerProfileSchemaByApplicationIdAndVersion(String applicationId, int version)
throws ControlServiceException;
/**
* Edits the server profile schema.
*
* @param serverProfileSchema
* the server profile schema
* @return the server profile schema dto
* @throws ControlServiceException
* the control service exception
*/
ServerProfileSchemaDto saveServerProfileSchema(ServerProfileSchemaDto serverProfileSchema) throws ControlServiceException;
/**
* Gets the latest created server profile schema for application.
*
* @param applicationId
* the application id
* @return the server profile schema dto
* @throws ControlServiceException
* the control service exception
*/
ServerProfileSchemaDto findLatestServerProfileSchema(String applicationId) throws ControlServiceException;
/**
* Gets the endpoint groups by application id.
*
* @param applicationId
* the application id
* @return the endpoint groups by application id
* @throws ControlServiceException
* the control service exception
*/
List<EndpointGroupDto> getEndpointGroupsByApplicationId(String applicationId) throws ControlServiceException;
/**
* Gets the endpoint group.
*
* @param endpointGroupId
* the endpoint group id
* @return the endpoint group
* @throws ControlServiceException
* the control service exception
*/
EndpointGroupDto getEndpointGroup(String endpointGroupId) throws ControlServiceException;
/**
* Edits the endpoint group.
*
* @param endpointGroup
* the endpoint group
* @return the endpoint group dto
* @throws ControlServiceException
* the control service exception
*/
EndpointGroupDto editEndpointGroup(EndpointGroupDto endpointGroup) throws ControlServiceException;
/**
* Delete endpoint group.
*
* @param endpointGroupId
* the endpoint group id
* @throws ControlServiceException
* the control service exception
*/
void deleteEndpointGroup(String endpointGroupId) throws ControlServiceException;
/**
* Removes the topics from endpoint group.
*
* @param endpointGroupId
* the endpoint group id
* @param topicId
* the topic id
* @return the endpoint group dto
* @throws ControlServiceException
* the control service exception
*/
EndpointGroupDto removeTopicsFromEndpointGroup(String endpointGroupId, String topicId) throws ControlServiceException;
/**
* Adds the topics to endpoint group.
*
* @param endpointGroupId
* the endpoint group id
* @param topicId
* the topic id
* @return the endpoint group dto
* @throws ControlServiceException
* the control service exception
*/
EndpointGroupDto addTopicsToEndpointGroup(String endpointGroupId, String topicId) throws ControlServiceException;
/**
* Gets the profile filter.
*
* @param profileFilterId
* the profile filter id
* @return the profile filter
* @throws ControlServiceException
* the control service exception
*/
ProfileFilterDto getProfileFilter(String profileFilterId) throws ControlServiceException;
/**
* Gets the profile filter records by endpoint group id.
*
* @param endpointGroupId
* the endpoint group id
* @param includeDeprecated
* the include deprecated
* @return the profile filter records by endpoint group id
* @throws ControlServiceException
* the control service exception
*/
List<ProfileFilterRecordDto> getProfileFilterRecordsByEndpointGroupId(String endpointGroupId, boolean includeDeprecated)
throws ControlServiceException;
/**
* Gets the profile filter record.
*
* @param endpointProfileSchemaId
* the endpoint profile schema id
* @param serverProfileSchemaId
* the server profile schema id
* @param endpointGroupId
* the endpoint group id
* @return the profile filter record
* @throws ControlServiceException
* the control service exception
*/
ProfileFilterRecordDto getProfileFilterRecord(String endpointProfileSchemaId, String serverProfileSchemaId, String endpointGroupId)
throws ControlServiceException;
/**
* Gets the vacant profile schemas by endpoint group id.
*
* @param endpointGroupId
* the endpoint group id
* @return the vacant profile schemas by endpoint group id
* @throws ControlServiceException
* the control service exception
*/
List<ProfileVersionPairDto> getVacantProfileSchemasByEndpointGroupId(String endpointGroupId) throws ControlServiceException;
/**
* Edits the profile filter.
*
* @param profileFilter
* the profile filter
* @return the profile filter dto
* @throws ControlServiceException
* the control service exception
*/
ProfileFilterDto editProfileFilter(ProfileFilterDto profileFilter) throws ControlServiceException;
/**
* Gets the configuration records by endpoint group id.
*
* @param endpointGroupId
* the endpoint group id
* @param includeDeprecated
* the include deprecated
* @return the configuration records by endpoint group id
* @throws ControlServiceException
* the control service exception
*/
List<ConfigurationRecordDto> getConfigurationRecordsByEndpointGroupId(String endpointGroupId, boolean includeDeprecated)
throws ControlServiceException;
/**
* Gets the configuration record.
*
* @param schemaId
* the schema id
* @param endpointGroupId
* the endpoint group id
* @return the configuration record
* @throws ControlServiceException
* the control service exception
*/
ConfigurationRecordDto getConfigurationRecord(String schemaId, String endpointGroupId) throws ControlServiceException;
/**
* Gets the vacant configuration schemas by endpoint group id.
*
* @param endpointGroupId
* the endpoint group id
* @return the vacant configuration schemas by endpoint group id
* @throws ControlServiceException
* the control service exception
*/
List<VersionDto> getVacantConfigurationSchemasByEndpointGroupId(String endpointGroupId) throws ControlServiceException;
/**
* Gets the configuration.
*
* @param configurationId
* the configuration id
* @return the configuration
* @throws ControlServiceException
* the control service exception
*/
ConfigurationDto getConfiguration(String configurationId) throws ControlServiceException;
/**
* Edits the configuration.
*
* @param configuration
* the configuration
* @return the configuration dto
* @throws ControlServiceException
* the control service exception
*/
ConfigurationDto editConfiguration(ConfigurationDto configuration) throws ControlServiceException;
/**
* Edits the user configuration.
*
* @param configuration
* the configuration
* @throws ControlServiceException
* the control service exception
*/
void editUserConfiguration(EndpointUserConfigurationDto configuration) throws ControlServiceException;
/**
* Activate configuration.
*
* @param configurationId
* the configuration id
* @param activatedUsername
* the activated username
* @return the configuration dto
* @throws ControlServiceException
* the control service exception
*/
ConfigurationDto activateConfiguration(String configurationId, String activatedUsername) throws ControlServiceException;
/**
* Deactivate configuration.
*
* @param configurationId
* the configuration id
* @param deactivatedUsername
* the deactivated username
* @return the configuration dto
* @throws ControlServiceException
* the control service exception
*/
ConfigurationDto deactivateConfiguration(String configurationId, String deactivatedUsername) throws ControlServiceException;
/**
* Delete configuration record.
*
* @param schemaId
* the schema id
* @param endpointGroupId
* the endpoint group id
* @param deactivatedUsername
* the deactivated username
* @throws ControlServiceException
* the control service exception
*/
void deleteConfigurationRecord(String schemaId, String endpointGroupId, String deactivatedUsername) throws ControlServiceException;
/**
* Activate profile filter.
*
* @param profileFilterId
* the profile filter id
* @param activatedUsername
* the activated username
* @return the profile filter dto
* @throws ControlServiceException
* the control service exception
*/
ProfileFilterDto activateProfileFilter(String profileFilterId, String activatedUsername) throws ControlServiceException;
/**
* Deactivate profile filter.
*
* @param profileFilterId
* the profile filter id
* @param deactivatedUsername
* the deactivated username
* @return the profile filter dto
* @throws ControlServiceException
* the control service exception
*/
ProfileFilterDto deactivateProfileFilter(String profileFilterId, String deactivatedUsername) throws ControlServiceException;
/**
* Delete profile filter record.
*
* @param endpointProfileSchemaId
* the endpoint profile schema id
* @param serverProfileSchemaId
* the server profile schema id
* @param endpointGroupId
* the endpoint group id
* @param deactivatedUsername
* the deactivated username
* @throws ControlServiceException
* the control service exception
*/
void deleteProfileFilterRecord(String endpointProfileSchemaId, String serverProfileSchemaId, String endpointGroupId,
String deactivatedUsername) throws ControlServiceException;
/**
* Generate sdk.
*
* @param sdkProperties
* the sdk properties
* @param platform
* the platform
* @return the file data
* @throws ControlServiceException
* the control service exception
*/
FileData generateSdk(SdkProfileDto sdkProperties, SdkPlatform platform) throws ControlServiceException;
/**
* Generate record structure library.
*
* @param applicationId
* the application id
* @param logSchemaVersion
* the log schema version
* @return the file data
* @throws ControlServiceException
* the control service exception
*/
FileData generateRecordStructureLibrary(String applicationId, int logSchemaVersion) throws ControlServiceException;
/**
* Edits the notification schema.
*
* @param notificationSchema
* the notification schema
* @return the notification schema dto
* @throws ControlServiceException
* the control service exception
*/
NotificationSchemaDto saveNotificationSchema(NotificationSchemaDto notificationSchema) throws ControlServiceException;
/**
* Gets the notification schema.
*
* @param notificationSchemaId
* the notification schema id
* @return the notification schema
* @throws ControlServiceException
* the control service exception
*/
NotificationSchemaDto getNotificationSchema(String notificationSchemaId) throws ControlServiceException;
/**
* Gets the notification schemas by app id.
*
* @param applicationId
* the application id
* @return the notification schemas by app id
* @throws ControlServiceException
* the control service exception
*/
List<NotificationSchemaDto> getNotificationSchemasByAppId(String applicationId) throws ControlServiceException;
/**
* Gets the user notification schemas by app id.
*
* @param applicationId
* the application id
* @return the user notification schemas by app id
* @throws ControlServiceException
* the control service exception
*/
List<VersionDto> getUserNotificationSchemasByAppId(String applicationId) throws ControlServiceException;
/**
* Find notification schemas by app id and type.
*
* @param applicationId
* the application id
* @param type
* the type
* @return the list
* @throws ControlServiceException
* the control service exception
*/
List<NotificationSchemaDto> findNotificationSchemasByAppIdAndType(String applicationId, NotificationTypeDto type)
throws ControlServiceException;
/**
* Edits the log schema.
*
* @param logSchemaDto
* the log schema dto
* @return the log schema dto
* @throws ControlServiceException
* the control service exception
*/
LogSchemaDto saveLogSchema(LogSchemaDto logSchemaDto) throws ControlServiceException;
/**
* Get the log schema.
*
* @param schemaId
* the log schema string
* @return the log schema dto
* @throws ControlServiceException
* the control service exception
*/
String getFlatSchemaByCtlSchemaId(String schemaId) throws ControlServiceException;
/**
* Gets the log schemas by application id.
*
* @param applicationId
* the application id
* @return the log schemas by application id
* @throws ControlServiceException
* the control service exception
*/
List<LogSchemaDto> getLogSchemasByApplicationId(String applicationId) throws ControlServiceException;
/**
* Gets the log schema.
*
* @param logSchemaId
* the log schema id
* @return the log schema
* @throws ControlServiceException
* the control service exception
*/
LogSchemaDto getLogSchema(String logSchemaId) throws ControlServiceException;
/**
* Gets the log schema by application id and version.
*
* @param applicationId
* the application id
* @param version
* the version
* @return the log schema by application id and version
* @throws ControlServiceException
* the control service exception
*/
LogSchemaDto getLogSchemaByApplicationIdAndVersion(String applicationId, int version) throws ControlServiceException;
/**
* Edits the notification.
*
* @param notification
* the notification
* @return the notification dto
* @throws ControlServiceException
* the control service exception
*/
NotificationDto editNotification(NotificationDto notification) throws ControlServiceException;
/**
* Gets the notification.
*
* @param notificationId
* the notification id
* @return the notification
* @throws ControlServiceException
* the control service exception
*/
NotificationDto getNotification(String notificationId) throws ControlServiceException;
/**
* Gets the notifications by topic id.
*
* @param topicId
* the topic id
* @return the notifications by topic id
* @throws ControlServiceException
* the control service exception
*/
List<NotificationDto> getNotificationsByTopicId(String topicId) throws ControlServiceException;
/**
* Edits the topic.
*
* @param topic
* the topic
* @return the topic dto
* @throws ControlServiceException
* the control service exception
*/
TopicDto editTopic(TopicDto topic) throws ControlServiceException;
/**
* Gets the topic.
*
* @param topicId
* the topic id
* @return the topic
* @throws ControlServiceException
* the control service exception
*/
TopicDto getTopic(String topicId) throws ControlServiceException;
/**
* Gets the topic by app id.
*
* @param appId
* the app id
* @return the topic by app id
* @throws ControlServiceException
* the control service exception
*/
List<TopicDto> getTopicByAppId(String appId) throws ControlServiceException;
/**
* Gets the topic by endpoint group id.
*
* @param endpointGroupId
* the endpoint group id
* @return the topic by endpoint group id
* @throws ControlServiceException
* the control service exception
*/
List<TopicDto> getTopicByEndpointGroupId(String endpointGroupId) throws ControlServiceException;
/**
* Gets the vacant topic by endpoint group id.
*
* @param endpointGroupId
* the endpoint group id
* @return the vacant topic by endpoint group id
* @throws ControlServiceException
* the control service exception
*/
List<TopicDto> getVacantTopicByEndpointGroupId(String endpointGroupId) throws ControlServiceException;
/**
* Delete topic by id.
*
* @param topicId
* the topic id
* @throws ControlServiceException
* the control service exception
*/
void deleteTopicById(String topicId) throws ControlServiceException;
/**
* Gets the unicast notification.
*
* @param notificationId
* the notification id
* @return the unicast notification
* @throws ControlServiceException
* the control service exception
*/
EndpointNotificationDto getUnicastNotification(String notificationId) throws ControlServiceException;
/**
* Edits the unicast notification.
*
* @param notification
* the notification
* @return the endpoint notification dto
* @throws ControlServiceException
* the control service exception
*/
EndpointNotificationDto editUnicastNotification(EndpointNotificationDto notification) throws ControlServiceException;
/**
* Gets the unicast notifications by key hash.
*
* @param keyhash
* the keyhash
* @return the unicast notifications by key hash
* @throws ControlServiceException
* the control service exception
*/
List<EndpointNotificationDto> getUnicastNotificationsByKeyHash(byte[] keyhash) throws ControlServiceException;
/**
* Gets the configuration schema versions by application id.
*
* @param applicationId
* the application id
* @return the configuration schema versions by application id
* @throws ControlServiceException
* the control service exception
*/
List<VersionDto> getConfigurationSchemaVersionsByApplicationId(String applicationId) throws ControlServiceException;
/**
* Gets the profile schema versions by application id.
*
* @param applicationId
* the application id
* @return the profile schema versions by application id
* @throws ControlServiceException
* the control service exception
*/
List<VersionDto> getProfileSchemaVersionsByApplicationId(String applicationId) throws ControlServiceException;
/**
* Gets the notification schema versions by application id.
*
* @param applicationId
* the application id
* @return the notification schema versions by application id
* @throws ControlServiceException
* the control service exception
*/
List<VersionDto> getNotificationSchemaVersionsByApplicationId(String applicationId) throws ControlServiceException;
/**
* Gets the log schema versions by application id.
*
* @param applicationId
* the application id
* @return the log schema versions by application id
* @throws ControlServiceException
* the control service exception
*/
List<VersionDto> getLogSchemaVersionsByApplicationId(String applicationId) throws ControlServiceException;
/**
* Edits the event class family.
*
* @param eventClassFamily
* the event class family
* @return the event class family dto
* @throws ControlServiceException
* the control service exception
*/
EventClassFamilyDto editEventClassFamily(EventClassFamilyDto eventClassFamily) throws ControlServiceException;
/**
* Gets the event class families by tenant id.
*
* @param tenantId
* the tenant id
* @return the event class families by tenant id
* @throws ControlServiceException
* the control service exception
*/
List<EventClassFamilyDto> getEventClassFamiliesByTenantId(String tenantId) throws ControlServiceException;
/**
* Gets the event class family.
*
* @param eventClassFamilyId
* the event class family id
* @return the event class family
* @throws ControlServiceException
* the control service exception
*/
EventClassFamilyDto getEventClassFamily(String eventClassFamilyId) throws ControlServiceException;
/**
* Adds the event class family schema.
*
* @param eventClassFamilyId
* the event class family id
* @param eventClassFamilySchema
* the event class family schema
* @param createdUsername
* the created username
* @throws ControlServiceException
* the control service exception
*/