Skip to main content
Version: 1.16

Plugins

As described in the conception section, the rs-ingest microservice is based on Ingest chains to process products creation requests. An Ingest chain is a workflow composed of successive steps. Each step of the workflow is an extension point implemented through plugins. Those extension points are :

  • SIP validation
  • SIP Pre processing
  • AIP Metadata Generation
  • AIP Storage Metadata Generation
  • AIP Tagging
  • SIP Post processing
developers advice

If you want to create your own implementation of one of these extension points, you need to extend the specific interface indicated.

SIP Validation plugins

All the following plugins implements the ISipValidation interface.

Plugin imagePlugin nameDescription
Already provided
inside the microservice
DefaultSIPValidationProducts are not validated
Already provided
inside the microservice
UniqueProviderIdSipValidationInvalidate products if a previous version already exists

SIP Pre processing plugins

All the following plugins implements the ISipPreprocessing interface.

No plugin available yet.

AIP Metadata generation

All the following plugins implements the IAipGeneration interface.

Plugin imagePlugin nameDescription
Already provided
inside the microservice
DefaultSingleAIPGenerationNo metadata enhancement, SIP metadata are reported in the AIP
rs-enhanced-descriptive-aip-generation-pluginStringEnhancedDescriptiveAipGenerationAdd given key/value metadata (wih string value) to every AIP on descriptiveInformation section
Not yet publishedStringArrayEnhancedDescriptiveAipGenerationAdd given key/values metadata (wih string values) to every AIP on descriptiveInformation section

AIP Storage metadata generation

All the following plugins implements the IAIPStorageMetadataUpdate interface.

Plugin imagePlugin nameDescription
Already provided
inside the microservice
VirtualStorageLocationTransforms a configured virtual storage location into one or many real storage locations

AIP Tagging

All the following plugins implements the IAipTagging interface.

Plugin imagePlugin nameDescription
Already provided
inside the microservice
DefaultAIPTaggingAdds configured tags to every new AIP

SIP Post processing plugins

All the following plugins implements the ISipPostprocessing interface.

Plugin imagePlugin nameDescription
Not yet publishedSendDeleteFilesWorkerRequestSend an AMQP request to worker manager with all SIP input files