NMS-19261: Implement REST endpoint to upload and import vendor XML files into database #8239

aurang-zeb313 · 2026-01-15T16:48:41Z

External References

Jira (Issue Tracker): https://opennms.atlassian.net/browse/NMS-19261

…g unique names and ids list

…ra/NMS-19261

* new changes * new changes * changes * changes * file reverted * changes * revert changes * new changes

…ra/NMS-19261

…d searching (#8245) * Integrate source rest endpoint with pagination, sorting and searching * Overwrite and rename file changes

…/jira/NMS-19261

Copilot

Pull request overview

This PR implements a REST endpoint for uploading and importing vendor XML files into the database for SNMP data collection configuration. The implementation includes frontend components for file upload, validation, and display, along with backend services for parsing XML files, persisting data to the database, and retrieving collection sources with filtering and pagination.

Changes:

Added REST API endpoints for uploading SNMP data collection XML files and retrieving collection sources
Implemented frontend UI components for file upload with drag-and-drop, validation, and duplicate detection
Created database persistence layer with DAO methods for filtering and pagination

Reviewed changes

Copilot reviewed 38 out of 42 changed files in this pull request and generated 7 comments.

Show a summary per file

File	Description
ui/src/stores/snmpDataCollectionStore.ts	Added API integration for fetching and filtering SNMP collection sources
ui/src/stores/snmpDataCollectionDetailStore.ts	Replaced mock data with actual API calls for fetching collection source details
ui/src/services/snmpDataCollectionService.ts	New service layer for SNMP data collection API calls
ui/src/mappers/snmpDataCollection.mapper.ts	Added mappers to transform server responses to client data structures
ui/src/main/router/index.ts	Added route for SNMP data collection import page
ui/src/containers/SnmpDataCollectionSourceImport.vue	New container component for the import page
ui/src/containers/SnmpDataCollectionDetail.vue	Reorganized imports
ui/src/containers/SnmpDataCollection.vue	Added navigation handlers for create and import actions
ui/src/components/SnmpDataCollectionSourceImport/snmpDataCollectionSourceXmlValidator.ts	Client-side XML validation logic for SNMP collection files
ui/src/components/SnmpDataCollectionSourceImport/SnmpDataCollectionSourceImport.vue	Main component for file upload, validation, and submission
ui/src/components/SnmpDataCollectionSourceImport/Dialog/UploadedFileRenameDialog.vue	Dialog for handling duplicate file names
ui/src/components/SnmpDataCollectionSourceImport/Dialog/DataCollectionFilesUploadReportDialog.vue	Dialog showing upload results
ui/src/components/SnmpDataCollection/data.ts	Removed mock data file
ui/src/components/SnmpDataCollection/SnmpDataCollectionSourcesTable.vue	Added pagination support
opennms-webapp-rest/src/test/resources/applicationContext-rest-test.xml	Registered new REST service beans
opennms-webapp-rest/src/test/resources/DATACOLLECTION/dell.xml	Test XML file for data collection configuration
opennms-webapp-rest/src/test/java/org/opennms/web/rest/v2/DataCollectionConfRestServiceIT.java	Integration tests for REST endpoints
opennms-webapp-rest/src/test/java/org/opennms/web/rest/v2/DataCollectionConfPersistenceServiceIT.java	Integration tests for persistence service
opennms-webapp-rest/src/main/java/org/opennms/web/rest/v2/model/SnmpCollectionSourceNamesAndIdsResponse.java	DTO for collection source names and IDs
opennms-webapp-rest/src/main/java/org/opennms/web/rest/v2/api/DataCollectionConfRestApi.java	REST API interface definition
opennms-webapp-rest/src/main/java/org/opennms/web/rest/v2/DataCollectionConfRestService.java	REST API implementation
opennms-webapp-rest/src/main/java/org/opennms/web/rest/v2/DataCollectionConfPersistenceService.java	Service for persisting data collection configurations
opennms-model/src/main/java/org/opennms/netmgt/model/SnmpCollectionSystemDefDto.java	DTO for system definitions
opennms-model/src/main/java/org/opennms/netmgt/model/SnmpCollectionSourceDto.java	DTO for collection sources
opennms-model/src/main/java/org/opennms/netmgt/model/SnmpCollectionResourceTypeDto.java	DTO for resource types
opennms-model/src/main/java/org/opennms/netmgt/model/SnmpCollectionMibGroupDto.java	DTO for MIB groups
opennms-dao/src/test/java/org/opennms/netmgt/dao/*.java	DAO integration tests for filtering and pagination
opennms-dao/src/main/java/org/opennms/netmgt/dao/hibernate/*.java	DAO implementations with filtering, sorting, and pagination
opennms-dao-api/src/main/java/org/opennms/netmgt/dao/api/*.java	DAO interface definitions

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-01-23T16:30:29Z

...c/components/SnmpDataCollectionSourceImport/Dialog/DataCollectionFilesUploadReportDialog.vue

+import { EventConfigFilesUploadResponse } from '@/types/eventConfig'
+import { FeatherButton } from '@featherds/button'
+import { FeatherDialog } from '@featherds/dialog'
+
+const props = defineProps<{
+  report: EventConfigFilesUploadResponse,


The import uses EventConfigFilesUploadResponse type but this is for SNMP data collection, not event configuration. This appears to be a copy-paste error from similar event config functionality. The type should be SnmpDataCollectionSourceUploadResponse which is already defined in the snmpDataCollection types.

Suggested change

import { EventConfigFilesUploadResponse } from '@/types/eventConfig'

import { FeatherButton } from '@featherds/button'

import { FeatherDialog } from '@featherds/dialog'

const props = defineProps<{

report: EventConfigFilesUploadResponse,

import { SnmpDataCollectionSourceUploadResponse } from '@/types/snmpDataCollection'

import { FeatherButton } from '@featherds/button'

import { FeatherDialog } from '@featherds/dialog'

const props = defineProps<{

report: SnmpDataCollectionSourceUploadResponse,

Copilot · 2026-01-23T16:30:29Z

ui/src/components/SnmpDataCollectionSourceImport/Dialog/UploadedFileRenameDialog.vue

+          label="New File Name"
+          :error="error"
+          :error-message="error || ''"
+          placeholder="Enter new file name (must end with .events.xml)"


The placeholder text incorrectly states files must end with '.events.xml' but this is for SNMP data collection files which should end with '.xml'. The validation at line 97 correctly checks for '.xml' extension.

Suggested change

placeholder="Enter new file name (must end with .events.xml)"

placeholder="Enter new file name (must end with .xml)"

Copilot · 2026-01-23T16:30:30Z

ui/src/components/SnmpDataCollectionSourceImport/SnmpDataCollectionSourceImport.vue

+    <div class="info-section">
+      <h3>Instructions:</h3>
+      <ul>
+        <li>Event configuration files must be in XML format with a .xml extension.</li>


The instruction refers to 'Event configuration files' but this component is for SNMP data collection source files. The text should say 'SNMP data collection configuration files must be in XML format with a .xml extension.'

Suggested change

<li>Event configuration files must be in XML format with a .xml extension.</li>

<li>SNMP data collection configuration files must be in XML format with a .xml extension.</li>

Copilot · 2026-01-23T16:30:30Z

opennms-webapp-rest/src/main/java/org/opennms/web/rest/v2/api/DataCollectionConfRestApi.java

+    @Operation(
+            summary = "Upload datacollectionconf files",
+            description = "Upload one or more  data collection config files.",
+            operationId = "uploadEventConfFiles"


The operationId is 'uploadEventConfFiles' but this endpoint uploads SNMP data collection configuration files, not event configuration files. It should be 'uploadSnmpDataCollectionConfFiles' or similar to match the actual functionality.

Suggested change

operationId = "uploadEventConfFiles"

operationId = "uploadSnmpDataCollectionConfFiles"

Copilot · 2026-01-23T16:30:30Z

opennms-webapp-rest/src/main/java/org/opennms/web/rest/v2/api/DataCollectionConfRestApi.java

+    @Operation(
+            summary = "Get SnmpCollectionSource by ID",
+            description = "Retrieve an SnmpCollectionSource by its unique identifier.",
+            operationId = "getEventConfSourceById"


The operationId is 'getEventConfSourceById' but this endpoint retrieves SNMP collection sources, not event configuration sources. It should be 'getSnmpCollectionSourceById' to accurately reflect its purpose.

Suggested change

operationId = "getEventConfSourceById"

operationId = "getSnmpCollectionSourceById"

Copilot · 2026-01-23T16:30:31Z

opennms-webapp-rest/src/main/java/org/opennms/web/rest/v2/api/DataCollectionConfRestApi.java

+    @Operation(
+            summary = "Get SnmpCollection Source Names",
+            description = "Retrieve the names and Ids of all SnmpCollection sources stored in the database.",
+            operationId = "getEventConfSourcesNames"


The operationId is 'getEventConfSourcesNames' but this endpoint retrieves SNMP collection source names and IDs. It should be 'getSnmpCollectionSourceNamesAndIds' to match the method name and functionality.

Suggested change

operationId = "getEventConfSourcesNames"

operationId = "getSnmpCollectionSourceNamesAndIds"

Copilot · 2026-01-23T16:30:31Z

...o/src/main/java/org/opennms/netmgt/dao/hibernate/SnmpCollectionResourceTypeDaoHibernate.java

+        }
+
+        if (name != null && !name.trim().isEmpty()) {
+            queryBuilder.append(" and lower(t.collectionSource.name) like ? escape '\\' ");


The variable name 'name' in the method signature for filterEventConf is misleading - it actually filters by collection source name, not resource type name. The parameter should be renamed to 'collectionSourceName' for clarity.

Copilot

Pull request overview

Copilot reviewed 38 out of 42 changed files in this pull request and generated 3 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-01-23T17:53:34Z

ui/src/components/SnmpDataCollectionSourceImport/SnmpDataCollectionSourceImport.vue

+    <div class="info-section">
+      <h3>Instructions:</h3>
+      <ul>
+        <li>Event configuration files must be in XML format with a .xml extension.</li>


Corrected instruction text from "Event configuration files" to "SNMP data collection files" to accurately reflect the file type being uploaded.

Suggested change

<li>Event configuration files must be in XML format with a .xml extension.</li>

<li>SNMP data collection files must be in XML format with a .xml extension.</li>

Copilot · 2026-01-23T17:53:35Z

ui/src/containers/SnmpDataCollectionSourceImport.vue

+
+<script setup lang="ts">
+import SnmpDataCollectionSourceImport from '@/components/SnmpDataCollectionSourceImport/SnmpDataCollectionSourceImport.vue'
+import FeatherBackButton from '@featherds/back-button/src/components/FeatherBackButton/FeatherBackButton.vue'


Missing import statement for useRouter. Add "import { useRouter } from 'vue-router'" to the imports section.

Suggested change

import FeatherBackButton from '@featherds/back-button/src/components/FeatherBackButton/FeatherBackButton.vue'

import FeatherBackButton from '@featherds/back-button/src/components/FeatherBackButton/FeatherBackButton.vue'

import { useRouter } from 'vue-router'

Copilot · 2026-01-23T17:53:35Z

opennms-webapp-rest/src/main/java/org/opennms/web/rest/v2/DataCollectionConfRestService.java

+        return result.trim();
+    }
+
+    private Map<String, Object> buildSuccessResponse(String filename, DatacollectionGroup datCollectionConfig) {


Corrected spelling of parameter name from 'datCollectionConfig' to 'dataCollectionConfig'.

Suggested change

private Map<String, Object> buildSuccessResponse(String filename, DatacollectionGroup datCollectionConfig) {

private Map<String, Object> buildSuccessResponse(String filename, DatacollectionGroup dataCollectionConfig) {

cgorantla · 2026-01-23T23:07:03Z

opennms-dao-api/src/main/java/org/opennms/netmgt/dao/api/SnmpCollectionMibGroupDao.java

+
+    void deleteBySourceId(Integer sourceId);
+
+    List<SnmpCollectionMibGroup> filterEventConf(String name,String ifType, String vendor, String collectionSourceName, int offset, int limit);


filterEventConf ?

cgorantla · 2026-01-23T23:07:17Z

opennms-dao-api/src/main/java/org/opennms/netmgt/dao/api/SnmpCollectionMibGroupDao.java

+
+    void deleteBySourceId(Integer sourceId);
+
+    List<SnmpCollectionMibGroup> filterEventConf(String name,String ifType, String vendor, String collectionSourceName, int offset, int limit);


please format

cgorantla · 2026-01-23T23:08:21Z

opennms-dao-api/src/main/java/org/opennms/netmgt/dao/api/SnmpCollectionResourceTypeDao.java

+
+    void deleteBySourceId(Integer sourceId);
+
+    List<SnmpCollectionResourceType> filterEventConf(String name,String label, String vendor, String collectionSourceName, int offset, int limit);


filterEventConf seems to be wrong here

cgorantla · 2026-01-23T23:14:17Z

...s-dao/src/main/java/org/opennms/netmgt/dao/hibernate/SnmpCollectionMibGroupDaoHibernate.java

+     * @param input the input string
+     * @return the escaped string
+     */
+    private String escapeLike(String input) {


can be common util method

cgorantla · 2026-01-23T23:21:36Z

opennms-dao-api/src/main/java/org/opennms/netmgt/dao/api/SnmpCollectionSystemDefDao.java

+
+    List<SnmpCollectionSystemDef> filterSystemDefsConf(String name,String vendor, String collectionSourceName, int offset, int limit);
+
+    Map<String, Object> findByDataCollectionGroupId(Integer dataCollectionGroupId, String systemDefsFilter, String sortBy, String order, Integer totalRecords, Integer offset, Integer limit);


may be it's better to rename datacollection_group_id to snmpcollection_source_id

cgorantla · 2026-01-23T23:23:19Z

opennms-dao-api/src/main/java/org/opennms/netmgt/dao/api/SnmpCollectionSourceDao.java


+    Map<Integer, String> getIdToNameMap();
+
+    Map<String, Object> filterDataCollectionSource(final String filter, final String sortBy, final String order, Integer totalRecords,


We should try to avoid using Object. You can wrap these into another object and use actual Class with generics

NMS-19261: Data collection upload and filtering rest api's

ca64ff0

aurang-zeb313 marked this pull request as draft January 15, 2026 16:55

NMS-19261: Expose services to get collection sources by id and gettin…

9469db8

…g unique names and ids list

Shahbaz-dataq changed the base branch from develop to features/snmp-datacollection-db January 18, 2026 10:41

Shahbaz-dataq and others added 7 commits January 19, 2026 00:08

Merge commit '6cbe0b37598f6026ee6d0eb2c2902f2a66e65f37' into akhan/ji…

8c3dc0d

…ra/NMS-19261

NMS-19405: Upload data collection files from vendor (#8243)

4ccccba

* new changes * new changes * changes * changes * file reverted * changes * revert changes * new changes

Merge commit 'b683ad4476b84df6d52ee7f7639df116c6d34a2b' into akhan/ji…

f8b6bd4

…ra/NMS-19261

NMS-19261: Test cases for data collection API's

7fb843a

NMS-19439: Integrate source rest endpoint with pagination, sorting an…

c8a0655

…d searching (#8245) * Integrate source rest endpoint with pagination, sorting and searching * Overwrite and rename file changes

NMS-19261: Remove wildcard imports and fix test cases issues.

0c477ce

Merge remote-tracking branch 'origin/akhan/jira/NMS-19261' into akhan…

4fd17aa

…/jira/NMS-19261

aurang-zeb313 marked this pull request as ready for review January 23, 2026 15:59

aurang-zeb313 requested review from cgorantla and Copilot January 23, 2026 16:28

Copilot AI reviewed Jan 23, 2026

View reviewed changes

NMS-19261: Remove wildcard imports and fix test cases issues.

797b2aa

aurang-zeb313 requested a review from Copilot January 23, 2026 17:52

Copilot AI reviewed Jan 23, 2026

View reviewed changes

cgorantla reviewed Jan 23, 2026

View reviewed changes

	placeholder="Enter new file name (must end with .events.xml)"
	placeholder="Enter new file name (must end with .xml)"

	<li>Event configuration files must be in XML format with a .xml extension.</li>
	<li>SNMP data collection configuration files must be in XML format with a .xml extension.</li>

	operationId = "uploadEventConfFiles"
	operationId = "uploadSnmpDataCollectionConfFiles"

	operationId = "getEventConfSourceById"
	operationId = "getSnmpCollectionSourceById"

	operationId = "getEventConfSourcesNames"
	operationId = "getSnmpCollectionSourceNamesAndIds"

	<li>Event configuration files must be in XML format with a .xml extension.</li>
	<li>SNMP data collection files must be in XML format with a .xml extension.</li>

	import FeatherBackButton from '@featherds/back-button/src/components/FeatherBackButton/FeatherBackButton.vue'
	import FeatherBackButton from '@featherds/back-button/src/components/FeatherBackButton/FeatherBackButton.vue'
	import { useRouter } from 'vue-router'

	private Map<String, Object> buildSuccessResponse(String filename, DatacollectionGroup datCollectionConfig) {
	private Map<String, Object> buildSuccessResponse(String filename, DatacollectionGroup dataCollectionConfig) {


		void deleteBySourceId(Integer sourceId);

		List<SnmpCollectionMibGroup> filterEventConf(String name,String ifType, String vendor, String collectionSourceName, int offset, int limit);


		void deleteBySourceId(Integer sourceId);

		List<SnmpCollectionResourceType> filterEventConf(String name,String label, String vendor, String collectionSourceName, int offset, int limit);


		List<SnmpCollectionSystemDef> filterSystemDefsConf(String name,String vendor, String collectionSourceName, int offset, int limit);

		Map<String, Object> findByDataCollectionGroupId(Integer dataCollectionGroupId, String systemDefsFilter, String sortBy, String order, Integer totalRecords, Integer offset, Integer limit);


		Map<Integer, String> getIdToNameMap();

		Map<String, Object> filterDataCollectionSource(final String filter, final String sortBy, final String order, Integer totalRecords,

NMS-19261: Implement REST endpoint to upload and import vendor XML files into database #8239

Are you sure you want to change the base?

NMS-19261: Implement REST endpoint to upload and import vendor XML files into database #8239

Conversation

aurang-zeb313 commented Jan 15, 2026

External References

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Jan 23, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 23, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 23, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 23, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 23, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 23, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 23, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Jan 23, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 23, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 23, 2026

Choose a reason for hiding this comment

Uh oh!

cgorantla Jan 23, 2026

Choose a reason for hiding this comment

Uh oh!

cgorantla Jan 23, 2026

Choose a reason for hiding this comment

Uh oh!

cgorantla Jan 23, 2026

Choose a reason for hiding this comment

Uh oh!

cgorantla Jan 23, 2026

Choose a reason for hiding this comment

Uh oh!

cgorantla Jan 23, 2026

Choose a reason for hiding this comment

Uh oh!

cgorantla Jan 23, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants