Remove Direct Logger and Use Lombok @Slf4j

2026-07-15 02:54:06 +02:00 · 2024-12-17 10:26:18 +01:00
parent e273b9a3ad
commit af100d4190
53 changed files with 255 additions and 365 deletions
@@ -63,8 +63,6 @@ import org.bouncycastle.operator.InputDecryptorProvider;
 import org.bouncycastle.operator.OperatorCreationException;
 import org.bouncycastle.pkcs.PKCS8EncryptedPrivateKeyInfo;
 import org.bouncycastle.pkcs.PKCSException;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.core.io.ClassPathResource;
 import org.springframework.http.ResponseEntity;
@@ -78,17 +76,17 @@ import io.github.pixee.security.Filenames;
 import io.swagger.v3.oas.annotations.Operation;
 import io.swagger.v3.oas.annotations.tags.Tag;

+import lombok.extern.slf4j.Slf4j;
 import stirling.software.SPDF.model.api.security.SignPDFWithCertRequest;
 import stirling.software.SPDF.service.CustomPDDocumentFactory;
 import stirling.software.SPDF.utils.WebResponseUtils;

@RestController
@RequestMapping("/api/v1/security")
+@Slf4j
@Tag(name = "Security", description = "Security APIs")
 public class CertSignController {

-    private static final Logger logger = LoggerFactory.getLogger(CertSignController.class);
-
    static {
        Security.addProvider(new BouncyCastleProvider());
    }
@@ -108,7 +106,7 @@ public class CertSignController {
                logoFile = Files.createTempFile("signature", ".png").toFile();
                FileUtils.copyInputStreamToFile(is, logoFile);
            } catch (IOException e) {
-                logger.error("Failed to load image signature file");
+                log.error("Failed to load image signature file");
                throw e;
            }
        }
@@ -212,7 +210,9 @@ public class CertSignController {
    @Operation(
            summary = "Sign PDF with a Digital Certificate",
            description =
-                    "This endpoint accepts a PDF file, a digital certificate and related information to sign the PDF. It then returns the digitally signed PDF file. Input:PDF Output:PDF Type:SISO")
+                    "This endpoint accepts a PDF file, a digital certificate and related information to sign"
+                            + " the PDF. It then returns the digitally signed PDF file. Input:PDF Output:PDF"
+                            + " Type:SISO")
    public ResponseEntity<byte[]> signPDFWithCert(@ModelAttribute SignPDFWithCertRequest request)
            throws Exception {
        MultipartFile pdf = request.getFileInput();
@@ -308,7 +308,7 @@ public class CertSignController {
            }
            doc.saveIncremental(output);
        } catch (Exception e) {
-            logger.error("exception", e);
+            log.error("exception", e);
        }
    }

@@ -56,8 +56,6 @@ import org.apache.xmpbox.XMPMetadata;
 import org.apache.xmpbox.xml.DomXmpParser;
 import org.apache.xmpbox.xml.XmpParsingException;
 import org.apache.xmpbox.xml.XmpSerializer;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
 import org.springframework.http.MediaType;
 import org.springframework.http.ResponseEntity;
 import org.springframework.web.bind.annotation.ModelAttribute;
@@ -73,16 +71,16 @@ import com.fasterxml.jackson.databind.node.ObjectNode;
 import io.swagger.v3.oas.annotations.Operation;
 import io.swagger.v3.oas.annotations.tags.Tag;

+import lombok.extern.slf4j.Slf4j;
 import stirling.software.SPDF.model.api.PDFFile;
 import stirling.software.SPDF.utils.WebResponseUtils;

@RestController
@RequestMapping("/api/v1/security")
+@Slf4j
@Tag(name = "Security", description = "Security APIs")
 public class GetInfoOnPDF {

-    private static final Logger logger = LoggerFactory.getLogger(GetInfoOnPDF.class);
-
    static ObjectMapper objectMapper = new ObjectMapper();

    @PostMapping(consumes = "multipart/form-data", value = "/get-info-on-pdf")
@@ -224,7 +222,7 @@ public class GetInfoOnPDF {
                            javascriptArray.add(jsNode);
                        }
                    } catch (IOException e) {
-                        logger.error("exception", e);
+                        log.error("exception", e);
                    }
                }
            }
