DGS Get Revoked Items Component
The DGS Get Revoked Items component is used to retrieve the DGS IDs and associated storage keys for all data items that have been revoked or should be deleted. This process occurs in two stages.
The first stage involves the invocation of the getExpiredItems function on the DGS storage resource. If such a function is available, it is executed and all DGS items it returns have their status updated to REVOKED for the current custodian. Unlike updating an items status with the Status Updater, this does not cascade revoke child items. If such behavior is desired, it is up to the getExpiredItems function to return the IDs of all the children it should revoke.
The second stage involves retrieving all the items in the DGS Storage whose status for the current custodian is REVOKED along with any storage metadata. Any items that have associated storage metadata are returned on the revokedItems output channel. Any items that do not have associated storage metadata have their status immediately updated to DELETED for the current custodian. If there are no items to return on the revokedItems output channel, a Signal Data is returned on the noResults output channel to indicate that nothing was returned.
The component can be invoked manually using its invoke input channel, or automatically by configuring the autoInvokeInterval parameter. If the autoInvokeInterval is configured, the component will automatically invoke itself when the specified interval expires. If the input channel is triggered by a SignalData object, the component will immediately check for and return any expired items. If the component configured with an autoInvokeInterval is triggered via its input channel, the automatic invocation timer will reset so that the next automatic invocation will occur the configured number of seconds after the manual invocation.
Input Channels
invoke — Receives a SignalData object that triggers the component to check for and return any revoked items. Triggering this component via this input channel will reset the auto invocation timer delay future automatic invocations.
Output Channels
revokedItems — Returns SimpleMappedData objects containing the associated data for any items that have expired or been revoked in the configured scope. One SimpleMappedData object is returned for each of the objects that have been revoked.
noResults — Returns a SignalData object to indicate that the component executed, but there were no revoked items to return.
Parameters
autoInvokeInterval — (int, default: 0) How frequently (in seconds) this component should auto-invoke. Values less than 1 or greater than 1 year will disable the auto-invoke behavior.