The Storage service is responsible for storing and retrieving files. It provides REST endpoints for uploading and downloading files and uses the messaging queue to send status updates for files.
Key functions of the Storage Service include:
•Storing the final Network Locator results as ZIP files.
•Providing download links for the final results (accessible only to the user that created the request or an admin).
•Tracking the number of downloads for each file.
•Expiring files after a configurable period.
Configuration
Setting |
Type |
Description |
vertigis.storage.expiration.enabled |
boolean |
Enables or disables expiration for stored files. true | false |
vertigis.storage.expiration.duration |
int |
Specifies the number of days after which a locate request should expire. |
vertigis.storage.expiration.schedule-cron |
string |
Cron Expression (Quartz style) e.g.: "0 0 6 * * ?" Runs every day at 6 o'clock in the morning and check whether a file is expired or not. |
vertigis.storage.security.file-upload.max-file-name-length |
int |
Specifies the maximum length (in characters) allowed for a file name. |
vertigis.storage.security.file-upload.max-file-size |
int |
Defines the maximum file size allowed for uploads, in bytes. |
vertigis.storage.security.file-upload.max.allowed-file-extensions |
string |
Lists the file extensions that are allowed for uploads (e.g., .pdf, .png, .csv). |
vertigis.storage.security.file-upload.mime-type-mapping |
object |
Maps file extensions to their corresponding MIME types to ensure correct content-type handling. Purpose: Helps the application interpret the uploaded file based on its extension and ensures it is processed correctly. Example Mapping: "mime-type-mapping": { |
vertigis.storage.<document-type>.expiration.enabled |
boolean |
Enables or disables expiration for a specific document type. true | false |
vertigis.storage.<document-type>.expiration.duration |
int |
Specifies the number of days after which a specific document type should expire. |
Document-type
Setting |
Description |
locator-result |
Final request artifact (ZIP-File). |
locator-work |
Temporary work documents (e.g. a PDF map of a specific branch). |
locator-documents |
Static document. |
locator-templates |
Template files for sending E-Mails and for creating dynamic accompanying document like a letter. |
Sample
{
"vertigis": {
"storage": {
"expiration": {
"schedule-cron": "0 0 6 * * ?"
},
"security": {
"file-upload": {
"max-file-name-length": 200,
"max-file-size": 1000000,
"allowed-file-extensions": ".pdf,.qute,.png,.csv",
"mime-type-mapping": {
".html": "text/html",
".pdf": "application/pdf",
".qute": "application/xslfo+xml",
".txt": "text/plain",
".pptx": "application/vnd.openxmlformats-officedocument.presentationml.presentation",
".docx": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
".xlsx": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
".csv": "text/csv",
".json": "application/json",
".xml": "application/xml",
".jpg": "image/jpeg",
".jpeg": "image/jpeg",
".png": "image/png",
".gif": "image/gif",
".svg": "image/svg+xml",
".webp": "image/webp",
".zip": "application/zip",
".rar": "application/vnd.rar",
".tar": "application/x-tar",
".gz": "application/gzip",
".7z": "application/x-7z-compressed"
}
}
},
"locator-result": {
"expiration": {
"duration": 3,
"enabled": true
}
}
}
}
}
