Skip to content

apache_utils

This module provides automation support for Apache NiFi.

ApacheNifiUtils

Description

| This Class provides automation support for Apache Nifi. User can interact with Nifi processors by using this Class. | Apache NiFi is an open source software for automating and managing the flow of data between systems. | It's a powerful and reliable system to process and distribute data. | It provides a web-based User Interface for creating, monitoring, & controlling data flows.

Source code in libs\cafex_core\src\cafex_core\utils\apache_utils.py
  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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
class ApacheNifiUtils:
    """
    Description:
        |   This Class provides automation support for Apache Nifi. User can interact with
        Nifi processors by using this Class.
        |   Apache NiFi is an open source software for automating and managing the flow of data
        between systems.
        |   It's a powerful and reliable system to process and distribute data.
        |   It provides a web-based User Interface for creating, monitoring, & controlling
        data flows.
    """

    def __init__(self, pstr_nifi_url, pstr_nifi_registry_url=None):
        self.reporting = Reporting()
        self.__obj_exception = CoreExceptions()
        self.__nifi_token = None
        self.nifi_module = nipyapi
        self.logger = CoreLogger(name=__name__).get_logger()
        self.security = Security()

        nipyapi.config.nifi_config.verify_ssl = False  # Set to True if using valid SSL
        nipyapi.config.nifi_config.host = pstr_nifi_url  # Use the provided URL directly

        self.apis = {
            "flow_api": self.nifi_module.nifi.apis.flow_api.FlowApi(),
            "flowfile_queues_api": self.nifi_module.nifi.apis.
            flowfile_queues_api.FlowfileQueuesApi(),
            "access_api": nipyapi.nifi.apis.access_api.AccessApi()
        }

        if pstr_nifi_registry_url is not None:
            nipyapi.config.registry_config.host = (
                    pstr_nifi_registry_url + "/nifi-registry-api"
            )

    def check_processor_status(self, processor_id: str) -> bool:
        """
        Checks the status of a processor.

        Args:
            processor_id (str): NiFi processor ID.

        Returns:
            bool: True if the processor is available with a 200 response; otherwise, False.

        Examples:
            >> status = ApacheUtils.Nifi().
            check_processor_status("f03899a8-0193-1000-d8fc-53112a5e7c3a")
        """
        try:
            processor_status_entity = self.apis.get("flow_api").get_processor_status(processor_id)
            self.logger.info("API response for processor status: %s", processor_status_entity)
            if processor_status_entity.processor_status.to_dict():
                self.reporting.insert_step(
                    f"Successfully returned processor status for {processor_id}",
                    "Successfully returned processor status",
                    "Pass",
                )
                self.logger.info("Successfully returned processor status for %s.",
                                 processor_id)
                return True
            self.reporting.insert_step(
                "Processor status retrieval",
                f"Processor with ID {processor_id} does not exist or is not "
                f"available.", "Fail", )
            self.logger.error("Processor with ID %s does not exist or is not available.",
                              processor_id)
            return False
        except (nipyapi.nifi.rest.ApiException, ValueError) as e:
            error_message = f"Error occurred while checking status for processor " \
                            f"{processor_id}: {str(e)}"
            self.__obj_exception.raise_generic_exception(
                message=error_message,
                insert_report=True,
                trim_log=True,
                log_local=True,
                fail_test=False,
            )
            return False

    def check_process_group_status(self, process_group_id: str) -> bool:
        """
        Checks the status of a process group.

        Args:
            process_group_id (str): NiFi process group ID.

        Returns:
            bool: True if the process group status is available; otherwise, False.

        Examples:
            >> status = ApacheUtils.Nifi().check_process_group_status("process_group_id")
        """
        try:
            process_group_entity = self.apis.get("flow_api"). \
                get_process_group_status(process_group_id)
            self.logger.info("API response for process group status: %s", process_group_entity)
            if process_group_entity.process_group_status.to_dict():
                self.reporting.insert_step(
                    "Successfully returned process group status",
                    "Successfully returned process group status",
                    "Pass",
                )
                self.logger.info("Successfully returned process group status for ID: %s."
                                 , process_group_id)
                return True
            self.reporting.insert_step(
                "Process group status retrieval",
                "Unable to get process group status",
                "Fail",
            )
            self.logger.warning("Unable to get process group status for ID: %s"
                                , process_group_id)
            return False

        except (nipyapi.nifi.rest.ApiException, ValueError) as e:
            error_message = f"Error occurred while checking status for process group " \
                            f"{process_group_id}: {str(e)}"
            self.__obj_exception.raise_generic_exception(
                message=error_message,
                insert_report=True,
                trim_log=True,
                log_local=True,
                fail_test=False,
            )
            return False

    def change_process_group_state(self, process_group_id: str, state: bool = True) -> bool:
        """
        Changes the status of a NiFi process group.

        Args:
            process_group_id (str): NiFi process group ID.
            state (bool): True to schedule the process group; False to unschedule.

        Returns:
            bool: True if the state change was successful; otherwise, False.

        Examples:
            >> result = ApacheUtils.Nifi().
            change_process_group_state("process_group_id", True)
        """
        try:
            run_status = nipyapi.canvas.schedule_process_group(process_group_id,
                                                               scheduled=state)
            if run_status:
                self.reporting.insert_step(
                    f"Successfully changed process group state to {state}",
                    "Successfully changed process group state",
                    "Pass",
                )
                self.logger.info("Process group %s state changed to %s.",
                                 process_group_id, state)
                return True
            self.reporting.insert_step(
                f"Failed to change process group state to {state}",
                "Failed to change process group state",
                "Fail",
            )
            self.logger.warning("Failed to change process group %s state to %s."
                                , process_group_id, state)
            return False

        except (nipyapi.nifi.rest.ApiException, ValueError) as e:
            error_message = f"Error occurred while changing state for process group " \
                            f"{process_group_id}: {str(e)}"
            self.__obj_exception.raise_generic_exception(
                message=error_message,
                insert_report=True,
                trim_log=True,
                log_local=True,
                fail_test=False,
            )
            return False

    def change_processor_state(self, server_name: str, payload: str, nifi_id: str) -> bool:
        """
        Starts or stops a NiFi processor.

        Args:
            server_name (str): NiFi server name.
            payload (str): Processor payload.
            nifi_id (str): NiFi processor ID.

        Returns:
            bool: True if the operation was successful; otherwise, False.

        Examples:
            >> result = ApacheUtils.Nifi().change_processor_state("http://localhost:8080",
            payload, "processor_id")
        """
        try:
            api_method = "PUT"
            api_header = {"Content-Type": "application/json"}
            method_path = "/nifi-api/flow/process-groups/"
            request_url = f"{server_name}{method_path}{nifi_id}"
            response = self.call_request(
                api_method, request_url, api_header, pstr_payload=payload
            )
            self.logger.debug("Response from NiFi API: %s", response.content.decode('utf-8'))
            if response.status_code == 200:
                self.logger.info("Successfully changed processor state for ID: %s", nifi_id)
                return True
            self.logger.warning("Failed to change processor state for ID: %s ."
                                "Response: %s", nifi_id,
                                response.content.decode('utf-8'))
            return False
        except (nipyapi.nifi.rest.ApiException, ValueError) as e:
            error_message = f"Error occurred while changing processor state for " \
                            f"ID {nifi_id}: {str(e)}"
            self.__obj_exception.raise_generic_exception(
                message=error_message,
                insert_report=True,
                trim_log=True,
                log_local=True,
                fail_test=False,
            )
            return False

    def change_nifi_processor_state(self, nifi_server: str,
                                    processor_id: str, state: str) -> bool:
        """
        Changes the status of a NiFi processor.

        Args:
            nifi_server (str): Server name.
            processor_id (str): NiFi process ID.
            state (str): RUNNING or STOPPED.

        Returns:
            bool: True if the operation was successful; otherwise, False.

        Examples:
            >> result = ApacheUtils.Nifi().
            change_nifi_processor_state("http://localhost:8080", "processor_id",
            "RUNNING")
        """
        try:
            nifi_server = nipyapi.config.nifi_config.host
            processor = self.__get_processor(processor_id)
            is_scheduled = str.upper(state) == "RUNNING"
            run_status = nipyapi.canvas.schedule_processor(processor[1], scheduled=is_scheduled)
            if run_status:
                self.reporting.insert_step(
                    f"Processor state: {state} should be changed for {nifi_server}",
                    f"Successfully changed processor state: {state}",
                    "Pass",
                )
                self.logger.info("Successfully changed processor %s state to %s."
                                 , processor_id, state)
                return True
            self.reporting.insert_step(
                f"Failed to change processor state: {state}",
                "Failed to change processor state",
                "Fail",
            )
            self.logger.warning("Failed to change processor %s state to %s."
                                , processor_id, state)
            return False

        except (nipyapi.nifi.rest.ApiException, ValueError) as e:
            error_message = f"Error occurred while changing state for processor " \
                            f"{processor_id}: {str(e)}"
            self.__obj_exception.raise_generic_exception(
                message=error_message,
                insert_report=True,
                trim_log=True,
                log_local=True,
                fail_test=False,
            )
            return False

    def about_nifi(self, server_name: str) -> bool:
        """
        Retrieves details about this NiFi.

        Args:
            server_name (str): NiFi server name.

        Returns:
            bool: True if the operation was successful, otherwise False.

        Examples:
            >> info = ApacheUtils.Nifi().about_nifi("http://localhost:8080")
        """
        try:
            str_api_method = "GET"
            api_header = {"Content-Type": "application/json"}
            method_path = "/nifi-api/flow/about"
            request_url = f"{server_name}{method_path}"
            if self.__nifi_token is not None:
                api_header["Authorization"] = self.__nifi_token
            obj_response = self.call_request(str_api_method, request_url, api_header)
            if obj_response.status_code == 200:
                self.reporting.insert_step(
                    "Successfully retrieved info about NiFi",
                    "Successfully retrieved info about NiFi",
                    "Pass",
                )
                return True
            self.reporting.insert_step(
                "Unable to get info about NiFi",
                "Failed to retrieve info about NiFi",
                "Fail",
            )
            return False

        except (nipyapi.nifi.rest.ApiException, ValueError) as e:
            error_message = f"Error occurred while retrieving NiFi info: {str(e)}"
            self.__obj_exception.raise_generic_exception(
                message=error_message,
                insert_report=True,
                trim_log=True,
                log_local=True,
                fail_test=False,
            )
            return False

    def get_flow_files_queue_details(self, connection_id: str) -> list | bool:
        """
        Provides a list of files present in a NiFi queue.

        Args:
            connection_id (str): NiFi connection ID.

        Returns:
            list: List containing the details of all files, or False if an error occurs.

        Examples:
            >> files = ApacheUtils.Nifi().get_flow_files_queue_details("connection_id")
        """
        try:
            obj_listing_request_entity = self.apis.get("flowfile_queues_api"). \
                create_flow_file_listing(connection_id)
            str_uri = obj_listing_request_entity.listing_request.uri
            list_flow_files = self.__get_flow_file_details(str_uri)
            return list_flow_files
        except (nipyapi.nifi.rest.ApiException, ValueError) as e:
            error_message = f"Error occurred while retrieving flow files for connection ID " \
                            f"{connection_id}: {str(e)}"
            self.__obj_exception.raise_generic_exception(
                message=error_message,
                insert_report=True,
                trim_log=True,
                log_local=True,
                fail_test=False,
            )
            return False

    def __get_flow_file_details(self, uri: str) -> list | bool:
        """
        Returns a list of files present in a NiFi queue.

        Args:
            uri (str): URI received after capturing details.

        Returns:
            list: List of files, or False if an error occurs.

        Examples:
            >> files = self.__get_flow_file_details("uri")
        """
        try:
            api_method = "GET"
            api_header = {"Content-Type": "application/json"}
            if self.__nifi_token is not None:
                api_header["Authorization"] = self.__nifi_token
            obj_response = self.call_request(api_method, uri, api_header)
            response_content = obj_response.json()
            file_details = response_content["listingRequest"]["flowFileSummaries"]
            return file_details
        except (nipyapi.nifi.rest.ApiException, ValueError) as e:
            error_message = f"Error occurred while retrieving flow file details " \
                            f"from URI {uri}: {str(e)}"
            self.__obj_exception.raise_generic_exception(
                message=error_message,
                insert_report=True,
                trim_log=True,
                log_local=True,
                fail_test=False,
            )
            return False

    def start_then_stop_pg(self, pg_id: str, wait_time: int = 10) -> bool:
        """
        Starts and stops the NiFi process group.

        Args:
            pg_id (str): The NiFi process group ID.
            wait_time (int): Time to wait before stopping the NiFi process group.

        Returns:
            bool: True if successful; otherwise, False.

        Examples:
            >> result = ApacheUtils.Nifi().start_then_stop_pg("process_group_id", 10)
        """
        try:
            process_group_status = nipyapi.canvas. \
                get_process_group_status(pg_id=pg_id, detail="names")
            if process_group_status is not None:
                self.reporting.insert_step(
                    "Processor group found", "Processor group found", "Pass"
                )
                nipyapi.canvas.schedule_process_group(pg_id, scheduled=True)
                self.logger.info("Process group %s started.", pg_id)
                time.sleep(wait_time)
                nipyapi.canvas.schedule_process_group(pg_id, scheduled=False)
                self.logger.info("Process group %s stopped after %s seconds."
                                 , pg_id, wait_time)
                return True
            self.reporting.insert_step(
                "Processor group not found", "Processor group not found", "Fail"
            )
            self.logger.warning("Process group %s not found.", pg_id)
            return False

        except (nipyapi.nifi.rest.ApiException, ValueError) as e:
            error_message = f"Error occurred while starting and stopping process" \
                            f" group {pg_id}: {str(e)}"
            self.__obj_exception.raise_generic_exception(
                message=error_message,
                insert_report=True,
                trim_log=True,
                log_local=True,
                fail_test=False,
            )
            return False

    def get_access_config(self) -> bool:
        """
        Gets the access config of a NiFi instance.

        Returns:
            bool: Indicates if the function ran successfully.

        Examples:
            >> success = ApacheUtils.Nifi().get_access_config()
        """
        try:
            obj_access_configuration_entity = self.apis.get("access_api").get_login_config()
            if bool(obj_access_configuration_entity.config.to_dict()):
                self.logger.debug("Access configuration retrieved: %s",
                                  obj_access_configuration_entity.config.to_dict())
                self.reporting.insert_step(
                    "Successfully retrieved NiFi access config",
                    "Access configuration retrieved successfully",
                    "Pass",
                )
                return True
            self.reporting.insert_step(
                "Failed to retrieve NiFi access config",
                "Access configuration is empty or invalid",
                "Fail",
            )
            return False

        except (nipyapi.nifi.rest.ApiException, ValueError) as e:
            error_message = f"Error occurred while retrieving NiFi access config: {str(e)}"
            self.__obj_exception.raise_generic_exception(
                message=error_message,
                insert_report=True,
                trim_log=True,
                log_local=True,
                fail_test=False,
            )
            return False

    def get_security_token(self, username: str, password: str, is_password_encrypted: False) -> bool:
        """
        Generates the authorized token used for login into NiFi.

        Args:
            is_password_encrypted: boolean value to check if password is encrypted
            username (str): Username.
            password (str): Password.

        Returns:
            bool: Indicates if the token was generated successfully.

        Examples:
            >> success = ApacheUtils.Nifi().get_security_token("username", "password")
        """
        try:
            bool_token = Security().nifi_get_token(username, password,is_password_encrypted)
            if bool_token[0]:
                self.__nifi_token = bool_token[1]
                self.logger.info("Successfully generated NiFi security token.")
                return True
            self.logger.warning("Failed to generate NiFi security token: Invalid credentials.")
            return False
        except (nipyapi.nifi.rest.ApiException, ValueError) as e:
            error_message = f"Error occurred while generating NiFi security token: {str(e)}"
            self.__obj_exception.raise_generic_exception(
                message=error_message,
                insert_report=True,
                trim_log=True,
                log_local=True,
                fail_test=False,
            )
            return False

    def get_process_group_id(self, pstr_process_group_name,
                             parent_pg_id="root") -> tuple[bool, Any]:
        """
        Retrieves the process group ID.

        Args:
            pstr_process_group_name (str): Process group name.
            parent_pg_id (str): Parent Process Group ID.

        Returns:
            bool: Indicates whether the operation was successful.

        Examples:
            >> success = ApacheUtils.Nifi().get_process_group_id("process_group_name")
        """
        component_id = None
        try:
            process_group_list = nipyapi.canvas.list_all_process_groups(pg_id=parent_pg_id)
            for process_group in process_group_list:
                if process_group.to_dict()["component"]["name"] == pstr_process_group_name:
                    component_id = process_group.to_dict()["component"]["id"]
                    break
            if component_id is not None:
                self.reporting.insert_step(
                    f"Successfully retrieved process group ID for: {pstr_process_group_name}",
                    "Successfully retrieved process group ID",
                    "Pass",
                )
                return True, component_id

            self.reporting.insert_step(
                f"Failed to retrieve process group ID for: {pstr_process_group_name}",
                "Process group not found",
                "Fail",
            )
            return False, component_id
        except (nipyapi.nifi.rest.ApiException, ValueError) as e:
            error_message = f"Error occurred while retrieving process group ID: {str(e)}"
            self.__obj_exception.raise_generic_exception(
                message=error_message,
                insert_report=True,
                trim_log=True,
                log_local=True,
                fail_test=False,
            )
            return False, component_id

    def get_processor_id(self, processor_name: str, parent_pg_id: str = "root") -> bool:
        """
        Retrieves the processor ID.

        Args:
            processor_name (str): Processor name.
            parent_pg_id (str): Parent Process Group ID.

        Returns:
            bool: Indicates if the processor ID was retrieved successfully.

        Examples:
            >> success = ApacheUtils.Nifi().get_processor_id("processor_name")
        """
        component_id = None
        try:
            processor_list = nipyapi.canvas.list_all_processors(pg_id=parent_pg_id)
            for processor in processor_list:
                if processor.to_dict()["component"]["name"] == processor_name:
                    component_id = processor.to_dict()["component"]["id"]
                    break
            if component_id is not None:
                self.reporting.insert_step(
                    f"Successfully retrieved processor ID for: {processor_name}",
                    "Successfully retrieved processor ID",
                    "Pass",
                )
                return True
            self.reporting.insert_step(
                f"Failed to retrieve processor ID for: {processor_name}",
                "Processor not found",
                "Fail",
            )
            return False
        except (nipyapi.nifi.rest.ApiException, ValueError) as e:
            error_message = f"Error occurred while retrieving processor ID: {str(e)}"
            self.__obj_exception.raise_generic_exception(
                message=error_message,
                insert_report=True,
                trim_log=True,
                log_local=True,
                fail_test=False,
            )
            return False

    def __get_processor(self, processor_id: str) -> tuple[bool, Any]:
        """
        Retrieves the processor object.

        Args:
            processor_id (str): Processor ID.

        Returns:
            bool: Indicates if the processor was retrieved successfully.

        Examples:
            >> success = ApacheUtils.Nifi().__get_processor("processor_id")
        """
        processor = None
        try:
            processor = nipyapi.canvas.get_processor(processor_id, identifier_type="id")
            if processor is not None:
                self.reporting.insert_step(
                    f"Successfully retrieved processor details: {processor_id}",
                    "Successfully retrieved processor details",
                    "Pass",
                )
                return True, processor
            self.reporting.insert_step(
                f"Failed to retrieve processor details: {processor_id}",
                "Unable to get processor details",
                "Fail",
            )
            return False, processor

        except (nipyapi.nifi.rest.ApiException, ValueError) as e:
            error_message = f"Error occurred while retrieving processor" \
                            f" ID {processor_id}: {str(e)}"
            self.__obj_exception.raise_generic_exception(
                message=error_message,
                insert_report=True,
                trim_log=True,
                log_local=True,
                fail_test=False,
            )
            return False, processor

    def get_component_connections(self, processor_id: str,
                                  return_list: bool = False) -> tuple[bool, dict]:
        """
        Retrieves the connections of a component/processor.

        Args:
            processor_id (str): Processor ID.
            return_list (bool): Return type identifier.

        Returns:
            bool, dict: Tuple indicating 'execution_result' and connections
            dictionary object.

        Examples:
            >> success, connections = ApacheUtils.Nifi().
            get_component_connections("processor_id")
        """
        connections_dict = {"source": {}, "destination": {}}

        try:
            execution, processor = self.__get_processor(processor_id)

            if execution:
                connections = nipyapi.canvas.get_component_connections(processor)
                for connection in connections:
                    connection_status = connection.to_dict()["status"]
                    connection_name = connection_status["name"]
                    connection_id = connection_status["id"]

                    if connection_status["source_id"] == processor_id:
                        if return_list:
                            connections_dict["source"].setdefault(connection_name, []). \
                                append(connection_id)
                        else:
                            connections_dict["source"][connection_name] = connection_id

                    elif connection_status["destination_id"] == processor_id:
                        if return_list:
                            connections_dict["destination"]. \
                                setdefault(connection_name, []).append(connection_id)
                        else:
                            connections_dict["destination"][connection_name] = connection_id

                if connections:
                    self.reporting.insert_step(
                        f"Successfully retrieved component connections for: {processor_id}",
                        "Successfully retrieved component connections",
                        "Pass",
                    )
                    return True, connections_dict

                self.reporting.insert_step(
                    f"Unable to get component connections for: {processor_id}",
                    "No connections found",
                    "Fail",
                )
                return False, connections_dict

        except (nipyapi.nifi.rest.ApiException, ValueError) as e:
            error_message = f"Error occurred while retrieving component " \
                            f"connections for {processor_id}: {str(e)}"
            self.__obj_exception.raise_generic_exception(
                message=error_message,
                insert_report=True,
                trim_log=True,
                log_local=True,
                fail_test=False,
            )
            return False, connections_dict

    def list_queue_data(self, connection_id: str) -> list | None:
        """
        Lists the information of the queue in this connection.

        Args:
            connection_id (str): Connection ID.

        Returns:
            ListingRequestEntity: Lists the queue details.

        Examples:
            >> queue_data = ApacheUtils.Nifi().list_queue_data("connection_id")
        """
        try:
            listing_request = self.apis.get("flowfile_queues_api"). \
                create_flow_file_listing(connection_id)
            if listing_request is not None:
                self.reporting.insert_step(
                    "Successfully listed queue connection data",
                    "Successfully listed queue connection data",
                    "Pass",
                )
                return listing_request
            self.reporting.insert_step(
                "Failed to list queue connection data",
                "No data returned for the queue connection",
                "Fail",
            )
            return None

        except (nipyapi.nifi.rest.ApiException, ValueError) as e:
            error_message = f"Error occurred while listing queue data for connection " \
                            f"ID {connection_id}: {str(e)}"
            self.__obj_exception.raise_generic_exception(
                message=error_message,
                insert_report=True,
                trim_log=True,
                log_local=True,
                fail_test=False,
            )
            return None

    def delete_queue_data(self, connection_id: str) -> bool:
        """
        Deletes the contents of the queue in the connection.

        Args:
            connection_id (str): Connection ID.

        Returns:
            bool: True if deletion was successful; otherwise, False.

        Examples:
            >> success = ApacheUtils.Nifi().delete_queue_data("connection_id")
        """
        try:
            drop_req_id = self.apis.get("flowfile_queues_api").create_drop_request(connection_id)

            if drop_req_id is not None:
                self.reporting.insert_step(
                    "Successfully deleted queue connection data",
                    "Successfully deleted queue connection data",
                    "Pass",
                )
                return True
            self.reporting.insert_step(
                "Failed to delete queue connection data",
                "Unable to delete queue connection data",
                "Fail",
            )
            return False

        except (nipyapi.nifi.rest.ApiException, ValueError) as e:
            error_message = f"Error occurred while deleting queue data for connection " \
                            f"ID {connection_id}: {str(e)}"
            self.__obj_exception.raise_generic_exception(
                message=error_message,
                insert_report=True,
                trim_log=True,
                log_local=True,
                fail_test=False,
            )
            return False

    def list_connections(self, pg_id: str = "root", key_path: str = None) -> list:
        """
        Lists the connections of the queue in the process group.

        Args:
            pg_id (str): Process Group ID.
            key_path (str): Path of the field to be retrieved.

        Returns:
            list: Connections list or specified key path values.

        Examples:
            >> connections = ApacheUtils.Nifi().list_connections("process_group_id")
        """
        try:
            connections_list = []
            connection_list = nipyapi.canvas.list_all_connections(pg_id=pg_id)
            for conn in connection_list:
                if key_path:
                    field_values = self.get_key_path_value(
                        json=conn.to_dict(), keyPath=key_path, keyPathType="absolute"
                    )
                    connections_list.append(field_values)
                else:
                    connections_list.append(conn)

            return connections_list

        except (nipyapi.nifi.rest.ApiException, ValueError) as e:
            error_message = f"Error occurred while listing connections for " \
                            f"process group ID {pg_id}: {str(e)}"
            self.__obj_exception.raise_generic_exception(
                message=error_message,
                insert_report=True,
                trim_log=True,
                log_local=True,
                fail_test=False,
            )
            return []

    def get_process_groups(self, pg_id: str = "root", key_path: str = None) -> list:
        """
        Retrieves details of process groups under the mentioned process group recursively.

        Args:
            pg_id (str): Process Group ID.
            key_path (str): Path of the field to be retrieved.

        Returns:
            list: Process groups list or specified key path values.

        Examples:
            >> process_groups = ApacheUtils.Nifi().
            get_process_groups("process_group_id")
        """
        try:
            pgs_list = []
            pg_list = nipyapi.canvas.list_all_process_groups(pg_id=pg_id)
            for pg in pg_list:
                if key_path:
                    field_values = self.get_key_path_value(
                        json=pg.to_dict(), keyPath=key_path, keyPathType="absolute"
                    )
                    pgs_list.append(field_values)
                else:
                    pgs_list.append(pg)
            return pgs_list

        except (nipyapi.nifi.rest.ApiException, ValueError) as e:
            error_message = f"Error occurred while retrieving process groups for " \
                            f"ID {pg_id}: {str(e)}"
            self.__obj_exception.raise_generic_exception(
                message=error_message,
                insert_report=True,
                trim_log=True,
                log_local=True,
                fail_test=False,
            )
            return []

    def get_processors(self, pg_id: str = "root", key_path: str = None) -> list:
        """
        Retrieves details of processors under the mentioned process group recursively.

        Args:
            pg_id (str): Process Group ID.
            key_path (str): Path of the field to be retrieved.

        Returns:
            list: Processors list or specified key path values.

        Examples:
            >> processors = ApacheUtils.Nifi().get_processors("process_group_id")
        """
        try:
            processors_list = []
            processor_list = nipyapi.canvas.list_all_processors(pg_id=pg_id)
            for processor in processor_list:
                if key_path:
                    field_values = self.get_key_path_value(
                        json=processor.to_dict(), keyPath=key_path,
                        keyPathType="absolute"
                    )
                    processors_list.append(field_values)
                else:
                    processors_list.append(processor)

            return processors_list

        except (nipyapi.nifi.rest.ApiException, ValueError) as e:
            error_message = f"Error occurred while retrieving processors for " \
                            f"process group ID {pg_id}: {str(e)}"
            self.__obj_exception.raise_generic_exception(
                message=error_message,
                insert_report=True,
                trim_log=True,
                log_local=True,
                fail_test=False,
            )
            return []

    def get_remote_process_groups(self, pg_id: str = "root", key_path: str = None) -> list:
        """
        Retrieves all remote processor groups under the mentioned process group recursively.

        Args:
            pg_id (str): Process Group ID.
            key_path (str): Path of the field to be retrieved.

        Returns:
            list: Remote processor groups list or specified key path values.

        Examples:
            >> remote_groups = ApacheUtils.Nifi().get_remote_process_groups("process_group_id")
        """
        try:
            rpgs_list = []
            rpg_list = nipyapi.canvas.list_all_remote_process_groups(pg_id=pg_id)

            for pg in rpg_list:
                if key_path:
                    field_values = self.get_key_path_value(
                        json=pg.to_dict(), keyPath=key_path, keyPathType="absolute"
                    )
                    rpgs_list.append(field_values)
                else:
                    rpgs_list.append(pg)

            return rpgs_list

        except (nipyapi.nifi.rest.ApiException, ValueError) as e:
            error_message = f"Error occurred while retrieving remote process groups for " \
                            f"process group ID {pg_id}: {str(e)}"
            self.__obj_exception.raise_generic_exception(
                message=error_message,
                insert_report=True,
                trim_log=True,
                log_local=True,
                fail_test=False,
            )
            return []

    def change_remote_process_group_state(self, rpg_id: str, enable: bool) -> bool:
        """
        Changes the state of the remote process group.

        Args:
            rpg_id (str): Remote Process Group ID.
            enable (bool): True to enable; False to disable.

        Returns:
            bool: Status of completion.

        Examples:
            >> success = ApacheUtils.Nifi().
            change_remote_process_group_state("remote_group_id", True)
        """
        try:
            status = nipyapi.canvas.set_remote_process_group_transmission(
                rpg_id, enable=enable, refresh=True
            )

            if status is not None:
                self.reporting.insert_step(
                    "Successfully changed the state of the remote process group.",
                    "State change completed successfully.",
                    "Pass",
                )
                return True
            self.reporting.insert_step(
                "Failed to change the state of the remote process group.",
                "No status returned from the operation.",
                "Fail",
            )
            return False

        except (nipyapi.nifi.rest.ApiException, ValueError) as e:
            error_message = f"Error occurred while changing the state of remote " \
                            f"process group {rpg_id}: {str(e)}"
            self.__obj_exception.raise_generic_exception(
                message=error_message,
                insert_report=True,
                trim_log=True,
                log_local=True,
                fail_test=False,
            )
            return False

    def get_process_group_q_count(self, process_group_id: str) -> int:
        """
        Gets the queue count of documents in the NiFi Process group.

        Args:
            process_group_id (str): NiFi process group ID.

        Returns:
            int: Queue count of the process group.

        Examples:
            >> count = ApacheUtils.Nifi().
            get_process_group_q_count("process_group_id")
        """
        try:
            key_path = "status/aggregate_snapshot/queued_count"
            process_group = self.nifi_module.canvas.get_process_group(
                process_group_id, identifier_type="id"
            )
            group_q_count = self.get_key_path_value(
                json=process_group.to_dict(), keyPath=key_path, keyPathType="absolute"
            )

            return group_q_count

        except (nipyapi.nifi.rest.ApiException, ValueError) as e:
            error_message = f"Error occurred while retrieving queue count for process " \
                            f"group ID " \
                            f"{process_group_id}: {str(e)}"
            self.__obj_exception.raise_generic_exception(
                message=error_message,
                insert_report=True,
                trim_log=True,
                log_local=True,
                fail_test=False,
            )
            return 0

    def get_processor_q_count(self, processor_id: str) -> int:
        """
        Gets the queue count of documents in the NiFi Processor.

        Args:
            processor_id (str): NiFi processor ID.

        Returns:
            int: Queue count of the processor.

        Examples:
            >> count = ApacheUtils.Nifi().get_processor_q_count("processor_id")
        """
        try:
            key_path = "status/aggregate_snapshot/queued_count"
            processor = self.nifi_module.canvas.get_processor(
                processor_id, identifier_type="id"
            )
            processor_q_count = self.get_key_path_value(
                json=processor.to_dict(), keyPath=key_path, keyPathType="absolute"
            )

            return processor_q_count

        except (nipyapi.nifi.rest.ApiException, ValueError) as e:
            error_message = f"Error occurred while retrieving queue count for processor ID " \
                            f"{processor_id}: {str(e)}"
            self.__obj_exception.raise_generic_exception(
                message=error_message,
                insert_report=True,
                trim_log=True,
                log_local=True,
                fail_test=False,
            )
            return 0

    def enable_processor(
            self,
            server_name: str,
            processor_id: str,
            max_wait_time: int = 60,
            wait_interval: int = 5,
            end_point: str = "/nifi-api/processors/{processor_id}/run-status",
    ):
        """
        Enables the processor and keeps it in a stopped state.

        Args:
            server_name (str): NiFi server URL.
            processor_id (str): NiFi processor ID.
            max_wait_time (int): Max wait time to wait for processor to enable.
            wait_interval (int): Interval time to check the status.
            end_point (str): Service endpoint to invoke API call.

        Returns:
            bool: True if successful; otherwise, False.

        Examples:
            >> result = ApacheUtils.Nifi().
            enable_processor("http://localhost:8080", "processor_id")
        """
        try:
            _, dict_processor_data = self.__get_processor(processor_id)
            dict_payload = {
                "revision": {
                    "clientId": dict_processor_data.revision.client_id,
                    "version": dict_processor_data.revision.version,
                },
                "state": "STOPPED",
            }
            str_api_method = "PUT"
            dict_api_header = {"Content-Type": "application/json"}
            if self.__nifi_token is not None:
                dict_api_header["Authorization"] = self.__nifi_token

            str_request_url = f"{server_name}{end_point.format(processor_id=processor_id)}"
            self.call_request(
                str_api_method,
                str_request_url,
                dict_api_header,
                pstr_payload=json.dumps(dict_payload),
            )
            count = 0
            max_count = max_wait_time // wait_interval

            while count < max_count:
                time.sleep(wait_interval)
                str_path = "status/aggregate_snapshot/run_status"
                _, processor_data = self.__get_processor(processor_id)
                value = self.get_key_path_value(
                    json=processor_data.to_dict(), keyPath=str_path, keyPathType="absolute"
                )

                count += 1
                if value.strip().lower() != "validating":
                    break
            else:
                self.reporting.insert_step(
                    f"Processor ID {processor_id} should get enabled.",
                    f"Processor is not getting enabled after: {max_wait_time} seconds.",
                    "Fail",
                )
                return False

            self.reporting.insert_step(
                f"Successfully enabled processor: {processor_id}",
                "Processor has been successfully enabled.",
                "Pass",
            )
            return True

        except (nipyapi.nifi.rest.ApiException, ValueError) as e:
            error_message = f"Error occurred while enabling processor ID " \
                            f"{processor_id}: {str(e)}"
            self.__obj_exception.raise_generic_exception(
                message=error_message,
                insert_report=True,
                trim_log=True,
                log_local=True,
                fail_test=False,
            )
            return False

    def disable_processor(
            self,
            server_name: str,
            processor_id: str,
            max_wait_time: int = 60,
            wait_interval: int = 5,
            end_point: str = "/nifi-api/processors/{processor_id}/run-status",
    ) -> bool:
        """
        Disables the processor.

        Args:
            server_name (str): NiFi server URL.
            processor_id (str): NiFi processor ID.
            max_wait_time (int): Max wait time to wait for processor to disable.
            wait_interval (int): Interval time to check the status.
            end_point (str): Service endpoint to invoke API call.

        Returns:
            bool: True if successful; otherwise, False.

        Examples:
            >> result = ApacheUtils.Nifi().
            disable_processor("http://localhost:8080", "processor_id")
        """
        try:
            _, dict_processor_data = self.__get_processor(processor_id)
            dict_payload = {
                "revision": {
                    "clientId": dict_processor_data.revision.client_id,
                    "version": dict_processor_data.revision.version,
                },
                "state": "DISABLED",
            }
            str_api_method = "PUT"
            dict_api_header = {"Content-Type": "application/json"}
            if self.__nifi_token is not None:
                dict_api_header["Authorization"] = self.__nifi_token

            str_request_url = f"{server_name}{end_point.format(processor_id=processor_id)}"
            self.call_request(
                str_api_method,
                str_request_url,
                dict_api_header,
                pstr_payload=json.dumps(dict_payload),
            )
            count = 0
            max_count = max_wait_time // wait_interval

            while count < max_count:
                time.sleep(wait_interval)
                str_path = "status/aggregate_snapshot/active_thread_count"
                _, str_processor_data = self.__get_processor(processor_id)
                value = self.get_key_path_value(
                    json=str_processor_data.to_dict(), keyPath=str_path, keyPathType="absolute"
                )

                if int(value) == 0:
                    break

                count += 1
            else:
                self.reporting.insert_step(
                    f"Processor {processor_id} should be disabled.",
                    f"Processor is not getting disabled after {max_wait_time} seconds.",
                    "Fail",
                )
                return False
            self.reporting.insert_step(
                f"Processor {processor_id} has been successfully disabled.",
                "Processor has been disabled.",
                "Pass",
            )
            return True

        except (nipyapi.nifi.rest.ApiException, ValueError) as e:
            error_message = f"Error occurred while disabling processor ID " \
                            f"{processor_id}: {str(e)}"
            self.__obj_exception.raise_generic_exception(
                message=error_message,
                insert_report=True,
                trim_log=True,
                log_local=True,
                fail_test=False,
            )
            return False

    def clear_queues(
            self, processor_id: str, inbound_queue: bool = True, outbound_queue: bool = True
    ) -> bool:
        """
        Clears the in/out queues for the given processor based on input parameters.

        Args:
            processor_id (str): NiFi processor ID.
            inbound_queue (bool): If True, clears the input queue for the processor.
            outbound_queue (bool): If True, clears the output queue for the processor.

        Returns:
            bool: True if successful; otherwise, False.

        Examples:
            >> result = ApacheUtils.Nifi().clear_queues("processor_id")
        """
        try:
            _, dict_connections = self.get_component_connections(processor_id, True)
            if inbound_queue:
                for key, val in dict_connections["source"].items():
                    for connection_id in val:
                        if not self.delete_queue_data(connection_id):
                            self.reporting.insert_step(
                                "Failed to clear input queue",
                                f"Error occurred while deleting input "
                                f"connection: {connection_id}",
                                "Fail",
                            )
                            return False

                self.reporting.insert_step(
                    f"Successfully cleared all input queues for processor ID: {processor_id}",
                    "All input queues cleared.",
                    "Pass",
                )
            if outbound_queue:
                for key, val in dict_connections["destination"].items():
                    for connection_id in val:
                        if not self.delete_queue_data(connection_id):
                            self.reporting.insert_step(
                                "Failed to clear output queue",
                                f"Error occurred while deleting output "
                                f"connection: {connection_id}",
                                "Fail",
                            )
                            return False

                self.reporting.insert_step(
                    f"Successfully cleared all output queues for processor ID: {processor_id}",
                    "All output queues cleared.",
                    "Pass",
                )

            return True

        except (nipyapi.nifi.rest.ApiException, ValueError) as e:
            error_message = f"Error occurred while clearing queues for processor " \
                            f"ID {processor_id}: {str(e)}"
            self.__obj_exception.raise_generic_exception(
                message=error_message,
                insert_report=True,
                trim_log=True,
                log_local=True,
                fail_test=False,
            )
            return False

    def start_then_stop_processor(
            self,
            server_name: str,
            processor_id: str,
            min_wait_time: int = 0,
            max_wait_time: int = 50,
            wait_interval: int = 5,
    ) -> bool:
        """
        Starts and stops the given processor.

        Args:
            server_name (str): NiFi server URL.
            processor_id (str): NiFi processor ID.
            min_wait_time (int): Minimum wait time in seconds.
            max_wait_time (int): Maximum wait time in seconds.
            wait_interval (int): Polling time to check each time in seconds.

        Returns:
            bool: True if successful; otherwise, False.

        Examples:
            >> result = ApacheUtils.Nifi().
            start_then_stop_processor("http://localhost:8080", "processor_id")
        """
        try:
            self.change_nifi_processor_state(server_name, processor_id, "RUNNING")
            time.sleep(min_wait_time)
            if wait_interval <= 0:
                self.reporting.insert_step(
                    "Invalid wait interval",
                    "Wait interval must be greater than 0",
                    "Fail",
                )
                return False
            limit = max_wait_time // wait_interval
            count = 0
            while count < limit:
                time.sleep(wait_interval)
                path = "status/aggregate_snapshot/active_thread_count"
                _, processor_data = self.__get_processor(processor_id)
                json_counter = self.get_key_path_value(
                    json=processor_data.to_dict(), keyPath=path, keyPathType="absolute"
                )

                if int(json_counter) == 0:
                    break

                count += 1
            else:
                self.reporting.insert_step(
                    f"Processor {processor_id} should not have active threads.",
                    f"Processor is taking more than {max_wait_time} seconds to stop.",
                    "Fail",
                )
                return False
            self.change_nifi_processor_state(server_name, processor_id, "STOPPED")
            self.reporting.insert_step(
                f"Processor {processor_id} has been successfully started and stopped.",
                "Processor started and stopped successfully.",
                "Pass",
            )
            return True

        except (nipyapi.nifi.rest.ApiException, ValueError) as e:
            error_message = f"Error occurred while starting and stopping processor" \
                            f" ID {processor_id}: {str(e)}"
            self.__obj_exception.raise_generic_exception(
                message=error_message,
                insert_report=True,
                trim_log=True,
                log_local=True,
                fail_test=False,
            )
            return False

    def call_request(self, method: str, url: str, headers: dict, **kwargs):
        """
        Performs various HTTP requests (GET, POST, PUT, PATCH, DELETE).

        Args:
            method (str): The HTTP method (e.g., 'GET', 'POST').
            url (str): The request URL.
            headers (dict): Request headers.

        Kwargs:
            pstr_json (str): JSON data for the request body.
            pstr_payload (dict): Data for the request body.
            pdict_cookies (dict): Cookies for the request.
            pbln_allow_redirects (bool): Allow or disallow redirects.
            pstr_files (str): File path for file uploads.
            pbln_verify (bool): Verify SSL certificates.
            pstr_auth_type (str): Authentication type (e.g., 'basic', 'digest').
            pstr_auth_username (str): Username for authentication.
            pstr_auth_password (str): Password for authentication.
            ptimeout (float or tuple): Timeout in seconds for the request.
            pdict_proxies (dict): Proxies for the request.

        Returns:
            requests.Response: The response object from the request.

        Examples:
            >> response = ApacheUtils.Nifi().
            call_request("GET", "https://www.samplesite.com/api",
            headers={"Accept": "application/json"})
        """
        if not url:
            raise ValueError("URL cannot be null")
        json_data = kwargs.get("json_data")
        payload = kwargs.get("payload")
        cookies = kwargs.get("cookies", {})
        allow_redirects = kwargs.get("allow_redirects", False)
        files = kwargs.get("files")
        verify = kwargs.get("verify", False)
        auth_type = kwargs.get("auth_type")
        auth_username = kwargs.get("auth_username")
        auth_password = kwargs.get("auth_password")
        timeout = kwargs.get("timeout")
        proxies = kwargs.get("proxies")
        auth_string = ""
        if auth_type:
            auth_string = self.security.get_auth_string(
                auth_type, auth_username, auth_password
            )
        method = method.upper()
        try:
            if method == "GET":
                response = requests.get(
                    url,
                    headers=headers,
                    verify=verify,
                    allow_redirects=allow_redirects,
                    cookies=cookies,
                    auth=auth_string,
                    timeout=timeout,
                    proxies=proxies,
                )
            elif method in ["POST", "PUT", "PATCH"]:
                if payload is None:
                    raise ValueError("Payload is required for POST, PUT, and PATCH requests.")
                response = requests.request(
                    method,
                    url,
                    headers=headers,
                    data=payload,
                    json=json_data,
                    verify=verify,
                    allow_redirects=allow_redirects,
                    cookies=cookies,
                    files=files,
                    auth=auth_string,
                    timeout=timeout,
                    proxies=proxies,
                )
            elif method == "DELETE":
                response = requests.delete(
                    url,
                    headers=headers,
                    verify=verify,
                    allow_redirects=allow_redirects,
                    cookies=cookies,
                    auth=auth_string,
                    data=payload,
                    json=json_data,
                    timeout=timeout,
                    proxies=proxies,
                )
            else:
                raise ValueError(f"Invalid HTTP method: {method}. Valid "
                                 f"options are: GET, POST, PUT, PATCH, DELETE")
            return response
        except Exception as e:
            self.logger.exception("Error in Apache call request method: %s", str(e))
            raise e

    def get_key_path_value(self, **kwargs: Any) -> Any:
        """
        Extracts the value at the specified key path from the JSON data.

        Kwargs:
            json: The JSON data (string or dictionary).
            keyPath: The path to the key, using the specified delimiter.
            keyPathType: Either "absolute" or "relative" (default: "absolute").
            delimiter: The delimiter used in the key path (default: "/").
            key: The key to retrieve the value for when using relative key paths.

        Returns:
            The value associated with the key path.

        Raises:
            ValueError: If required arguments are missing, invalid, or the key path
            is not found.
            json.JSONDecodeError: If the JSON data is invalid.

        Examples:
            >> value = ApacheUtils.Nifi().
            get_key_path_value(json='{"key": "value"}', keyPath='key')
        """
        try:
            if "json" not in kwargs:
                self.logger.info("No json argument provided")
                raise ValueError("json argument is required.")
            if "keyPath" not in kwargs:
                self.logger.info("No keyPath argument provided")
                raise ValueError("keyPath argument is required.")
            if "keyPathType" not in kwargs:
                self.logger.info("No keyPathType argument provided")
                raise ValueError("keyPathType argument is required.")
            obj_parse_data = ParseJsonData()
            return obj_parse_data.get_value_from_key_path(**kwargs)
        except Exception as e:
            self.logger.exception("Error in extracting the value at the specified "
                                  "key path: %s", e)
            raise e

    def get_processor_properties(self, processor_id: str) -> dict | bool:
        """
        Retrieves the configuration properties of a specified NiFi processor.

        Args:
            processor_id (str): NiFi processor ID.

        Returns:
            dict: A dictionary of properties if successful; otherwise, False.

        Examples:
            >> properties = ApacheUtils.Nifi().get_processor_properties("processor_id")
        """

        try:
            processor = nipyapi.canvas.get_processor(processor_id)
            if processor is not None:
                properties = processor.to_dict()["component"]["config"]
                self.reporting.insert_step(
                    f"Successfully retrieved properties for processor ID: {processor_id}",
                    "Properties retrieved successfully",
                    "Pass",
                )
                return properties
            self.reporting.insert_step(
                f"Failed to retrieve properties for processor ID: {processor_id}",
                "Processor not found",
                "Fail",
            )
            return False
        except (nipyapi.nifi.rest.ApiException, ValueError) as e:
            error_message = f"Error occurred while retrieving properties for processor " \
                            f"ID {processor_id}: {str(e)}"
            self.__obj_exception.raise_generic_exception(
                message=error_message,
                insert_report=True,
                trim_log=True,
                log_local=True,
                fail_test=False,
            )
            return False

    def update_processor_properties(self, processor_id: str, properties: dict) -> bool:
        """
        Updates the properties of a specified NiFi processor with the provided properties.

        Args:
            processor_id (str): NiFi processor ID.
            properties (dict): A dictionary containing the properties to update.

        Returns:
            bool: True if the update was successful; otherwise, False.

        Examples:
            >> success = ApacheUtils.Nifi().
            update_processor_properties("processor_id", {"property_name": "value"})

        """
        try:
            processor = nipyapi.canvas.get_processor(processor_id)
            if processor is not None:
                # Prepare the payload for updating properties
                payload = {
                    "revision": {
                        "clientId": processor.revision.client_id,
                        "version": processor.revision.version,
                    },
                    "component": {
                        "config": properties
                    }
                }
                response = self.call_request(
                    "PUT",
                    f"/nifi-api/processors/{processor_id}",
                    {"Content-Type": "application/json"},
                    pstr_payload=json.dumps(payload)
                )
                if response.status_code == 200:
                    self.reporting.insert_step(
                        f"Successfully updated properties for processor ID: {processor_id}",
                        "Properties updated successfully",
                        "Pass",
                    )
                    return True
                self.reporting.insert_step(
                    f"Failed to update properties for processor ID: {processor_id}",
                    "Update failed",
                    "Fail",
                )
                return False
        except (nipyapi.nifi.rest.ApiException, ValueError) as e:
            error_message = f"Error occurred while updating properties for processor ID " \
                            f"{processor_id}: {str(e)}"
            self.__obj_exception.raise_generic_exception(
                message=error_message,
                insert_report=True,
                trim_log=True,
                log_local=True,
                fail_test=False,
            )
            return False

    def get_flow_file_count(self, connection_id: str) -> int:
        """
        Retrieves the count of flow files in a specified NiFi connection.

        Args:
            connection_id (str): The ID of the connection.

        Returns:
            int: The count of flow files.

        Examples:
            >> count = ApacheUtils.Nifi().get_flow_file_count("connection_id")

        """
        try:
            flow_file_listing = self.apis.get("flowfile_queues_api"). \
                create_flow_file_listing(connection_id)
            str_uri = flow_file_listing.listing_request.uri
            flow_file_details = self.__get_flow_file_details(str_uri)
            return len(flow_file_details)  # Count of flow files
        except (nipyapi.nifi.rest.ApiException, ValueError) as e:
            error_message = f"Error occurred while retrieving flow file count for connection " \
                            f"ID {connection_id}: {str(e)}"
            self.__obj_exception.raise_generic_exception(
                message=error_message,
                insert_report=True,
                trim_log=True,
                log_local=True,
                fail_test=False,
            )
            return 0

