Current Version:1.0.0-SNAPSHOT
JDK Baseline:17
Group ID:io.github.easy4j
Artifact ID:icepdf-spring-boot-starter
License:Apache License 2.0
1. Positioning
icepdf-spring-boot-starter is a Spring Boot starter that integrates icepdf for applications using icepdf. It provides auto-configuration, property binding, and ready-to-use beans so that applications can consume icepdf capabilities with minimal setup.
| Dimension |
Description |
| Type |
Spring Boot Starter |
| Consumers |
Spring Boot applications using icepdf |
| Core Capabilities |
auto-configuration, property binding, ready-to-use beans for icepdf |
| JDK |
17 |
| Coordinates |
io.github.easy4j:icepdf-spring-boot-starter:1.0.0-SNAPSHOT |
| Config Prefix |
icepdf |
2. Core Capabilities
| Capability |
Status |
Description |
| Auto-configuration |
✅ Stable |
Registers icepdf beans automatically |
| Property Binding |
✅ Stable |
Binds icepdf.* to Properties |
| Ready-to-use beans |
✅ Stable |
Auto-registered via auto-configuration |
3. Requirements and Compatibility
| Dependency |
Minimum |
Evidence |
| JDK |
17 |
pom.xml |
| Spring Boot |
2.3.0.RELEASE |
pom.xml parent |
| Maven |
3.6+ |
Maven Enforcer |
4. Auto-configuration
The starter auto-configures the following beans:
| Bean |
Condition |
Missing Behavior |
Object |
classpath + property |
not created |
Auto-configuration registration:
META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports (Spring Boot 2.7+ / 3.x / 4.x)
META-INF/spring.factories (Spring Boot 2.x legacy)
5. Dependency
<dependency>
<groupId>io.github.easy4j</groupId>
<artifactId>icepdf-spring-boot-starter</artifactId>
<version>1.0.0-SNAPSHOT</version>
</dependency>
No additional easy4j component dependencies.
6. Quick Start
6.1 Add dependency
Add the dependency above to your pom.xml.
6.2 Configure
6.3 Use the bean
@SpringBootApplication
public class Application {
public static void main(String[] args) {
SpringApplication.run(Application.class, args);
}
}
Then inject the auto-configured bean in your code:
@Autowired
private Object bean;
7. Configuration Reference
7.1 Config Prefix
icepdf
7.2 Configuration Items
| Property |
Type |
Default |
Required |
Description |
Sensitive |
icepdf.enabled |
boolean |
true |
No |
Enable the starter |
No |
8. Version Lines and Compatibility
| Branch |
JDK |
Spring Boot |
Component Version |
Status |
2.3.x / 2.7.x |
8+ |
2.3.x / 2.7.x |
1.0.x |
Maintenance |
3.0.x ~ 3.5.x |
17 |
3.x |
2.0.x |
Maintenance |
4.0.x / 4.1.x |
17+ |
4.x |
3.0.x |
Active |
9. Build and Test
mvn clean verify
mvn -pl icepdf-spring-boot-starter -am test
10. Troubleshooting
| Symptom |
Diagnosis |
Resolution |
| Bean not created |
Check auto-configuration report |
Verify icepdf.enabled=true and classpath |
ClassNotFoundException |
Missing dependency |
Add the required module |
| Version conflict |
mvn dependency:tree |
Use BOM for version alignment |
11. Contribution
- Fork the repository.
- Create a feature branch.
- Run
mvn clean verify before submitting.
- Submit a pull request.
12. License
This project is licensed under the Apache License, Version 2.0.