@@ -257,7 +255,7 @@ public class GetInfoOnPDF {
                }
            } catch (Exception e) {
                // TODO Auto-generated catch block
-                logger.error("exception", e);
+                log.error("exception", e);
            }

            boolean isPdfACompliant = checkForStandard(pdfBoxDoc, "PDF/A");
@@ -309,7 +307,7 @@ public class GetInfoOnPDF {
                    new XmpSerializer().serialize(xmpMeta, os, true);
                    xmpString = new String(os.toByteArray(), StandardCharsets.UTF_8);
                } catch (XmpParsingException | IOException e) {
-                    logger.error("exception", e);
+                    log.error("exception", e);
                }
            }

@@ -585,7 +583,7 @@ public class GetInfoOnPDF {
                    MediaType.APPLICATION_JSON);

        } catch (Exception e) {
-            logger.error("exception", e);
+            log.error("exception", e);
        }
        return null;
    }
@@ -701,7 +699,7 @@ public class GetInfoOnPDF {
                Exception
                        e) { // Catching general exception for brevity, ideally you'd catch specific
            // exceptions.
-            logger.error("exception", e);
+            log.error("exception", e);
        }

        return false;
@@ -5,8 +5,6 @@ import java.io.IOException;
 import org.apache.pdfbox.pdmodel.PDDocument;
 import org.apache.pdfbox.pdmodel.encryption.AccessPermission;
 import org.apache.pdfbox.pdmodel.encryption.StandardProtectionPolicy;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.http.ResponseEntity;
 import org.springframework.web.bind.annotation.ModelAttribute;
