Platform Explorer / Nuxeo Platform 2023.11

Operation PDF.EncryptReadOnly (PDF: Encrypt Read Only)

Description

Encrypts the PDF, returning a copy. User can read, print and copy but cannot modify. originalOwnerPwd is used if the PDF was originally encrypted. If ownerPwd is empty, use originalOwnerPwd to encrypt. If no keyLength is provided, use 128. If the operation is ran on Document(s), xpath lets you specificy where to get the blob from (default: file:content).
Operation id PDF.EncryptReadOnly
Category Conversion
Label PDF: Encrypt Read Only
Requires
Since

Parameters

Name Description Type Required Default value
keyLength string no 40, 128 
originalOwnerPwd string no  
ownerPwd string no  
userPwd string no  
xpath string no file:content 

Signature

Inputs bloblist, blob, document, documents
Outputs bloblist, blob, blob, bloblist

Implementation Information

Implementation Class Class: org.nuxeo.ecm.platform.pdf.operations.PDFEncryptReadOnlyOperation
Contributing Component org.nuxeo.ecm.platform.pdf.operations

JSON Definition

{
  "id" : "PDF.EncryptReadOnly",
  "label" : "PDF: Encrypt Read Only",
  "category" : "Conversion",
  "requires" : null,
  "description" : "Encrypts the PDF, returning a copy. User can read, print and copy but cannot modify. originalOwnerPwd is used if the PDF was originally encrypted. If ownerPwd is empty, use originalOwnerPwd to encrypt. If no keyLength is provided, use 128. If the operation is ran on Document(s), xpath lets you specificy where to get the blob from (default: file:content).",
  "url" : "PDF.EncryptReadOnly",
  "signature" : [ "bloblist", "bloblist", "blob", "blob", "document", "blob", "documents", "bloblist" ],
  "params" : [ {
    "name" : "keyLength",
    "description" : null,
    "type" : "string",
    "required" : false,
    "widget" : "Option",
    "order" : 0,
    "values" : [ "40", "128" ]
  }, {
    "name" : "originalOwnerPwd",
    "description" : null,
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "ownerPwd",
    "description" : null,
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "userPwd",
    "description" : null,
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "xpath",
    "description" : null,
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ "file:content" ]
  } ]
}