__get_flow_file_details(uri)

Returns a list of files present in a NiFi queue.

Parameters:

Name Type Description Default
uri str

URI received after capturing details.

required

Returns:

Name Type Description
list list | bool

List of files, or False if an error occurs.

Examples:

files = self.__get_flow_file_details("uri")

Source code in libs\cafex_core\src\cafex_core\utils\apache_utils.py
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
def __get_flow_file_details(self, uri: str) -> list | bool:
    """
    Returns a list of files present in a NiFi queue.

    Args:
        uri (str): URI received after capturing details.

    Returns:
        list: List of files, or False if an error occurs.

    Examples:
        >> files = self.__get_flow_file_details("uri")
    """
    try:
        api_method = "GET"
        api_header = {"Content-Type": "application/json"}
        if self.__nifi_token is not None:
            api_header["Authorization"] = self.__nifi_token
        obj_response = self.call_request(api_method, uri, api_header)
        response_content = obj_response.json()
        file_details = response_content["listingRequest"]["flowFileSummaries"]
        return file_details
    except (nipyapi.nifi.rest.ApiException, ValueError) as e:
        error_message = f"Error occurred while retrieving flow file details " \
                        f"from URI {uri}: {str(e)}"
        self.__obj_exception.raise_generic_exception(
            message=error_message,
            insert_report=True,
            trim_log=True,
            log_local=True,
            fail_test=False,
        )
        return False