@@ -29,8 +27,6 @@ import stirling.software.SPDF.utils.WebResponseUtils;
@Tag(name = "Security", description = "Security APIs")
 public class PasswordController {

-    private static final Logger logger = LoggerFactory.getLogger(PasswordController.class);
-
    private final CustomPDDocumentFactory pdfDocumentFactory;

    @Autowired
@@ -39,7 +35,11 @@ public class PasswordController {
    }

    @PostMapping(consumes = "multipart/form-data", value = "/remove-password")
-    @Operation(summary = "Remove password from a PDF file", description = "This endpoint removes the password from a protected PDF file. Users need to provide the existing password. Input:PDF Output:PDF Type:SISO")
+    @Operation(
+            summary = "Remove password from a PDF file",
+            description =
+                    "This endpoint removes the password from a protected PDF file. Users need to provide the"
+                            + " existing password. Input:PDF Output:PDF Type:SISO")
    public ResponseEntity<byte[]> removePassword(@ModelAttribute PDFPasswordRequest request)
            throws IOException {
        MultipartFile fileInput = request.getFileInput();
@@ -49,12 +49,16 @@ public class PasswordController {
        return WebResponseUtils.pdfDocToWebResponse(
                document,
                Filenames.toSimpleFileName(fileInput.getOriginalFilename())
-                        .replaceFirst("[.][^.]+$", "")
+                                .replaceFirst("[.][^.]+$", "")
                        + "_password_removed.pdf");
    }

    @PostMapping(consumes = "multipart/form-data", value = "/add-password")
-    @Operation(summary = "Add password to a PDF file", description = "This endpoint adds password protection to a PDF file. Users can specify a set of permissions that should be applied to the file. Input:PDF Output:PDF")
+    @Operation(
+            summary = "Add password to a PDF file",
+            description =
+                    "This endpoint adds password protection to a PDF file. Users can specify a set of"
+                            + " permissions that should be applied to the file. Input:PDF Output:PDF")
    public ResponseEntity<byte[]> addPassword(@ModelAttribute AddPasswordRequest request)
            throws IOException {
        MultipartFile fileInput = request.getFileInput();
@@ -92,12 +96,12 @@ public class PasswordController {
            return WebResponseUtils.pdfDocToWebResponse(
                    document,
                    Filenames.toSimpleFileName(fileInput.getOriginalFilename())
-                            .replaceFirst("[.][^.]+$", "")
+                                    .replaceFirst("[.][^.]+$", "")
                            + "_permissions.pdf");
        return WebResponseUtils.pdfDocToWebResponse(
                document,
                Filenames.toSimpleFileName(fileInput.getOriginalFilename())
-                        .replaceFirst("[.][^.]+$", "")
+                                .replaceFirst("[.][^.]+$", "")
                        + "_passworded.pdf");
    }
 }
@@ -8,8 +8,6 @@ import java.util.List;
 import org.apache.pdfbox.pdmodel.PDDocument;
 import org.apache.pdfbox.pdmodel.PDPageContentStream;
 import org.apache.pdfbox.pdmodel.common.PDRectangle;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.http.ResponseEntity;
 import org.springframework.web.bind.annotation.ModelAttribute;
@@ -22,6 +20,7 @@ import io.github.pixee.security.Filenames;
 import io.swagger.v3.oas.annotations.Operation;
 import io.swagger.v3.oas.annotations.tags.Tag;

+import lombok.extern.slf4j.Slf4j;
 import stirling.software.SPDF.model.PDFText;
 import stirling.software.SPDF.model.api.security.RedactPdfRequest;
 import stirling.software.SPDF.pdf.TextFinder;
@@ -31,11 +30,10 @@ import stirling.software.SPDF.utils.WebResponseUtils;

@RestController
@RequestMapping("/api/v1/security")
+@Slf4j
@Tag(name = "Security", description = "Security APIs")
 public class RedactController {

-    private static final Logger logger = LoggerFactory.getLogger(RedactController.class);
-
    private final CustomPDDocumentFactory pdfDocumentFactory;

    @Autowired
@@ -47,7 +45,8 @@ public class RedactController {
    @Operation(
            summary = "Redacts listOfText in a PDF document",
            description =
-                    "This operation takes an input PDF file and redacts the provided listOfText. Input:PDF, Output:PDF, Type:SISO")
+                    "This operation takes an input PDF file and redacts the provided listOfText. Input:PDF,"
+                            + " Output:PDF, Type:SISO")
    public ResponseEntity<byte[]> redactPdf(@ModelAttribute RedactPdfRequest request)
            throws Exception {
        MultipartFile file = request.getFileInput();
@@ -68,7 +67,7 @@ public class RedactController {
            }
            redactColor = Color.decode(colorString);
        } catch (NumberFormatException e) {
-            logger.warn("Invalid color string provided. Using default color BLACK for redaction.");
+            log.warn("Invalid color string provided. Using default color BLACK for redaction.");
            redactColor = Color.BLACK;
        }

@@ -8,8 +8,6 @@ import org.apache.pdfbox.pdmodel.PDDocumentCatalog;
 import org.apache.pdfbox.pdmodel.interactive.form.PDAcroForm;
 import org.apache.pdfbox.pdmodel.interactive.form.PDField;
 import org.apache.pdfbox.pdmodel.interactive.form.PDSignatureField;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.http.ResponseEntity;
 import org.springframework.web.bind.annotation.ModelAttribute;
@@ -31,8 +29,6 @@ import stirling.software.SPDF.utils.WebResponseUtils;
@Tag(name = "Security", description = "Security APIs")
 public class RemoveCertSignController {

-    private static final Logger logger = LoggerFactory.getLogger(RemoveCertSignController.class);
-
    private final CustomPDDocumentFactory pdfDocumentFactory;

    @Autowired
@@ -44,7 +40,8 @@ public class RemoveCertSignController {
    @Operation(
            summary = "Remove digital signature from PDF",
            description =
-                    "This endpoint accepts a PDF file and returns the PDF file without the digital signature. Input: PDF, Output: PDF")
+                    "This endpoint accepts a PDF file and returns the PDF file without the digital signature."
+                            + " Input: PDF, Output: PDF")
    public ResponseEntity<byte[]> removeCertSignPDF(@ModelAttribute PDFFile request)
            throws Exception {
        MultipartFile pdf = request.getFileInput();