|
|
# IDS Framework
|
|
|
|
|
|
The IDS Framework aims to simplify the development of an IDS Connector. The Framework provides basic functionality encompassing creation and handling of IDS messages and communication to the DAPS and Brokers. However, different Connectors can have various requirements regarding protocols and data endpoint types for data exchange. Therefore, the final implementation of the data exchange remains for applications leveraging the Framework.
|
|
|
The IDS Framework aims to simplify the development of an IDS Connector. The Framework provides basic functionality encompassing the creating and handling of IDS messages and communication to the DAPS and Brokers. However, different Connectors can have various requirements regarding protocols and data endpoint types for data exchange. Therefore, the final implementation of the data exchange remains at applications using the Framework.
|
|
|
It will be developed continuously to improve and simplify the development of IDS Connectors.
|
|
|
|
|
|
## Modules
|
|
|
|
|
|
The IDS Framework consists of multiple modules which are briefly described on this page:
|
|
|
- [base](./Modules/Base): Basic utility classes for communication within the IDS, e.g. build and send IDS messages, load KeyStore and TrustStore.
|
|
|
- [base](./Modules/Base): Basic utility classes for communication within the IDS, e.g. build and send IDS messages, load KeyStore and TrustStore, and acquire tokens from DAPS. This module uses Spring Boot which allows to wrap the classes into Spring Boot components for quick development.
|
|
|
- [configurationmanager](./Modules/Configurationmanager): Utility for connecting to a Configurationmanager, modifying the configuration of your connector via webapp and more (currently an unreleased WIP project).
|
|
|
- [messaging-core](./Modules/Messaging-Core): Provides core components for message handling in the IDS Frameworks like message MessageDispatcher, MessageHandler and a validation for DAPS token. MessageHandler, Dispatcher and Resolver have to be implemented by the user.
|
|
|
- [messaging-spring](./Modules/Messaging-Spring): Implementation of the messaging-core module using the Spring Boot framework. Users of this module only have to implement the MessageHandler interface (because their implementation has to be application specific).
|
|
|
- [spring-starter](./Modules/Spring-Starter): Starter module for Spring Boot applications that includes default Spring components of classes of the base module for quick development of an IDS Connector.
|
|
|
- [messaging](./Modules/Messaging): Provides core components for message handling in the IDS Frameworks like message IDSController, MessageDispatcher, MessageHandler and a validation for DAPS token. MessageHandler have to be implemented by the user, own Dispatcher and Resolver can be implemented. The implementation of them has to be application specific.
|
|
|
|
|
|
For detailed information about the modules and how to use them take a look at their respective pages.
|
|
|
|
|
|
## Architecture
|
|
|
|
|
|
## Maven Repository
|
|
|
|
|
|
Before using any module of the IDS Framework in your project, the `isst-nexus-public` repository must be added to the repositories in your `pom.xml` file.
|
... | ... | |