LdapService
Name | LdapService |
Class Path |
|
Versions | 9 10 |
Overview
The LdapService
class integrates an LDAP listener with an authentication engine. It facilitates LDAP-based authentication workflows and lifecycle management.
Implemented Interfaces
EngineAware
TrustbuilderServiceLifecycle
Available Methods
Set Workflow
void setWorkflow(String workflow)
Defines the workflow for LDAP authentication.
Parameters:
workflow
(String
): The workflow name.
Set Engine
void setEngine(Engine engine)
Sets the authentication engine used by the LDAP listener.
Parameters:
engine
(Engine
): The authentication engine.
Start Service
void start()
Initializes and starts the LDAP listener.
Stop Service
void stop()
Stops and shuts down the LDAP listener.
Set LDAP Port
void setPort(int port)
Defines the port on which the LDAP listener runs.
Parameters:
port
(int
): The LDAP service port (default:389
).
Enable Debug Mode
void setDebug(boolean debug)
Enables or disables debug mode for the LDAP listener.
Parameters:
debug
(boolean
):true
to enable debugging,false
to disable.
Dependencies
LdapListener
: Handles LDAP authentication requests.Engine
: The core authentication engine.
Security Considerations
Ensure that the LDAP service runs on a secure port (
LDAPS
over636
is recommended).Only expose LDAP to trusted network segments.
Debugging should be disabled in production environments to prevent logging of sensitive information.
The LdapService
is responsible for managing an LDAP authentication listener and integrating it with an authentication engine.