Nuxeo digest linker
By nuxeo
This Nuxeo add-on is designed to verify the JSON structure of document create/update requests in Nuxeo, particularly focusing on the file:content block. It checks for the presence of a digest element, and if found, associates the corresponding existing binary from the default binary storage to the document.
nuxeo-digest-linker
Overview
Description:
This Nuxeo add-on is designed to establish links between existing binary files and Nuxeo documents through REST API calls.
Binary Storage:
The binaries are stored in a storage location identified by their MD5 hash.
Prerequisite:
Assuming that the binary files have already been uploaded to a cloud storage service, such as an S3 bucket, this add-on can assist in linking document metadata with the binary files using their MD5 digest.
Linking Procedure:
The link to the binary files can be incorporated within the JSON structure of the document during both document creation and update requests in Nuxeo.
Digest Submission:
The MD5 digest is to be submitted within the file:content block.
Security and permissions:
User must be admin to do the blob linking.
If you want to grant other users access to this feature you would need to overwrite BinaryManager
```xml
org.nuxeo.ecm.core.test.blobmanager nuxeo.digest.linker.TestBlobProvider
```
Java code
```java /******************************* * @return true of user is admin *******************************/ @Override public boolean hasCreateFromKeyPermission() { Principal principal = LoginComponent.getCurrentPrincipal(); if (null == principal) { log.debug("No principal found"); return false; }
String name = principal.getName();
Boolean isAdmin = Framework.getService(UserManager.class).getPrincipal(name).isAdministrator();
String digest = JSONDigestBlobDecoder.currentDigest();
boolean res=isAdmin;
//TODO: Optionally put some additional logic to validate digest/principal permissions for non-admin user
log.debug("For digest [{}] and principal [{}] (admin={}), returning=[{}]", digest, name, isAdmin,res);
return res;
}
```
Add-On Functionality:
The add-on checks for the presence of a digest element (see examples provided), and if it is found, it associates the corresponding existing binary file from the default binary storage with the document.
Installation
Download package from the marketplace for manual installation
or install directly from the marketplace
shell
bin/nuxeoctl mp-install nuxeo-digest-linker
Usage
- The JSON below illustrates a sample usage of the addon. This addon allows the utilization of the binary's digest within a blob schema.
json
{
"file:content": {
"name": "random_text_2.pdf",
"digest": "7081efb5c2db98769b4df99c66f0cd2f"
}
}
It functions correctly as long as a binary with the specified digest is present in the default binary storage. By default, the addon does not generate an error if the binary is missing, but in such cases, it cannot calculate the file's length or generate its thumbnail.
To use a different binary provider, include a
providerId
value in the structure below.
json
{
"file:content": {
"name": "random_text_2.pdf",
"digest": "7081efb5c2db98769b4df99c66f0cd2f",
"providerId": "default"
}
}
- If you want the system to throw an error when the digest refers to a non-existing blob,
add the parameter
"validate": "force"
.
json
{
"file:content": {
"name": "random_text_2.pdf",
"digest": "7081efb5c2db98769b4df99c66f0cd2f",
"validate": "force"
}
}
When the length attribute is provided and its value is not equal to -1, it will be utilized to specify the file size. This optimization significantly enhances performance.
json
{
"file:content": {
"name": "random_text_2.pdf",
"digest": "7081efb5c2db98769b4df99c66f0cd2f",
"length": "174315234"
}
}
Contributing
Hyland developers are encouraged to contribute to the development of this addon to enhance its functionality and performance.
License
LTS 2023 | LTS 2021 | LTS 2019 | LTS 2017 | |
---|---|---|---|---|
2024.2.2908 | ||||
2024.1.2601 | ||||
2023.11.2207 | ||||
2023.11.2204 | ||||
2023.0.0-11-2204 |
Deprecated | Target platforms Name | Target platforms Range | Target platforms Pattern | Updated | |
---|---|---|---|---|---|
2024.2.2908 | - | lts | [2021.0,) | - | Mar 1, 2024, 3:20:52 PM |
2024.1.2601 | - | lts | [2021.0,) | - | Jan 26, 2024, 5:51:44 PM |
2024.1.2601-SNAPSHOT | - | lts | [2021.0,) | - | Jan 26, 2024, 3:40:44 PM |
2023.11.2207 | - | lts | [2021.0,) | - | Jan 26, 2024, 3:38:55 PM |
2023.11.2204 | - | lts | [2021.0,) | - | Nov 22, 2023, 5:14:35 PM |
2023.0.0-11-2204 | - | lts | [2021.0,) | - | Nov 22, 2023, 5:05:20 PM |