__get_processor(processor_id)

Retrieves the processor object.

Parameters:

Name Type Description Default
processor_id str

Processor ID.

required

Returns:

Name Type Description
bool tuple[bool, Any]

Indicates if the processor was retrieved successfully.

Examples:

success = ApacheUtils.Nifi().__get_processor("processor_id")

Source code in libs\cafex_core\src\cafex_core\utils\apache_utils.py
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
def __get_processor(self, processor_id: str) -> tuple[bool, Any]:
    """
    Retrieves the processor object.

    Args:
        processor_id (str): Processor ID.

    Returns:
        bool: Indicates if the processor was retrieved successfully.

    Examples:
        >> success = ApacheUtils.Nifi().__get_processor("processor_id")
    """
    processor = None
    try:
        processor = nipyapi.canvas.get_processor(processor_id, identifier_type="id")
        if processor is not None:
            self.reporting.insert_step(
                f"Successfully retrieved processor details: {processor_id}",
                "Successfully retrieved processor details",
                "Pass",
            )
            return True, processor
        self.reporting.insert_step(
            f"Failed to retrieve processor details: {processor_id}",
            "Unable to get processor details",
            "Fail",
        )
        return False, processor

    except (nipyapi.nifi.rest.ApiException, ValueError) as e:
        error_message = f"Error occurred while retrieving processor" \
                        f" ID {processor_id}: {str(e)}"
        self.__obj_exception.raise_generic_exception(
            message=error_message,
            insert_report=True,
            trim_log=True,
            log_local=True,
            fail_test=False,
        )
        return False, processor

