Configuring the JNDI LDAP connection pool

On this page

Still need help?

The Atlassian Community is here for you.

Ask the community

This page describes the site-wide settings for LDAP connection pooling in Confluence on a supported JDK.

View the current configuration

To view the JNDI LDAP connection pool:

  1. Go to Administration  > General Configuration.
  2. Select User Directories from the side menu.
  3. Under Additional Configuration & Troubleshooting, select the link to LDAP Connection Pool Configuration.

Configure the JNDI LDAP connection pool

Use system properties instead of configuring settings in the user interface

Because of a known bug, the 'JNDI LDAP Connection Pool Settings' form won't work. Any values you set using the form won't have any effect. We've provided instructions on this page to configure the connection pool using system properties instead.

To configure the JNDI connection pool:

  1. Go to <installation-directory>/bin , and edit the setenv.sh (Linux) or setenv.bat (Windows) file.
  2. Set the properties using the table below, for example:

    -Dcom.sun.jndi.ldap.connect.pool.initsize=2
    -Dcom.sun.jndi.ldap.connect.pool.prefsize=1
    -Dcom.sun.jndi.ldap.connect.pool.maxsize=20
  3. Restart your application server for the settings to take effect.

Pool properties

These connection pool settings are global (site-wide) and will be used to create a new connection pool for every configured LDAP directory server.

Learn more about configuring system properties

Connection Pool Setting

System property

Description

Default Value

Initial Pool Size

com.sun.jndi.ldap.
connection.pool.initsize

The number of LDAP connections created when initially connecting to the pool.

1

Preferred Pool Size

com.sun.jndi.ldap.
connect.pool.prefsize

The optimal pool size. LDAP will remove idle connections when the number of connections grows larger than this value. A value of 0 (zero) means that there is no preferred size, so the number of idle connections is unlimited.

0

Maximum Pool Size

com.sun.jndi.ldap.
connect.pool.maxsize

The maximum number of connections. When the number of connections reaches this value, LDAP will refuse further connections. As a result, requests made by an application to the LDAP server will be blocked. A value of 0 (zero) means that the number of connections is unlimited.

0

Pool Timeout

com.sun.jndi.ldap.
connect.pool.timeout

The length of time, in seconds, that a connection may remain idle before being removed from the pool. When the application is finished with a pooled connection, the connection is marked as idle, waiting to be reused. A value of 0 (zero) means that the idle time is unlimited, so connections will never be timed out.

300

Pool Protocol

com.sun.jndi.ldap.
connect.pool.protocol

Only these protocol types are allowed to connect to LDAP. If you want to allow multiple protocols, enter the values separated by a space. Valid values are:

  • plain
  • ssl

plain ssl
(Both plain and ssl)

Pool Authentication

com.sun.jndi.ldap.
connect.pool.authentication

Only these authentication types are allowed to connect to LDAP. If you want to allow multiple authentication types, enter the values separated by a space. See RFC 2829 for details of LDAP authentication methods. Valid values are:

  • none
  • simple
  • DIGEST-MD5

simple

Last modified on Jul 30, 2024

Was this helpful?

Yes
No
Provide feedback about this article
Powered by Confluence and Scroll Viewport.