security-ldap-spring-boot-starter

Spring Boot Starter for security-ldap

简体中文 | English

Positioning · Capabilities · Dependency · Quick Start · Configuration · Versions · Build · License

---

Current Version：1.0.0-SNAPSHOT
JDK Baseline：17
Group ID：io.github.easy4j
Artifact ID：security-ldap-spring-boot-starter
License：Apache License 2.0

1. Positioning

security-ldap-spring-boot-starter is a Spring Boot starter that integrates security-ldap for applications using security-ldap. It provides auto-configuration, property binding, and ready-to-use beans so that applications can consume security-ldap capabilities with minimal setup.

Dimension	Description
Type	Spring Boot Starter
Consumers	Spring Boot applications using security-ldap
Core Capabilities	auto-configuration, property binding, ready-to-use beans for security-ldap
JDK	17
Coordinates	io.github.easy4j:security-ldap-spring-boot-starter:1.0.0-SNAPSHOT
Config Prefix	security.ldap

2. Core Capabilities

Capability	Status	Description
Auto-configuration	✅ Stable	Registers security-ldap beans automatically
Property Binding	✅ Stable	Binds security.ldap.* to SecurityLdapProperties
DirContextAuthenticationStrategy bean	✅ Stable	Auto-registered via SecurityLdapAutoConfiguration

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
DirContextAuthenticationStrategy	classpath + property	not created
AuthenticationSource	classpath + property	not created
BaseLdapPathContextSource	classpath + property	not created
LdapUserSearch	classpath + property	not created
UserDetailsService	classpath + property	not created
UserDetailsContextMapper	classpath + property	not created
GrantedAuthoritiesMapper	classpath + property	not created
AbstractLdapAuthenticator	classpath + property	not created
LdapAuthoritiesPopulator	classpath + property	not created
AbstractLdapAuthenticationProvider	classpath + property	not created
LdapAuthenticationSuccessHandler	classpath + property	not created
LdapAuthenticationFailureHandler	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>security-ldap-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

security.ldap:
  enabled: true

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 DirContextAuthenticationStrategy authenticationStrategy;

7. Configuration Reference

7.1 Config Prefix

security.ldap

7.2 Configuration Items

Property	Type	Default	Required	Description	Sensitive
security.ldap.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 security-ldap-spring-boot-starter -am test

10. Troubleshooting

Symptom	Diagnosis	Resolution
Bean not created	Check auto-configuration report	Verify security.ldap.enabled=true and classpath
ClassNotFoundException	Missing dependency	Add the required module
Version conflict	mvn dependency:tree	Use BOM for version alignment

11. Contribution

1. Fork the repository.
2. Create a feature branch.
3. Run mvn clean verify before submitting.
4. Submit a pull request.

12. License

This project is licensed under the Apache License, Version 2.0.

---

Back to top · Issues · Repository