about_nifi(server_name)

Retrieves details about this NiFi.

Parameters:

Name Type Description Default
server_name str

NiFi server name.

required

Returns:

Name Type Description
bool bool

True if the operation was successful, otherwise False.

Examples:

info = ApacheUtils.Nifi().about_nifi("http://localhost:8080")

Source code in libs\cafex_core\src\cafex_core\utils\apache_utils.py
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
def about_nifi(self, server_name: str) -> bool:
    """
    Retrieves details about this NiFi.

    Args:
        server_name (str): NiFi server name.

    Returns:
        bool: True if the operation was successful, otherwise False.

    Examples:
        >> info = ApacheUtils.Nifi().about_nifi("http://localhost:8080")
    """
    try:
        str_api_method = "GET"
        api_header = {"Content-Type": "application/json"}
        method_path = "/nifi-api/flow/about"
        request_url = f"{server_name}{method_path}"
        if self.__nifi_token is not None:
            api_header["Authorization"] = self.__nifi_token
        obj_response = self.call_request(str_api_method, request_url, api_header)
        if obj_response.status_code == 200:
            self.reporting.insert_step(
                "Successfully retrieved info about NiFi",
                "Successfully retrieved info about NiFi",
                "Pass",
            )
            return True
        self.reporting.insert_step(
            "Unable to get info about NiFi",
            "Failed to retrieve info about NiFi",
            "Fail",
        )
        return False

    except (nipyapi.nifi.rest.ApiException, ValueError) as e:
        error_message = f"Error occurred while retrieving NiFi info: {str(e)}"
        self.__obj_exception.raise_generic_exception(
            message=error_message,
            insert_report=True,
            trim_log=True,
            log_local=True,
            fail_test=False,
        )
        return False

call_request(method, url, headers, **kwargs)

Performs various HTTP requests (GET, POST, PUT, PATCH, DELETE).

Parameters:

Name Type Description Default
method str

The HTTP method (e.g., 'GET', 'POST').

required
url str

The request URL.

required
headers dict

Request headers.

required
Kwargs

pstr_json (str): JSON data for the request body. pstr_payload (dict): Data for the request body. pdict_cookies (dict): Cookies for the request. pbln_allow_redirects (bool): Allow or disallow redirects. pstr_files (str): File path for file uploads. pbln_verify (bool): Verify SSL certificates. pstr_auth_type (str): Authentication type (e.g., 'basic', 'digest'). pstr_auth_username (str): Username for authentication. pstr_auth_password (str): Password for authentication. ptimeout (float or tuple): Timeout in seconds for the request. pdict_proxies (dict): Proxies for the request.

Returns:

Type Description

requests.Response: The response object from the request.

Examples:

response = ApacheUtils.Nifi(). call_request("GET", "https://www.samplesite.com/api", headers={"Accept": "application/json"})

