[STREAMPIPES-81] Extend wrapper interfaces

• Type: Improvement
• Status: Open
• Priority: Major
• Resolution: Unresolved
• Fix Version/s: post-1.0
• Component/s: Backend, Pipeline Elements
• Assignee: Unassigned
• Reporter: Dominik Riemer
• Created: 20/Feb/20 21:17
• Updated: 26/Nov/22 12:47

Description

Currently, pipeline elements implement an interface that provides the three methods onInvocation, onEvent and onDetach.

In future enhancements, we plan to introduce features that require actions at pipeline creation time, e.g., to create a virtual data stream once a pipeline is stored. To avoid installing/deinstalling such a stream at every start/stop of a pipeline, the wrapper interfaces should be extended/refactored as follows:

• Add an onPipelineStored method to the pipeline element definition
• Add an onPipelineDeleted method to the pipeline element definition
• Rename onInvocation to onPipelineStarted and onDetach to onPipelineStopped for clarifying the scope of the provided methods
• Ensure backwards compatibility by introducing API versioning for pipeline element endpoints
• Extend the endpoints to handle onPipelineStored/Delete calls, HTTP Post/Delete for Store/Delete and HTTP PUT for Start/Stop