From 4e901f7524b3789095cd02a76f7407a375836941 Mon Sep 17 00:00:00 2001 From: brios <127139797+balazs-szucs@users.noreply.github.com> Date: Sun, 9 Aug 2026 21:41:57 +0200 Subject: [PATCH] refactor(package): rename example classes and update package structure (#7400) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit # Description of Changes Refactors a small set of previously vendored/derived PDFBox "example" classes into Stirling’s own package namespaces. --- ## Checklist ### General - [X] I have read the [Contribution Guidelines](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/CONTRIBUTING.md) - [X] I have read the [Stirling-PDF Developer Guide](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/DeveloperGuide.md) (if applicable) - [ ] I have read the [How to add new languages to Stirling-PDF](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/devGuide/HowToAddNewLanguage.md) (if applicable) - [X] I have performed a self-review of my own code - [X] My changes generate no new warnings ### Documentation - [ ] I have updated relevant docs on [Stirling-PDF's doc repo](https://github.com/Stirling-Tools/Stirling-Tools.github.io/blob/main/docs/) (if functionality has heavily changed) - [ ] I have read the section [Add New Translation Tags](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/devGuide/HowToAddNewLanguage.md#add-new-translation-tags) (for new translation tags only) ### Translations (if applicable) - [ ] I ran [`scripts/counter_translation.py`](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/docs/counter_translation.md) ### UI Changes (if applicable) - [ ] Screenshots or videos demonstrating the UI changes are attached (e.g., as comments or direct attachments in the PR) ### Testing (if applicable) - [X] I have run `task check` to verify linters, typechecks, and tests pass - [X] I have tested my changes locally. Refer to the [Testing Guide](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/DeveloperGuide.md#7-testing) for more details. --- .gitleaksignore | 2 +- .../software/common/service/CustomPDFDocumentFactory.java | 2 +- .../software/common}/util/DeletingRandomAccessFile.java | 2 +- .../SPDF/controller/api/security/CertSignController.java | 2 +- .../software/SPDF/pdf}/signature/CMSProcessableInputStream.java | 2 +- .../software/SPDF/pdf}/signature/CreateSignatureBase.java | 2 +- .../software/SPDF/pdf}/signature/TSAClient.java | 2 +- .../software/SPDF/pdf}/signature/ValidationTimeStamp.java | 2 +- .../software/SPDF/utils}/ConnectedInputStream.java | 2 +- .../software/SPDF/pdf}/signature/TSAClientTest.java | 2 +- .../software/SPDF/pdf}/signature/ValidationTimeStampTest.java | 2 +- .../software/SPDF/utils}/ConnectedInputStreamTest.java | 2 +- 12 files changed, 12 insertions(+), 12 deletions(-) rename app/common/src/main/java/{org/apache/pdfbox/examples => stirling/software/common}/util/DeletingRandomAccessFile.java (96%) rename app/core/src/main/java/{org/apache/pdfbox/examples => stirling/software/SPDF/pdf}/signature/CMSProcessableInputStream.java (97%) rename app/core/src/main/java/{org/apache/pdfbox/examples => stirling/software/SPDF/pdf}/signature/CreateSignatureBase.java (99%) rename app/core/src/main/java/{org/apache/pdfbox/examples => stirling/software/SPDF/pdf}/signature/TSAClient.java (99%) rename app/core/src/main/java/{org/apache/pdfbox/examples => stirling/software/SPDF/pdf}/signature/ValidationTimeStamp.java (99%) rename app/core/src/main/java/{org/apache/pdfbox/examples/util => stirling/software/SPDF/utils}/ConnectedInputStream.java (98%) rename app/core/src/test/java/{org/apache/pdfbox/examples => stirling/software/SPDF/pdf}/signature/TSAClientTest.java (99%) rename app/core/src/test/java/{org/apache/pdfbox/examples => stirling/software/SPDF/pdf}/signature/ValidationTimeStampTest.java (96%) rename app/core/src/test/java/{org/apache/pdfbox/examples/util => stirling/software/SPDF/utils}/ConnectedInputStreamTest.java (98%) diff --git a/.gitleaksignore b/.gitleaksignore index 089de4fedb..12d98aebeb 100644 --- a/.gitleaksignore +++ b/.gitleaksignore @@ -22,7 +22,7 @@ frontend/editor/src/portal/components/docs/GettingStartedSection.tsx:generic-api # False positive: generic-api-key matches the Java type name "X509Certificate" # in a method signature (CreateSignatureBase.resolveSignatureAlgorithm) - not a secret. -app/core/src/main/java/org/apache/pdfbox/examples/signature/CreateSignatureBase.java:generic-api-key:224 +app/core/src/main/java/stirling/software/SPDF/pdf/signature/CreateSignatureBase.java:generic-api-key:224 # Supabase publishable key (public by design, RLS-protected) used as a CI fallback # default in the tauri-build workflow when the GitHub secret is unset - not a real secret. diff --git a/app/common/src/main/java/stirling/software/common/service/CustomPDFDocumentFactory.java b/app/common/src/main/java/stirling/software/common/service/CustomPDFDocumentFactory.java index 7cc01541e4..178052ebf6 100644 --- a/app/common/src/main/java/stirling/software/common/service/CustomPDFDocumentFactory.java +++ b/app/common/src/main/java/stirling/software/common/service/CustomPDFDocumentFactory.java @@ -17,7 +17,6 @@ import java.util.concurrent.Semaphore; import java.util.function.Consumer; import org.apache.pdfbox.Loader; -import org.apache.pdfbox.examples.util.DeletingRandomAccessFile; import org.apache.pdfbox.io.IOUtils; import org.apache.pdfbox.io.MemoryUsageSetting; import org.apache.pdfbox.io.RandomAccessReadBufferedFile; @@ -31,6 +30,7 @@ import org.springframework.web.multipart.MultipartFile; import lombok.extern.slf4j.Slf4j; import stirling.software.common.model.api.PDFFile; +import stirling.software.common.util.DeletingRandomAccessFile; import stirling.software.common.util.ExceptionUtils; import stirling.software.common.util.TempFileManager; diff --git a/app/common/src/main/java/org/apache/pdfbox/examples/util/DeletingRandomAccessFile.java b/app/common/src/main/java/stirling/software/common/util/DeletingRandomAccessFile.java similarity index 96% rename from app/common/src/main/java/org/apache/pdfbox/examples/util/DeletingRandomAccessFile.java rename to app/common/src/main/java/stirling/software/common/util/DeletingRandomAccessFile.java index 2c0341e19a..9df98bec9c 100644 --- a/app/common/src/main/java/org/apache/pdfbox/examples/util/DeletingRandomAccessFile.java +++ b/app/common/src/main/java/stirling/software/common/util/DeletingRandomAccessFile.java @@ -1,4 +1,4 @@ -package org.apache.pdfbox.examples.util; +package stirling.software.common.util; import java.io.File; import java.io.IOException; diff --git a/app/core/src/main/java/stirling/software/SPDF/controller/api/security/CertSignController.java b/app/core/src/main/java/stirling/software/SPDF/controller/api/security/CertSignController.java index ffadb8fe1a..c268f48d8c 100644 --- a/app/core/src/main/java/stirling/software/SPDF/controller/api/security/CertSignController.java +++ b/app/core/src/main/java/stirling/software/SPDF/controller/api/security/CertSignController.java @@ -13,7 +13,6 @@ import java.util.Calendar; import java.util.List; import org.apache.commons.io.FileUtils; -import org.apache.pdfbox.examples.signature.CreateSignatureBase; import org.apache.pdfbox.pdmodel.PDDocument; import org.apache.pdfbox.pdmodel.PDPage; import org.apache.pdfbox.pdmodel.PDPageContentStream; @@ -76,6 +75,7 @@ import lombok.extern.slf4j.Slf4j; import stirling.software.SPDF.config.swagger.StandardPdfResponse; import stirling.software.SPDF.model.api.security.SignPDFWithCertRequest; +import stirling.software.SPDF.pdf.signature.CreateSignatureBase; import stirling.software.SPDF.service.HardwareKeyStoreService; import stirling.software.common.annotations.AutoJobPostMapping; import stirling.software.common.enumeration.ResourceWeight; diff --git a/app/core/src/main/java/org/apache/pdfbox/examples/signature/CMSProcessableInputStream.java b/app/core/src/main/java/stirling/software/SPDF/pdf/signature/CMSProcessableInputStream.java similarity index 97% rename from app/core/src/main/java/org/apache/pdfbox/examples/signature/CMSProcessableInputStream.java rename to app/core/src/main/java/stirling/software/SPDF/pdf/signature/CMSProcessableInputStream.java index 48d1da9800..ead6a26305 100644 --- a/app/core/src/main/java/org/apache/pdfbox/examples/signature/CMSProcessableInputStream.java +++ b/app/core/src/main/java/stirling/software/SPDF/pdf/signature/CMSProcessableInputStream.java @@ -14,7 +14,7 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -package org.apache.pdfbox.examples.signature; +package stirling.software.SPDF.pdf.signature; import java.io.IOException; import java.io.InputStream; diff --git a/app/core/src/main/java/org/apache/pdfbox/examples/signature/CreateSignatureBase.java b/app/core/src/main/java/stirling/software/SPDF/pdf/signature/CreateSignatureBase.java similarity index 99% rename from app/core/src/main/java/org/apache/pdfbox/examples/signature/CreateSignatureBase.java rename to app/core/src/main/java/stirling/software/SPDF/pdf/signature/CreateSignatureBase.java index d6fd18f060..77145cb336 100644 --- a/app/core/src/main/java/org/apache/pdfbox/examples/signature/CreateSignatureBase.java +++ b/app/core/src/main/java/stirling/software/SPDF/pdf/signature/CreateSignatureBase.java @@ -14,7 +14,7 @@ * limitations under the License. */ -package org.apache.pdfbox.examples.signature; +package stirling.software.SPDF.pdf.signature; import java.io.IOException; import java.io.InputStream; diff --git a/app/core/src/main/java/org/apache/pdfbox/examples/signature/TSAClient.java b/app/core/src/main/java/stirling/software/SPDF/pdf/signature/TSAClient.java similarity index 99% rename from app/core/src/main/java/org/apache/pdfbox/examples/signature/TSAClient.java rename to app/core/src/main/java/stirling/software/SPDF/pdf/signature/TSAClient.java index 6f57e205a2..33530e4885 100644 --- a/app/core/src/main/java/org/apache/pdfbox/examples/signature/TSAClient.java +++ b/app/core/src/main/java/stirling/software/SPDF/pdf/signature/TSAClient.java @@ -14,7 +14,7 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -package org.apache.pdfbox.examples.signature; +package stirling.software.SPDF.pdf.signature; import java.io.IOException; import java.io.InputStream; diff --git a/app/core/src/main/java/org/apache/pdfbox/examples/signature/ValidationTimeStamp.java b/app/core/src/main/java/stirling/software/SPDF/pdf/signature/ValidationTimeStamp.java similarity index 99% rename from app/core/src/main/java/org/apache/pdfbox/examples/signature/ValidationTimeStamp.java rename to app/core/src/main/java/stirling/software/SPDF/pdf/signature/ValidationTimeStamp.java index d01666d769..405678181c 100644 --- a/app/core/src/main/java/org/apache/pdfbox/examples/signature/ValidationTimeStamp.java +++ b/app/core/src/main/java/stirling/software/SPDF/pdf/signature/ValidationTimeStamp.java @@ -15,7 +15,7 @@ * limitations under the License. */ -package org.apache.pdfbox.examples.signature; +package stirling.software.SPDF.pdf.signature; import java.io.ByteArrayInputStream; import java.io.IOException; diff --git a/app/core/src/main/java/org/apache/pdfbox/examples/util/ConnectedInputStream.java b/app/core/src/main/java/stirling/software/SPDF/utils/ConnectedInputStream.java similarity index 98% rename from app/core/src/main/java/org/apache/pdfbox/examples/util/ConnectedInputStream.java rename to app/core/src/main/java/stirling/software/SPDF/utils/ConnectedInputStream.java index 30434f7165..d8a824ec3b 100644 --- a/app/core/src/main/java/org/apache/pdfbox/examples/util/ConnectedInputStream.java +++ b/app/core/src/main/java/stirling/software/SPDF/utils/ConnectedInputStream.java @@ -14,7 +14,7 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -package org.apache.pdfbox.examples.util; +package stirling.software.SPDF.utils; import java.io.IOException; import java.io.InputStream; diff --git a/app/core/src/test/java/org/apache/pdfbox/examples/signature/TSAClientTest.java b/app/core/src/test/java/stirling/software/SPDF/pdf/signature/TSAClientTest.java similarity index 99% rename from app/core/src/test/java/org/apache/pdfbox/examples/signature/TSAClientTest.java rename to app/core/src/test/java/stirling/software/SPDF/pdf/signature/TSAClientTest.java index ebbbc518b7..582f2b332c 100644 --- a/app/core/src/test/java/org/apache/pdfbox/examples/signature/TSAClientTest.java +++ b/app/core/src/test/java/stirling/software/SPDF/pdf/signature/TSAClientTest.java @@ -1,4 +1,4 @@ -package org.apache.pdfbox.examples.signature; +package stirling.software.SPDF.pdf.signature; import static org.assertj.core.api.Assertions.assertThat; import static org.assertj.core.api.Assertions.assertThatThrownBy; diff --git a/app/core/src/test/java/org/apache/pdfbox/examples/signature/ValidationTimeStampTest.java b/app/core/src/test/java/stirling/software/SPDF/pdf/signature/ValidationTimeStampTest.java similarity index 96% rename from app/core/src/test/java/org/apache/pdfbox/examples/signature/ValidationTimeStampTest.java rename to app/core/src/test/java/stirling/software/SPDF/pdf/signature/ValidationTimeStampTest.java index fdb9eb41e4..3981f1ec9b 100644 --- a/app/core/src/test/java/org/apache/pdfbox/examples/signature/ValidationTimeStampTest.java +++ b/app/core/src/test/java/stirling/software/SPDF/pdf/signature/ValidationTimeStampTest.java @@ -1,4 +1,4 @@ -package org.apache.pdfbox.examples.signature; +package stirling.software.SPDF.pdf.signature; import static org.assertj.core.api.Assertions.assertThat; import static org.assertj.core.api.Assertions.assertThatThrownBy; diff --git a/app/core/src/test/java/org/apache/pdfbox/examples/util/ConnectedInputStreamTest.java b/app/core/src/test/java/stirling/software/SPDF/utils/ConnectedInputStreamTest.java similarity index 98% rename from app/core/src/test/java/org/apache/pdfbox/examples/util/ConnectedInputStreamTest.java rename to app/core/src/test/java/stirling/software/SPDF/utils/ConnectedInputStreamTest.java index 48d8b11a48..5f02dfb687 100644 --- a/app/core/src/test/java/org/apache/pdfbox/examples/util/ConnectedInputStreamTest.java +++ b/app/core/src/test/java/stirling/software/SPDF/utils/ConnectedInputStreamTest.java @@ -1,4 +1,4 @@ -package org.apache.pdfbox.examples.util; +package stirling.software.SPDF.utils; import static org.junit.jupiter.api.Assertions.*; import static org.mockito.Mockito.*;