Source code in libs\cafex_core\src\cafex_core\utils\apache_utils.py
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
def call_request(self, method: str, url: str, headers: dict, **kwargs):
    """
    Performs various HTTP requests (GET, POST, PUT, PATCH, DELETE).

    Args:
        method (str): The HTTP method (e.g., 'GET', 'POST').
        url (str): The request URL.
        headers (dict): Request headers.

    Kwargs:
        pstr_json (str): JSON data for the request body.
        pstr_payload (dict): Data for the request body.
        pdict_cookies (dict): Cookies for the request.
        pbln_allow_redirects (bool): Allow or disallow redirects.
        pstr_files (str): File path for file uploads.
        pbln_verify (bool): Verify SSL certificates.
        pstr_auth_type (str): Authentication type (e.g., 'basic', 'digest').
        pstr_auth_username (str): Username for authentication.
        pstr_auth_password (str): Password for authentication.
        ptimeout (float or tuple): Timeout in seconds for the request.
        pdict_proxies (dict): Proxies for the request.

    Returns:
        requests.Response: The response object from the request.

    Examples:
        >> response = ApacheUtils.Nifi().
        call_request("GET", "https://www.samplesite.com/api",
        headers={"Accept": "application/json"})
    """
    if not url:
        raise ValueError("URL cannot be null")
    json_data = kwargs.get("json_data")
    payload = kwargs.get("payload")
    cookies = kwargs.get("cookies", {})
    allow_redirects = kwargs.get("allow_redirects", False)
    files = kwargs.get("files")
    verify = kwargs.get("verify", False)
    auth_type = kwargs.get("auth_type")
    auth_username = kwargs.get("auth_username")
    auth_password = kwargs.get("auth_password")
    timeout = kwargs.get("timeout")
    proxies = kwargs.get("proxies")
    auth_string = ""
    if auth_type:
        auth_string = self.security.get_auth_string(
            auth_type, auth_username, auth_password
        )
    method = method.upper()
    try:
        if method == "GET":
            response = requests.get(
                url,
                headers=headers,
                verify=verify,
                allow_redirects=allow_redirects,
                cookies=cookies,
                auth=auth_string,
                timeout=timeout,
                proxies=proxies,
            )
        elif method in ["POST", "PUT", "PATCH"]:
            if payload is None:
                raise ValueError("Payload is required for POST, PUT, and PATCH requests.")
            response = requests.request(
                method,
                url,
                headers=headers,
                data=payload,
                json=json_data,
                verify=verify,
                allow_redirects=allow_redirects,
                cookies=cookies,
                files=files,
                auth=auth_string,
                timeout=timeout,
                proxies=proxies,
            )
        elif method == "DELETE":
            response = requests.delete(
                url,
                headers=headers,
                verify=verify,
                allow_redirects=allow_redirects,
                cookies=cookies,
                auth=auth_string,
                data=payload,
                json=json_data,
                timeout=timeout,
                proxies=proxies,
            )
        else:
            raise ValueError(f"Invalid HTTP method: {method}. Valid "
                             f"options are: GET, POST, PUT, PATCH, DELETE")
        return response
    except Exception as e:
        self.logger.exception("Error in Apache call request method: %s", str(e))
        raise e

change_nifi_processor_state(nifi_server, processor_id, state)

Changes the status of a NiFi processor.

Parameters:

Name Type Description Default
nifi_server str

Server name.

required
processor_id str

NiFi process ID.

required
state str

RUNNING or STOPPED.

required

Returns:

Name Type Description
bool bool

True if the operation was successful; otherwise, False.

Examples:

result = ApacheUtils.Nifi(). change_nifi_processor_state("http://localhost:8080", "processor_id", "RUNNING")

Source code in libs\cafex_core\src\cafex_core\utils\apache_utils.py
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
def change_nifi_processor_state(self, nifi_server: str,
                                processor_id: str, state: str) -> bool:
    """
    Changes the status of a NiFi processor.

    Args:
        nifi_server (str): Server name.
        processor_id (str): NiFi process ID.
        state (str): RUNNING or STOPPED.

    Returns:
        bool: True if the operation was successful; otherwise, False.

    Examples:
        >> result = ApacheUtils.Nifi().
        change_nifi_processor_state("http://localhost:8080", "processor_id",
        "RUNNING")
    """
    try:
        nifi_server = nipyapi.config.nifi_config.host
        processor = self.__get_processor(processor_id)
        is_scheduled = str.upper(state) == "RUNNING"
        run_status = nipyapi.canvas.schedule_processor(processor[1], scheduled=is_scheduled)
        if run_status:
            self.reporting.insert_step(
                f"Processor state: {state} should be changed for {nifi_server}",
                f"Successfully changed processor state: {state}",
                "Pass",
            )
            self.logger.info("Successfully changed processor %s state to %s."
                             , processor_id, state)
            return True
        self.reporting.insert_step(
            f"Failed to change processor state: {state}",
            "Failed to change processor state",
            "Fail",
        )
        self.logger.warning("Failed to change processor %s state to %s."
                            , processor_id, state)
        return False

    except (nipyapi.nifi.rest.ApiException, ValueError) as e:
        error_message = f"Error occurred while changing state for processor " \
                        f"{processor_id}: {str(e)}"
        self.__obj_exception.raise_generic_exception(
            message=error_message,
            insert_report=True,
            trim_log=True,
            log_local=True,
            fail_test=False,
        )
        return False

change_process_group_state(process_group_id, state=True)

Changes the status of a NiFi process group.

Parameters:

Name Type Description Default
process_group_id str

NiFi process group ID.

required
state bool

True to schedule the process group; False to unschedule.

True

Returns:

Name Type Description
bool bool

True if the state change was successful; otherwise, False.

Examples:

result = ApacheUtils.Nifi(). change_process_group_state("process_group_id", True)

Source code in libs\cafex_core\src\cafex_core\utils\apache_utils.py
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
def change_process_group_state(self, process_group_id: str, state: bool = True) -> bool:
    """
    Changes the status of a NiFi process group.

    Args:
        process_group_id (str): NiFi process group ID.
        state (bool): True to schedule the process group; False to unschedule.

    Returns:
        bool: True if the state change was successful; otherwise, False.

    Examples:
        >> result = ApacheUtils.Nifi().
        change_process_group_state("process_group_id", True)
    """
    try:
        run_status = nipyapi.canvas.schedule_process_group(process_group_id,
                                                           scheduled=state)
        if run_status:
            self.reporting.insert_step(
                f"Successfully changed process group state to {state}",
                "Successfully changed process group state",
                "Pass",
            )
            self.logger.info("Process group %s state changed to %s.",
                             process_group_id, state)
            return True
        self.reporting.insert_step(
            f"Failed to change process group state to {state}",
            "Failed to change process group state",
            "Fail",
        )
        self.logger.warning("Failed to change process group %s state to %s."
                            , process_group_id, state)
        return False

    except (nipyapi.nifi.rest.ApiException, ValueError) as e:
        error_message = f"Error occurred while changing state for process group " \
                        f"{process_group_id}: {str(e)}"
        self.__obj_exception.raise_generic_exception(
            message=error_message,
            insert_report=True,
            trim_log=True,
            log_local=True,
            fail_test=False,
        )
        return False

change_processor_state(server_name, payload, nifi_id)

Starts or stops a NiFi processor.

Parameters:

Name Type Description Default
server_name str

NiFi server name.

required
payload str

Processor payload.

required
nifi_id str

NiFi processor ID.

required

Returns:

Name Type Description
bool bool

True if the operation was successful; otherwise, False.

Examples:

result = ApacheUtils.Nifi().change_processor_state("http://localhost:8080", payload, "processor_id")

Source code in libs\cafex_core\src\cafex_core\utils\apache_utils.py
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
def change_processor_state(self, server_name: str, payload: str, nifi_id: str) -> bool:
    """
    Starts or stops a NiFi processor.

    Args:
        server_name (str): NiFi server name.
        payload (str): Processor payload.
        nifi_id (str): NiFi processor ID.

    Returns:
        bool: True if the operation was successful; otherwise, False.

    Examples:
        >> result = ApacheUtils.Nifi().change_processor_state("http://localhost:8080",
        payload, "processor_id")
    """
    try:
        api_method = "PUT"
        api_header = {"Content-Type": "application/json"}
        method_path = "/nifi-api/flow/process-groups/"
        request_url = f"{server_name}{method_path}{nifi_id}"
        response = self.call_request(
            api_method, request_url, api_header, pstr_payload=payload
        )
        self.logger.debug("Response from NiFi API: %s", response.content.decode('utf-8'))
        if response.status_code == 200:
            self.logger.info("Successfully changed processor state for ID: %s", nifi_id)
            return True
        self.logger.warning("Failed to change processor state for ID: %s ."
                            "Response: %s", nifi_id,
                            response.content.decode('utf-8'))
        return False
    except (nipyapi.nifi.rest.ApiException, ValueError) as e:
        error_message = f"Error occurred while changing processor state for " \
                        f"ID {nifi_id}: {str(e)}"
        self.__obj_exception.raise_generic_exception(
            message=error_message,
            insert_report=True,
            trim_log=True,
            log_local=True,
            fail_test=False,
        )
        return False

change_remote_process_group_state(rpg_id, enable)

Changes the state of the remote process group.

Parameters:

Name Type Description Default
rpg_id str

Remote Process Group ID.

required
enable bool

True to enable; False to disable.

required

Returns:

Name Type Description
bool bool

Status of completion.

Examples:

success = ApacheUtils.Nifi(). change_remote_process_group_state("remote_group_id", True)

Source code in libs\cafex_core\src\cafex_core\utils\apache_utils.py
 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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
def change_remote_process_group_state(self, rpg_id: str, enable: bool) -> bool:
    """
    Changes the state of the remote process group.

    Args:
        rpg_id (str): Remote Process Group ID.
        enable (bool): True to enable; False to disable.

    Returns:
        bool: Status of completion.

    Examples:
        >> success = ApacheUtils.Nifi().
        change_remote_process_group_state("remote_group_id", True)
    """
    try:
        status = nipyapi.canvas.set_remote_process_group_transmission(
            rpg_id, enable=enable, refresh=True
        )

        if status is not None:
            self.reporting.insert_step(
                "Successfully changed the state of the remote process group.",
                "State change completed successfully.",
                "Pass",
            )
            return True
        self.reporting.insert_step(
            "Failed to change the state of the remote process group.",
            "No status returned from the operation.",
            "Fail",
        )
        return False

    except (nipyapi.nifi.rest.ApiException, ValueError) as e:
        error_message = f"Error occurred while changing the state of remote " \
                        f"process group {rpg_id}: {str(e)}"
        self.__obj_exception.raise_generic_exception(
            message=error_message,
            insert_report=True,
            trim_log=True,
            log_local=True,
            fail_test=False,
        )
        return False

check_process_group_status(process_group_id)

Checks the status of a process group.

Parameters:

Name Type Description Default
process_group_id str

NiFi process group ID.

required

Returns:

Name Type Description
bool bool

True if the process group status is available; otherwise, False.

Examples:

status = ApacheUtils.Nifi().check_process_group_status("process_group_id")

Source code in libs\cafex_core\src\cafex_core\utils\apache_utils.py
 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
def check_process_group_status(self, process_group_id: str) -> bool:
    """
    Checks the status of a process group.

    Args:
        process_group_id (str): NiFi process group ID.

    Returns:
        bool: True if the process group status is available; otherwise, False.

    Examples:
        >> status = ApacheUtils.Nifi().check_process_group_status("process_group_id")
    """
    try:
        process_group_entity = self.apis.get("flow_api"). \
            get_process_group_status(process_group_id)
        self.logger.info("API response for process group status: %s", process_group_entity)
        if process_group_entity.process_group_status.to_dict():
            self.reporting.insert_step(
                "Successfully returned process group status",
                "Successfully returned process group status",
                "Pass",
            )
            self.logger.info("Successfully returned process group status for ID: %s."
                             , process_group_id)
            return True
        self.reporting.insert_step(
            "Process group status retrieval",
            "Unable to get process group status",
            "Fail",
        )
        self.logger.warning("Unable to get process group status for ID: %s"
                            , process_group_id)
        return False

    except (nipyapi.nifi.rest.ApiException, ValueError) as e:
        error_message = f"Error occurred while checking status for process group " \
                        f"{process_group_id}: {str(e)}"
        self.__obj_exception.raise_generic_exception(
            message=error_message,
            insert_report=True,
            trim_log=True,
            log_local=True,
            fail_test=False,
        )
        return False

check_processor_status(processor_id)

Checks the status of a processor.

Parameters:

Name Type Description Default
processor_id str

NiFi processor ID.

required

Returns:

Name Type Description
bool bool

True if the processor is available with a 200 response; otherwise, False.

Examples:

status = ApacheUtils.Nifi(). check_processor_status("f03899a8-0193-1000-d8fc-53112a5e7c3a")

Source code in libs\cafex_core\src\cafex_core\utils\apache_utils.py
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
def check_processor_status(self, processor_id: str) -> bool:
    """
    Checks the status of a processor.

    Args:
        processor_id (str): NiFi processor ID.

    Returns:
        bool: True if the processor is available with a 200 response; otherwise, False.

    Examples:
        >> status = ApacheUtils.Nifi().
        check_processor_status("f03899a8-0193-1000-d8fc-53112a5e7c3a")
    """
    try:
        processor_status_entity = self.apis.get("flow_api").get_processor_status(processor_id)
        self.logger.info("API response for processor status: %s", processor_status_entity)
        if processor_status_entity.processor_status.to_dict():
            self.reporting.insert_step(
                f"Successfully returned processor status for {processor_id}",
                "Successfully returned processor status",
                "Pass",
            )
            self.logger.info("Successfully returned processor status for %s.",
                             processor_id)
            return True
        self.reporting.insert_step(
            "Processor status retrieval",
            f"Processor with ID {processor_id} does not exist or is not "
            f"available.", "Fail", )
        self.logger.error("Processor with ID %s does not exist or is not available.",
                          processor_id)
        return False
    except (nipyapi.nifi.rest.ApiException, ValueError) as e:
        error_message = f"Error occurred while checking status for processor " \
                        f"{processor_id}: {str(e)}"
        self.__obj_exception.raise_generic_exception(
            message=error_message,
            insert_report=True,
            trim_log=True,
            log_local=True,
            fail_test=False,
        )
        return False

clear_queues(processor_id, inbound_queue=True, outbound_queue=True)

Clears the in/out queues for the given processor based on input parameters.

Parameters:

Name Type Description Default
processor_id str

NiFi processor ID.

required
inbound_queue bool

If True, clears the input queue for the processor.

True
outbound_queue bool

If True, clears the output queue for the processor.

True

Returns:

Name Type Description
bool bool

True if successful; otherwise, False.

Examples:

result = ApacheUtils.Nifi().clear_queues("processor_id")

