Package com.siemens.polarion.rt.collectors.api

Interface RtCollector

public interface RtCollector
The collector of changed files from the repository. Instances of this class are created for each repository and project by collector provider. A single instance is used multiple times in the task that is repeated with a fixed delay. If the repository configuration or another collector related configuration is changed, then a new collector instance is created. The collector engine ensures that only a single collector instance is used by a single thread at the same time.

Users who want to create a custom collector should implement this interface. Each implementation class should define a no-argument constructor. To provide custom collector user should contribute parser element to extension point com.siemens.polarion.rt.collectors in plugin.xml file 
 
 <extension point="com.siemens.polarion.rt.collectors">
    <collector
          class="com.example.collectors.CustomCollector"
          repositoryProvider="providerId">
    </collector>
 </extension>
Attributes in the collector element are defined as follows:
class the full name of class that provides the collection capability. This class should implement RtCollector
repositoryProvider the id of the repository provider that the provided collector will work with. The Id of repository provider can be found in the IResourceTraceabilityRepositoryConfiguration.getProviderId() repository configuration class.
Since:
3.17.0

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    collect(RtCollectionContext context)
    Collects repository changes and notifies the collector engine about the changes by calling RtCollectionContext.collect(RtFile) A Repository change is an addition, modification or deletion of a file or the deletion of a folder.

  • Method Details

    • collect

      void collect(@NotNull RtCollectionContext context)
      Collects repository changes and notifies the collector engine about the changes by calling RtCollectionContext.collect(RtFile) A Repository change is an addition, modification or deletion of a file or the deletion of a folder.
      Parameters:
      context - the object that holds the state of the collection process.