Source code in libs\cafex_core\src\cafex_core\utils\apache_utils.py
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
def clear_queues(
        self, processor_id: str, inbound_queue: bool = True, outbound_queue: bool = True
) -> bool:
    """
    Clears the in/out queues for the given processor based on input parameters.

    Args:
        processor_id (str): NiFi processor ID.
        inbound_queue (bool): If True, clears the input queue for the processor.
        outbound_queue (bool): If True, clears the output queue for the processor.

    Returns:
        bool: True if successful; otherwise, False.

    Examples:
        >> result = ApacheUtils.Nifi().clear_queues("processor_id")
    """
    try:
        _, dict_connections = self.get_component_connections(processor_id, True)
        if inbound_queue:
            for key, val in dict_connections["source"].items():
                for connection_id in val:
                    if not self.delete_queue_data(connection_id):
                        self.reporting.insert_step(
                            "Failed to clear input queue",
                            f"Error occurred while deleting input "
                            f"connection: {connection_id}",
                            "Fail",
                        )
                        return False

            self.reporting.insert_step(
                f"Successfully cleared all input queues for processor ID: {processor_id}",
                "All input queues cleared.",
                "Pass",
            )
        if outbound_queue:
            for key, val in dict_connections["destination"].items():
                for connection_id in val:
                    if not self.delete_queue_data(connection_id):
                        self.reporting.insert_step(
                            "Failed to clear output queue",
                            f"Error occurred while deleting output "
                            f"connection: {connection_id}",
                            "Fail",
                        )
                        return False

            self.reporting.insert_step(
                f"Successfully cleared all output queues for processor ID: {processor_id}",
                "All output queues cleared.",
                "Pass",
            )

        return True

    except (nipyapi.nifi.rest.ApiException, ValueError) as e:
        error_message = f"Error occurred while clearing queues for processor " \
                        f"ID {processor_id}: {str(e)}"
        self.__obj_exception.raise_generic_exception(
            message=error_message,
            insert_report=True,
            trim_log=True,
            log_local=True,
            fail_test=False,
        )
        return False

delete_queue_data(connection_id)

Deletes the contents of the queue in the connection.

Parameters:

Name Type Description Default
connection_id str

Connection ID.

required

Returns:

Name Type Description
bool bool

True if deletion was successful; otherwise, False.

Examples:

success = ApacheUtils.Nifi().delete_queue_data("connection_id")

Source code in libs\cafex_core\src\cafex_core\utils\apache_utils.py
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
def delete_queue_data(self, connection_id: str) -> bool:
    """
    Deletes the contents of the queue in the connection.

    Args:
        connection_id (str): Connection ID.

    Returns:
        bool: True if deletion was successful; otherwise, False.

    Examples:
        >> success = ApacheUtils.Nifi().delete_queue_data("connection_id")
    """
    try:
        drop_req_id = self.apis.get("flowfile_queues_api").create_drop_request(connection_id)

        if drop_req_id is not None:
            self.reporting.insert_step(
                "Successfully deleted queue connection data",
                "Successfully deleted queue connection data",
                "Pass",
            )
            return True
        self.reporting.insert_step(
            "Failed to delete queue connection data",
            "Unable to delete queue connection data",
            "Fail",
        )
        return False

    except (nipyapi.nifi.rest.ApiException, ValueError) as e:
        error_message = f"Error occurred while deleting queue data for connection " \
                        f"ID {connection_id}: {str(e)}"
        self.__obj_exception.raise_generic_exception(
            message=error_message,
            insert_report=True,
            trim_log=True,
            log_local=True,
            fail_test=False,
        )
        return False

disable_processor(server_name, processor_id, max_wait_time=60, wait_interval=5, end_point='/nifi-api/processors/{processor_id}/run-status')

Disables the processor.

Parameters:

Name Type Description Default
server_name str

NiFi server URL.

required
processor_id str

NiFi processor ID.

required
max_wait_time int

Max wait time to wait for processor to disable.

60
wait_interval int

Interval time to check the status.

5
end_point str

Service endpoint to invoke API call.

'/nifi-api/processors/{processor_id}/run-status'

Returns:

Name Type Description
bool bool

True if successful; otherwise, False.

Examples:

result = ApacheUtils.Nifi(). disable_processor("http://localhost:8080", "processor_id")

Source code in libs\cafex_core\src\cafex_core\utils\apache_utils.py
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
def disable_processor(
        self,
        server_name: str,
        processor_id: str,
        max_wait_time: int = 60,
        wait_interval: int = 5,
        end_point: str = "/nifi-api/processors/{processor_id}/run-status",
) -> bool:
    """
    Disables the processor.

    Args:
        server_name (str): NiFi server URL.
        processor_id (str): NiFi processor ID.
        max_wait_time (int): Max wait time to wait for processor to disable.
        wait_interval (int): Interval time to check the status.
        end_point (str): Service endpoint to invoke API call.

    Returns:
        bool: True if successful; otherwise, False.

    Examples:
        >> result = ApacheUtils.Nifi().
        disable_processor("http://localhost:8080", "processor_id")
    """
    try:
        _, dict_processor_data = self.__get_processor(processor_id)
        dict_payload = {
            "revision": {
                "clientId": dict_processor_data.revision.client_id,
                "version": dict_processor_data.revision.version,
            },
            "state": "DISABLED",
        }
        str_api_method = "PUT"
        dict_api_header = {"Content-Type": "application/json"}
        if self.__nifi_token is not None:
            dict_api_header["Authorization"] = self.__nifi_token

        str_request_url = f"{server_name}{end_point.format(processor_id=processor_id)}"
        self.call_request(
            str_api_method,
            str_request_url,
            dict_api_header,
            pstr_payload=json.dumps(dict_payload),
        )
        count = 0
        max_count = max_wait_time // wait_interval

        while count < max_count:
            time.sleep(wait_interval)
            str_path = "status/aggregate_snapshot/active_thread_count"
            _, str_processor_data = self.__get_processor(processor_id)
            value = self.get_key_path_value(
                json=str_processor_data.to_dict(), keyPath=str_path, keyPathType="absolute"
            )

            if int(value) == 0:
                break

            count += 1
        else:
            self.reporting.insert_step(
                f"Processor {processor_id} should be disabled.",
                f"Processor is not getting disabled after {max_wait_time} seconds.",
                "Fail",
            )
            return False
        self.reporting.insert_step(
            f"Processor {processor_id} has been successfully disabled.",
            "Processor has been disabled.",
            "Pass",
        )
        return True

    except (nipyapi.nifi.rest.ApiException, ValueError) as e:
        error_message = f"Error occurred while disabling processor ID " \
                        f"{processor_id}: {str(e)}"
        self.__obj_exception.raise_generic_exception(
            message=error_message,
            insert_report=True,
            trim_log=True,
            log_local=True,
            fail_test=False,
        )
        return False

enable_processor(server_name, processor_id, max_wait_time=60, wait_interval=5, end_point='/nifi-api/processors/{processor_id}/run-status')

Enables the processor and keeps it in a stopped state.

Parameters:

Name Type Description Default
server_name str

NiFi server URL.

required
processor_id str

NiFi processor ID.

required
max_wait_time int

Max wait time to wait for processor to enable.

60
wait_interval int

Interval time to check the status.

5
end_point str

Service endpoint to invoke API call.

'/nifi-api/processors/{processor_id}/run-status'

Returns:

Name Type Description
bool

True if successful; otherwise, False.

Examples:

result = ApacheUtils.Nifi(). enable_processor("http://localhost:8080", "processor_id")

Source code in libs\cafex_core\src\cafex_core\utils\apache_utils.py
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
def enable_processor(
        self,
        server_name: str,
        processor_id: str,
        max_wait_time: int = 60,
        wait_interval: int = 5,
        end_point: str = "/nifi-api/processors/{processor_id}/run-status",
):
    """
    Enables the processor and keeps it in a stopped state.

    Args:
        server_name (str): NiFi server URL.
        processor_id (str): NiFi processor ID.
        max_wait_time (int): Max wait time to wait for processor to enable.
        wait_interval (int): Interval time to check the status.
        end_point (str): Service endpoint to invoke API call.

    Returns:
        bool: True if successful; otherwise, False.

    Examples:
        >> result = ApacheUtils.Nifi().
        enable_processor("http://localhost:8080", "processor_id")
    """
    try:
        _, dict_processor_data = self.__get_processor(processor_id)
        dict_payload = {
            "revision": {
                "clientId": dict_processor_data.revision.client_id,
                "version": dict_processor_data.revision.version,
            },
            "state": "STOPPED",
        }
        str_api_method = "PUT"
        dict_api_header = {"Content-Type": "application/json"}
        if self.__nifi_token is not None:
            dict_api_header["Authorization"] = self.__nifi_token

        str_request_url = f"{server_name}{end_point.format(processor_id=processor_id)}"
        self.call_request(
            str_api_method,
            str_request_url,
            dict_api_header,
            pstr_payload=json.dumps(dict_payload),
        )
        count = 0
        max_count = max_wait_time // wait_interval

        while count < max_count:
            time.sleep(wait_interval)
            str_path = "status/aggregate_snapshot/run_status"
            _, processor_data = self.__get_processor(processor_id)
            value = self.get_key_path_value(
                json=processor_data.to_dict(), keyPath=str_path, keyPathType="absolute"
            )

            count += 1
            if value.strip().lower() != "validating":
                break
        else:
            self.reporting.insert_step(
                f"Processor ID {processor_id} should get enabled.",
                f"Processor is not getting enabled after: {max_wait_time} seconds.",
                "Fail",
            )
            return False

        self.reporting.insert_step(
            f"Successfully enabled processor: {processor_id}",
            "Processor has been successfully enabled.",
            "Pass",
        )
        return True

    except (nipyapi.nifi.rest.ApiException, ValueError) as e:
        error_message = f"Error occurred while enabling processor ID " \
                        f"{processor_id}: {str(e)}"
        self.__obj_exception.raise_generic_exception(
            message=error_message,
            insert_report=True,
            trim_log=True,
            log_local=True,
            fail_test=False,
        )
        return False

get_access_config()

Gets the access config of a NiFi instance.

Returns:

Name Type Description
bool bool

Indicates if the function ran successfully.

Examples:

success = ApacheUtils.Nifi().get_access_config()

Source code in libs\cafex_core\src\cafex_core\utils\apache_utils.py
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
def get_access_config(self) -> bool:
    """
    Gets the access config of a NiFi instance.

    Returns:
        bool: Indicates if the function ran successfully.

    Examples:
        >> success = ApacheUtils.Nifi().get_access_config()
    """
    try:
        obj_access_configuration_entity = self.apis.get("access_api").get_login_config()
        if bool(obj_access_configuration_entity.config.to_dict()):
            self.logger.debug("Access configuration retrieved: %s",
                              obj_access_configuration_entity.config.to_dict())
            self.reporting.insert_step(
                "Successfully retrieved NiFi access config",
                "Access configuration retrieved successfully",
                "Pass",
            )
            return True
        self.reporting.insert_step(
            "Failed to retrieve NiFi access config",
            "Access configuration is empty or invalid",
            "Fail",
        )
        return False

    except (nipyapi.nifi.rest.ApiException, ValueError) as e:
        error_message = f"Error occurred while retrieving NiFi access config: {str(e)}"
        self.__obj_exception.raise_generic_exception(
            message=error_message,
            insert_report=True,
            trim_log=True,
            log_local=True,
            fail_test=False,
        )
        return False

get_component_connections(processor_id, return_list=False)

Retrieves the connections of a component/processor.

Parameters:

Name Type Description Default
processor_id str

Processor ID.

required
return_list bool

Return type identifier.

False

Returns:

Type Description
bool

bool, dict: Tuple indicating 'execution_result' and connections

dict

dictionary object.

Examples:

success, connections = ApacheUtils.Nifi(). get_component_connections("processor_id")

Source code in libs\cafex_core\src\cafex_core\utils\apache_utils.py
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
def get_component_connections(self, processor_id: str,
                              return_list: bool = False) -> tuple[bool, dict]:
    """
    Retrieves the connections of a component/processor.

    Args:
        processor_id (str): Processor ID.
        return_list (bool): Return type identifier.

    Returns:
        bool, dict: Tuple indicating 'execution_result' and connections
        dictionary object.

    Examples:
        >> success, connections = ApacheUtils.Nifi().
        get_component_connections("processor_id")
    """
    connections_dict = {"source": {}, "destination": {}}

    try:
        execution, processor = self.__get_processor(processor_id)

        if execution:
            connections = nipyapi.canvas.get_component_connections(processor)
            for connection in connections:
                connection_status = connection.to_dict()["status"]
                connection_name = connection_status["name"]
                connection_id = connection_status["id"]

                if connection_status["source_id"] == processor_id:
                    if return_list:
                        connections_dict["source"].setdefault(connection_name, []). \
                            append(connection_id)
                    else:
                        connections_dict["source"][connection_name] = connection_id

                elif connection_status["destination_id"] == processor_id:
                    if return_list:
                        connections_dict["destination"]. \
                            setdefault(connection_name, []).append(connection_id)
                    else:
                        connections_dict["destination"][connection_name] = connection_id

            if connections:
                self.reporting.insert_step(
                    f"Successfully retrieved component connections for: {processor_id}",
                    "Successfully retrieved component connections",
                    "Pass",
                )
                return True, connections_dict

            self.reporting.insert_step(
                f"Unable to get component connections for: {processor_id}",
                "No connections found",
                "Fail",
            )
            return False, connections_dict

    except (nipyapi.nifi.rest.ApiException, ValueError) as e:
        error_message = f"Error occurred while retrieving component " \
                        f"connections for {processor_id}: {str(e)}"
        self.__obj_exception.raise_generic_exception(
            message=error_message,
            insert_report=True,
            trim_log=True,
            log_local=True,
            fail_test=False,
        )
        return False, connections_dict

get_flow_file_count(connection_id)

Retrieves the count of flow files in a specified NiFi connection.

Parameters:

Name Type Description Default
connection_id str

The ID of the connection.

required

Returns:

Name Type Description
int int

The count of flow files.

Examples:

count = ApacheUtils.Nifi().get_flow_file_count("connection_id")

Source code in libs\cafex_core\src\cafex_core\utils\apache_utils.py
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
def get_flow_file_count(self, connection_id: str) -> int:
    """
    Retrieves the count of flow files in a specified NiFi connection.

    Args:
        connection_id (str): The ID of the connection.

    Returns:
        int: The count of flow files.

    Examples:
        >> count = ApacheUtils.Nifi().get_flow_file_count("connection_id")

    """
    try:
        flow_file_listing = self.apis.get("flowfile_queues_api"). \
            create_flow_file_listing(connection_id)
        str_uri = flow_file_listing.listing_request.uri
        flow_file_details = self.__get_flow_file_details(str_uri)
        return len(flow_file_details)  # Count of flow files
    except (nipyapi.nifi.rest.ApiException, ValueError) as e:
        error_message = f"Error occurred while retrieving flow file count for connection " \
                        f"ID {connection_id}: {str(e)}"
        self.__obj_exception.raise_generic_exception(
            message=error_message,
            insert_report=True,
            trim_log=True,
            log_local=True,
            fail_test=False,
        )
        return 0

get_flow_files_queue_details(connection_id)

Provides a list of files present in a NiFi queue.

Parameters:

Name Type Description Default
connection_id str

NiFi connection ID.

required

Returns:

Name Type Description
list list | bool

List containing the details of all files, or False if an error occurs.

Examples:

files = ApacheUtils.Nifi().get_flow_files_queue_details("connection_id")

Source code in libs\cafex_core\src\cafex_core\utils\apache_utils.py
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
def get_flow_files_queue_details(self, connection_id: str) -> list | bool:
    """
    Provides a list of files present in a NiFi queue.

    Args:
        connection_id (str): NiFi connection ID.

    Returns:
        list: List containing the details of all files, or False if an error occurs.

    Examples:
        >> files = ApacheUtils.Nifi().get_flow_files_queue_details("connection_id")
    """
    try:
        obj_listing_request_entity = self.apis.get("flowfile_queues_api"). \
            create_flow_file_listing(connection_id)
        str_uri = obj_listing_request_entity.listing_request.uri
        list_flow_files = self.__get_flow_file_details(str_uri)
        return list_flow_files
    except (nipyapi.nifi.rest.ApiException, ValueError) as e:
        error_message = f"Error occurred while retrieving flow files for connection ID " \
                        f"{connection_id}: {str(e)}"
        self.__obj_exception.raise_generic_exception(
            message=error_message,
            insert_report=True,
            trim_log=True,
            log_local=True,
            fail_test=False,
        )
        return False

get_key_path_value(**kwargs)

Extracts the value at the specified key path from the JSON data.

Kwargs

json: The JSON data (string or dictionary). keyPath: The path to the key, using the specified delimiter. keyPathType: Either "absolute" or "relative" (default: "absolute"). delimiter: The delimiter used in the key path (default: "/"). key: The key to retrieve the value for when using relative key paths.

Returns:

Type Description
Any

The value associated with the key path.

Raises:

Type Description
ValueError

If required arguments are missing, invalid, or the key path

JSONDecodeError

If the JSON data is invalid.

Examples:

value = ApacheUtils.Nifi(). get_key_path_value(json='{"key": "value"}', keyPath='key')

Source code in libs\cafex_core\src\cafex_core\utils\apache_utils.py
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
def get_key_path_value(self, **kwargs: Any) -> Any:
    """
    Extracts the value at the specified key path from the JSON data.

    Kwargs:
        json: The JSON data (string or dictionary).
        keyPath: The path to the key, using the specified delimiter.
        keyPathType: Either "absolute" or "relative" (default: "absolute").
        delimiter: The delimiter used in the key path (default: "/").
        key: The key to retrieve the value for when using relative key paths.

    Returns:
        The value associated with the key path.

    Raises:
        ValueError: If required arguments are missing, invalid, or the key path
        is not found.
        json.JSONDecodeError: If the JSON data is invalid.

    Examples:
        >> value = ApacheUtils.Nifi().
        get_key_path_value(json='{"key": "value"}', keyPath='key')
    """
    try:
        if "json" not in kwargs:
            self.logger.info("No json argument provided")
            raise ValueError("json argument is required.")
        if "keyPath" not in kwargs:
            self.logger.info("No keyPath argument provided")
            raise ValueError("keyPath argument is required.")
        if "keyPathType" not in kwargs:
            self.logger.info("No keyPathType argument provided")
            raise ValueError("keyPathType argument is required.")
        obj_parse_data = ParseJsonData()
        return obj_parse_data.get_value_from_key_path(**kwargs)
    except Exception as e:
        self.logger.exception("Error in extracting the value at the specified "
                              "key path: %s", e)
        raise e

get_process_group_id(pstr_process_group_name, parent_pg_id='root')

Retrieves the process group ID.

Parameters:

Name Type Description Default
pstr_process_group_name str

Process group name.

required
parent_pg_id str

Parent Process Group ID.

'root'

Returns:

Name Type Description
bool tuple[bool, Any]

Indicates whether the operation was successful.

Examples:

success = ApacheUtils.Nifi().get_process_group_id("process_group_name")

Source code in libs\cafex_core\src\cafex_core\utils\apache_utils.py
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
def get_process_group_id(self, pstr_process_group_name,
                         parent_pg_id="root") -> tuple[bool, Any]:
    """
    Retrieves the process group ID.

    Args:
        pstr_process_group_name (str): Process group name.
        parent_pg_id (str): Parent Process Group ID.

    Returns:
        bool: Indicates whether the operation was successful.

    Examples:
        >> success = ApacheUtils.Nifi().get_process_group_id("process_group_name")
    """
    component_id = None
    try:
        process_group_list = nipyapi.canvas.list_all_process_groups(pg_id=parent_pg_id)
        for process_group in process_group_list:
            if process_group.to_dict()["component"]["name"] == pstr_process_group_name:
                component_id = process_group.to_dict()["component"]["id"]
                break
        if component_id is not None:
            self.reporting.insert_step(
                f"Successfully retrieved process group ID for: {pstr_process_group_name}",
                "Successfully retrieved process group ID",
                "Pass",
            )
            return True, component_id

        self.reporting.insert_step(
            f"Failed to retrieve process group ID for: {pstr_process_group_name}",
            "Process group not found",
            "Fail",
        )
        return False, component_id
    except (nipyapi.nifi.rest.ApiException, ValueError) as e:
        error_message = f"Error occurred while retrieving process group ID: {str(e)}"
        self.__obj_exception.raise_generic_exception(
            message=error_message,
            insert_report=True,
            trim_log=True,
            log_local=True,
            fail_test=False,
        )
        return False, component_id

get_process_group_q_count(process_group_id)

Gets the queue count of documents in the NiFi Process group.

Parameters:

Name Type Description Default
process_group_id str

NiFi process group ID.

required

Returns:

Name Type Description
int int

Queue count of the process group.

Examples:

count = ApacheUtils.Nifi(). get_process_group_q_count("process_group_id")

Source code in libs\cafex_core\src\cafex_core\utils\apache_utils.py
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
def get_process_group_q_count(self, process_group_id: str) -> int:
    """
    Gets the queue count of documents in the NiFi Process group.

    Args:
        process_group_id (str): NiFi process group ID.

    Returns:
        int: Queue count of the process group.

    Examples:
        >> count = ApacheUtils.Nifi().
        get_process_group_q_count("process_group_id")
    """
    try:
        key_path = "status/aggregate_snapshot/queued_count"
        process_group = self.nifi_module.canvas.get_process_group(
            process_group_id, identifier_type="id"
        )
        group_q_count = self.get_key_path_value(
            json=process_group.to_dict(), keyPath=key_path, keyPathType="absolute"
        )

        return group_q_count

    except (nipyapi.nifi.rest.ApiException, ValueError) as e:
        error_message = f"Error occurred while retrieving queue count for process " \
                        f"group ID " \
                        f"{process_group_id}: {str(e)}"
        self.__obj_exception.raise_generic_exception(
            message=error_message,
            insert_report=True,
            trim_log=True,
            log_local=True,
            fail_test=False,
        )
        return 0

get_process_groups(pg_id='root', key_path=None)

Retrieves details of process groups under the mentioned process group recursively.

Parameters:

Name Type Description Default
pg_id str

Process Group ID.

'root'
key_path str

Path of the field to be retrieved.

None

Returns:

Name Type Description
list list

Process groups list or specified key path values.

Examples:

process_groups = ApacheUtils.Nifi(). get_process_groups("process_group_id")

Source code in libs\cafex_core\src\cafex_core\utils\apache_utils.py
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
def get_process_groups(self, pg_id: str = "root", key_path: str = None) -> list:
    """
    Retrieves details of process groups under the mentioned process group recursively.

    Args:
        pg_id (str): Process Group ID.
        key_path (str): Path of the field to be retrieved.

    Returns:
        list: Process groups list or specified key path values.

    Examples:
        >> process_groups = ApacheUtils.Nifi().
        get_process_groups("process_group_id")
    """
    try:
        pgs_list = []
        pg_list = nipyapi.canvas.list_all_process_groups(pg_id=pg_id)
        for pg in pg_list:
            if key_path:
                field_values = self.get_key_path_value(
                    json=pg.to_dict(), keyPath=key_path, keyPathType="absolute"
                )
                pgs_list.append(field_values)
            else:
                pgs_list.append(pg)
        return pgs_list

    except (nipyapi.nifi.rest.ApiException, ValueError) as e:
        error_message = f"Error occurred while retrieving process groups for " \
                        f"ID {pg_id}: {str(e)}"
        self.__obj_exception.raise_generic_exception(
            message=error_message,
            insert_report=True,
            trim_log=True,
            log_local=True,
            fail_test=False,
        )
        return []

get_processor_id(processor_name, parent_pg_id='root')

Retrieves the processor ID.

Parameters:

Name Type Description Default
processor_name str

Processor name.

required
parent_pg_id str

Parent Process Group ID.

'root'

Returns:

Name Type Description
bool bool

Indicates if the processor ID was retrieved successfully.

Examples:

success = ApacheUtils.Nifi().get_processor_id("processor_name")

Source code in libs\cafex_core\src\cafex_core\utils\apache_utils.py
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
def get_processor_id(self, processor_name: str, parent_pg_id: str = "root") -> bool:
    """
    Retrieves the processor ID.

    Args:
        processor_name (str): Processor name.
        parent_pg_id (str): Parent Process Group ID.

    Returns:
        bool: Indicates if the processor ID was retrieved successfully.

    Examples:
        >> success = ApacheUtils.Nifi().get_processor_id("processor_name")
    """
    component_id = None
    try:
        processor_list = nipyapi.canvas.list_all_processors(pg_id=parent_pg_id)
        for processor in processor_list:
            if processor.to_dict()["component"]["name"] == processor_name:
                component_id = processor.to_dict()["component"]["id"]
                break
        if component_id is not None:
            self.reporting.insert_step(
                f"Successfully retrieved processor ID for: {processor_name}",
                "Successfully retrieved processor ID",
                "Pass",
            )
            return True
        self.reporting.insert_step(
            f"Failed to retrieve processor ID for: {processor_name}",
            "Processor not found",
            "Fail",
        )
        return False
    except (nipyapi.nifi.rest.ApiException, ValueError) as e:
        error_message = f"Error occurred while retrieving processor ID: {str(e)}"
        self.__obj_exception.raise_generic_exception(
            message=error_message,
            insert_report=True,
            trim_log=True,
            log_local=True,
            fail_test=False,
        )
        return False

get_processor_properties(processor_id)

Retrieves the configuration properties of a specified NiFi processor.

Parameters:

Name Type Description Default
processor_id str

NiFi processor ID.

required

Returns:

Name Type Description
dict dict | bool

A dictionary of properties if successful; otherwise, False.

Examples:

properties = ApacheUtils.Nifi().get_processor_properties("processor_id")

Source code in libs\cafex_core\src\cafex_core\utils\apache_utils.py
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
def get_processor_properties(self, processor_id: str) -> dict | bool:
    """
    Retrieves the configuration properties of a specified NiFi processor.

    Args:
        processor_id (str): NiFi processor ID.

    Returns:
        dict: A dictionary of properties if successful; otherwise, False.

    Examples:
        >> properties = ApacheUtils.Nifi().get_processor_properties("processor_id")
    """

    try:
        processor = nipyapi.canvas.get_processor(processor_id)
        if processor is not None:
            properties = processor.to_dict()["component"]["config"]
            self.reporting.insert_step(
                f"Successfully retrieved properties for processor ID: {processor_id}",
                "Properties retrieved successfully",
                "Pass",
            )
            return properties
        self.reporting.insert_step(
            f"Failed to retrieve properties for processor ID: {processor_id}",
            "Processor not found",
            "Fail",
        )
        return False
    except (nipyapi.nifi.rest.ApiException, ValueError) as e:
        error_message = f"Error occurred while retrieving properties for processor " \
                        f"ID {processor_id}: {str(e)}"
        self.__obj_exception.raise_generic_exception(
            message=error_message,
            insert_report=True,
            trim_log=True,
            log_local=True,
            fail_test=False,
        )
        return False

get_processor_q_count(processor_id)

Gets the queue count of documents in the NiFi Processor.

Parameters:

Name Type Description Default
processor_id str

NiFi processor ID.

required

Returns:

Name Type Description
int int

Queue count of the processor.

Examples:

count = ApacheUtils.Nifi().get_processor_q_count("processor_id")

Source code in libs\cafex_core\src\cafex_core\utils\apache_utils.py
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
def get_processor_q_count(self, processor_id: str) -> int:
    """
    Gets the queue count of documents in the NiFi Processor.

    Args:
        processor_id (str): NiFi processor ID.

    Returns:
        int: Queue count of the processor.

    Examples:
        >> count = ApacheUtils.Nifi().get_processor_q_count("processor_id")
    """
    try:
        key_path = "status/aggregate_snapshot/queued_count"
        processor = self.nifi_module.canvas.get_processor(
            processor_id, identifier_type="id"
        )
        processor_q_count = self.get_key_path_value(
            json=processor.to_dict(), keyPath=key_path, keyPathType="absolute"
        )

        return processor_q_count

    except (nipyapi.nifi.rest.ApiException, ValueError) as e:
        error_message = f"Error occurred while retrieving queue count for processor ID " \
                        f"{processor_id}: {str(e)}"
        self.__obj_exception.raise_generic_exception(
            message=error_message,
            insert_report=True,
            trim_log=True,
            log_local=True,
            fail_test=False,
        )
        return 0

get_processors(pg_id='root', key_path=None)

Retrieves details of processors under the mentioned process group recursively.

Parameters:

Name Type Description Default
pg_id str

Process Group ID.

'root'
key_path str

Path of the field to be retrieved.

None

Returns:

Name Type Description
list list

Processors list or specified key path values.

Examples:

processors = ApacheUtils.Nifi().get_processors("process_group_id")

Source code in libs\cafex_core\src\cafex_core\utils\apache_utils.py
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
def get_processors(self, pg_id: str = "root", key_path: str = None) -> list:
    """
    Retrieves details of processors under the mentioned process group recursively.

    Args:
        pg_id (str): Process Group ID.
        key_path (str): Path of the field to be retrieved.

    Returns:
        list: Processors list or specified key path values.

    Examples:
        >> processors = ApacheUtils.Nifi().get_processors("process_group_id")
    """
    try:
        processors_list = []
        processor_list = nipyapi.canvas.list_all_processors(pg_id=pg_id)
        for processor in processor_list:
            if key_path:
                field_values = self.get_key_path_value(
                    json=processor.to_dict(), keyPath=key_path,
                    keyPathType="absolute"
                )
                processors_list.append(field_values)
            else:
                processors_list.append(processor)

        return processors_list

    except (nipyapi.nifi.rest.ApiException, ValueError) as e:
        error_message = f"Error occurred while retrieving processors for " \
                        f"process group ID {pg_id}: {str(e)}"
        self.__obj_exception.raise_generic_exception(
            message=error_message,
            insert_report=True,
            trim_log=True,
            log_local=True,
            fail_test=False,
        )
        return []

get_remote_process_groups(pg_id='root', key_path=None)

Retrieves all remote processor groups under the mentioned process group recursively.

Parameters:

Name Type Description Default
pg_id str

Process Group ID.

'root'
key_path str

Path of the field to be retrieved.

None

Returns:

Name Type Description
list list

Remote processor groups list or specified key path values.

Examples:

remote_groups = ApacheUtils.Nifi().get_remote_process_groups("process_group_id")

Source code in libs\cafex_core\src\cafex_core\utils\apache_utils.py
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
def get_remote_process_groups(self, pg_id: str = "root", key_path: str = None) -> list:
    """
    Retrieves all remote processor groups under the mentioned process group recursively.

    Args:
        pg_id (str): Process Group ID.
        key_path (str): Path of the field to be retrieved.

    Returns:
        list: Remote processor groups list or specified key path values.

    Examples:
        >> remote_groups = ApacheUtils.Nifi().get_remote_process_groups("process_group_id")
    """
    try:
        rpgs_list = []
        rpg_list = nipyapi.canvas.list_all_remote_process_groups(pg_id=pg_id)

        for pg in rpg_list:
            if key_path:
                field_values = self.get_key_path_value(
                    json=pg.to_dict(), keyPath=key_path, keyPathType="absolute"
                )
                rpgs_list.append(field_values)
            else:
                rpgs_list.append(pg)

        return rpgs_list

    except (nipyapi.nifi.rest.ApiException, ValueError) as e:
        error_message = f"Error occurred while retrieving remote process groups for " \
                        f"process group ID {pg_id}: {str(e)}"
        self.__obj_exception.raise_generic_exception(
            message=error_message,
            insert_report=True,
            trim_log=True,
            log_local=True,
            fail_test=False,
        )
        return []

get_security_token(username, password, is_password_encrypted)

Generates the authorized token used for login into NiFi.

Parameters:

Name Type Description Default
is_password_encrypted False

boolean value to check if password is encrypted

required
username str

Username.

required
password str

Password.

required

Returns:

Name Type Description
bool bool

Indicates if the token was generated successfully.

Examples:

success = ApacheUtils.Nifi().get_security_token("username", "password")

Source code in libs\cafex_core\src\cafex_core\utils\apache_utils.py
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
def get_security_token(self, username: str, password: str, is_password_encrypted: False) -> bool:
    """
    Generates the authorized token used for login into NiFi.

    Args:
        is_password_encrypted: boolean value to check if password is encrypted
        username (str): Username.
        password (str): Password.

    Returns:
        bool: Indicates if the token was generated successfully.

    Examples:
        >> success = ApacheUtils.Nifi().get_security_token("username", "password")
    """
    try:
        bool_token = Security().nifi_get_token(username, password,is_password_encrypted)
        if bool_token[0]:
            self.__nifi_token = bool_token[1]
            self.logger.info("Successfully generated NiFi security token.")
            return True
        self.logger.warning("Failed to generate NiFi security token: Invalid credentials.")
        return False
    except (nipyapi.nifi.rest.ApiException, ValueError) as e:
        error_message = f"Error occurred while generating NiFi security token: {str(e)}"
        self.__obj_exception.raise_generic_exception(
            message=error_message,
            insert_report=True,
            trim_log=True,
            log_local=True,
            fail_test=False,
        )
        return False

list_connections(pg_id='root', key_path=None)

Lists the connections of the queue in the process group.

Parameters:

Name Type Description Default
pg_id str

Process Group ID.

'root'
key_path str

Path of the field to be retrieved.

None

Returns:

Name Type Description
list list

Connections list or specified key path values.

Examples:

connections = ApacheUtils.Nifi().list_connections("process_group_id")

Source code in libs\cafex_core\src\cafex_core\utils\apache_utils.py
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
def list_connections(self, pg_id: str = "root", key_path: str = None) -> list:
    """
    Lists the connections of the queue in the process group.

    Args:
        pg_id (str): Process Group ID.
        key_path (str): Path of the field to be retrieved.

    Returns:
        list: Connections list or specified key path values.

    Examples:
        >> connections = ApacheUtils.Nifi().list_connections("process_group_id")
    """
    try:
        connections_list = []
        connection_list = nipyapi.canvas.list_all_connections(pg_id=pg_id)
        for conn in connection_list:
            if key_path:
                field_values = self.get_key_path_value(
                    json=conn.to_dict(), keyPath=key_path, keyPathType="absolute"
                )
                connections_list.append(field_values)
            else:
                connections_list.append(conn)

        return connections_list

    except (nipyapi.nifi.rest.ApiException, ValueError) as e:
        error_message = f"Error occurred while listing connections for " \
                        f"process group ID {pg_id}: {str(e)}"
        self.__obj_exception.raise_generic_exception(
            message=error_message,
            insert_report=True,
            trim_log=True,
            log_local=True,
            fail_test=False,
        )
        return []

list_queue_data(connection_id)

Lists the information of the queue in this connection.

Parameters:

Name Type Description Default
connection_id str

Connection ID.

required

Returns:

Name Type Description
ListingRequestEntity list | None

Lists the queue details.

Examples:

queue_data = ApacheUtils.Nifi().list_queue_data("connection_id")

Source code in libs\cafex_core\src\cafex_core\utils\apache_utils.py
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
def list_queue_data(self, connection_id: str) -> list | None:
    """
    Lists the information of the queue in this connection.

    Args:
        connection_id (str): Connection ID.

    Returns:
        ListingRequestEntity: Lists the queue details.

    Examples:
        >> queue_data = ApacheUtils.Nifi().list_queue_data("connection_id")
    """
    try:
        listing_request = self.apis.get("flowfile_queues_api"). \
            create_flow_file_listing(connection_id)
        if listing_request is not None:
            self.reporting.insert_step(
                "Successfully listed queue connection data",
                "Successfully listed queue connection data",
                "Pass",
            )
            return listing_request
        self.reporting.insert_step(
            "Failed to list queue connection data",
            "No data returned for the queue connection",
            "Fail",
        )
        return None

    except (nipyapi.nifi.rest.ApiException, ValueError) as e:
        error_message = f"Error occurred while listing queue data for connection " \
                        f"ID {connection_id}: {str(e)}"
        self.__obj_exception.raise_generic_exception(
            message=error_message,
            insert_report=True,
            trim_log=True,
            log_local=True,
            fail_test=False,
        )
        return None

start_then_stop_pg(pg_id, wait_time=10)

Starts and stops the NiFi process group.

Parameters:

Name Type Description Default
pg_id str

The NiFi process group ID.

required
wait_time int

Time to wait before stopping the NiFi process group.

10

Returns:

Name Type Description
bool bool

True if successful; otherwise, False.

Examples:

result = ApacheUtils.Nifi().start_then_stop_pg("process_group_id", 10)

Source code in libs\cafex_core\src\cafex_core\utils\apache_utils.py
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
def start_then_stop_pg(self, pg_id: str, wait_time: int = 10) -> bool:
    """
    Starts and stops the NiFi process group.

    Args:
        pg_id (str): The NiFi process group ID.
        wait_time (int): Time to wait before stopping the NiFi process group.

    Returns:
        bool: True if successful; otherwise, False.

    Examples:
        >> result = ApacheUtils.Nifi().start_then_stop_pg("process_group_id", 10)
    """
    try:
        process_group_status = nipyapi.canvas. \
            get_process_group_status(pg_id=pg_id, detail="names")
        if process_group_status is not None:
            self.reporting.insert_step(
                "Processor group found", "Processor group found", "Pass"
            )
            nipyapi.canvas.schedule_process_group(pg_id, scheduled=True)
            self.logger.info("Process group %s started.", pg_id)
            time.sleep(wait_time)
            nipyapi.canvas.schedule_process_group(pg_id, scheduled=False)
            self.logger.info("Process group %s stopped after %s seconds."
                             , pg_id, wait_time)
            return True
        self.reporting.insert_step(
            "Processor group not found", "Processor group not found", "Fail"
        )
        self.logger.warning("Process group %s not found.", pg_id)
        return False

    except (nipyapi.nifi.rest.ApiException, ValueError) as e:
        error_message = f"Error occurred while starting and stopping process" \
                        f" group {pg_id}: {str(e)}"
        self.__obj_exception.raise_generic_exception(
            message=error_message,
            insert_report=True,
            trim_log=True,
            log_local=True,
            fail_test=False,
        )
        return False

start_then_stop_processor(server_name, processor_id, min_wait_time=0, max_wait_time=50, wait_interval=5)

Starts and stops the given processor.

Parameters:

Name Type Description Default
server_name str

NiFi server URL.

required
processor_id str

NiFi processor ID.

required
min_wait_time int

Minimum wait time in seconds.

0
max_wait_time int

Maximum wait time in seconds.

50
wait_interval int

Polling time to check each time in seconds.

5

Returns:

Name Type Description
bool bool

True if successful; otherwise, False.

Examples:

result = ApacheUtils.Nifi(). start_then_stop_processor("http://localhost:8080", "processor_id")

Source code in libs\cafex_core\src\cafex_core\utils\apache_utils.py
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
def start_then_stop_processor(
        self,
        server_name: str,
        processor_id: str,
        min_wait_time: int = 0,
        max_wait_time: int = 50,
        wait_interval: int = 5,
) -> bool:
    """
    Starts and stops the given processor.

    Args:
        server_name (str): NiFi server URL.
        processor_id (str): NiFi processor ID.
        min_wait_time (int): Minimum wait time in seconds.
        max_wait_time (int): Maximum wait time in seconds.
        wait_interval (int): Polling time to check each time in seconds.

    Returns:
        bool: True if successful; otherwise, False.

    Examples:
        >> result = ApacheUtils.Nifi().
        start_then_stop_processor("http://localhost:8080", "processor_id")
    """
    try:
        self.change_nifi_processor_state(server_name, processor_id, "RUNNING")
        time.sleep(min_wait_time)
        if wait_interval <= 0:
            self.reporting.insert_step(
                "Invalid wait interval",
                "Wait interval must be greater than 0",
                "Fail",
            )
            return False
        limit = max_wait_time // wait_interval
        count = 0
        while count < limit:
            time.sleep(wait_interval)
            path = "status/aggregate_snapshot/active_thread_count"
            _, processor_data = self.__get_processor(processor_id)
            json_counter = self.get_key_path_value(
                json=processor_data.to_dict(), keyPath=path, keyPathType="absolute"
            )

            if int(json_counter) == 0:
                break

            count += 1
        else:
            self.reporting.insert_step(
                f"Processor {processor_id} should not have active threads.",
                f"Processor is taking more than {max_wait_time} seconds to stop.",
                "Fail",
            )
            return False
        self.change_nifi_processor_state(server_name, processor_id, "STOPPED")
        self.reporting.insert_step(
            f"Processor {processor_id} has been successfully started and stopped.",
            "Processor started and stopped successfully.",
            "Pass",
        )
        return True

    except (nipyapi.nifi.rest.ApiException, ValueError) as e:
        error_message = f"Error occurred while starting and stopping processor" \
                        f" ID {processor_id}: {str(e)}"
        self.__obj_exception.raise_generic_exception(
            message=error_message,
            insert_report=True,
            trim_log=True,
            log_local=True,
            fail_test=False,
        )
        return False

update_processor_properties(processor_id, properties)

Updates the properties of a specified NiFi processor with the provided properties.

Parameters:

Name Type Description Default
processor_id str

NiFi processor ID.

required
properties dict

A dictionary containing the properties to update.

required

Returns:

Name Type Description
bool bool

True if the update was successful; otherwise, False.

Examples:

success = ApacheUtils.Nifi(). update_processor_properties("processor_id", {"property_name": "value"})

Source code in libs\cafex_core\src\cafex_core\utils\apache_utils.py
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
def update_processor_properties(self, processor_id: str, properties: dict) -> bool:
    """
    Updates the properties of a specified NiFi processor with the provided properties.

    Args:
        processor_id (str): NiFi processor ID.
        properties (dict): A dictionary containing the properties to update.

    Returns:
        bool: True if the update was successful; otherwise, False.

    Examples:
        >> success = ApacheUtils.Nifi().
        update_processor_properties("processor_id", {"property_name": "value"})

    """
    try:
        processor = nipyapi.canvas.get_processor(processor_id)
        if processor is not None:
            # Prepare the payload for updating properties
            payload = {
                "revision": {
                    "clientId": processor.revision.client_id,
                    "version": processor.revision.version,
                },
                "component": {
                    "config": properties
                }
            }
            response = self.call_request(
                "PUT",
                f"/nifi-api/processors/{processor_id}",
                {"Content-Type": "application/json"},
                pstr_payload=json.dumps(payload)
            )
            if response.status_code == 200:
                self.reporting.insert_step(
                    f"Successfully updated properties for processor ID: {processor_id}",
                    "Properties updated successfully",
                    "Pass",
                )
                return True
            self.reporting.insert_step(
                f"Failed to update properties for processor ID: {processor_id}",
                "Update failed",
                "Fail",
            )
            return False
    except (nipyapi.nifi.rest.ApiException, ValueError) as e:
        error_message = f"Error occurred while updating properties for processor ID " \
                        f"{processor_id}: {str(e)}"
        self.__obj_exception.raise_generic_exception(
            message=error_message,
            insert_report=True,
            trim_log=True,
            log_local=True,
            fail_test=False,
        )
        return False