LdapConfig.java
// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements. See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership. The ASF licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License. You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the License for the
// specific language governing permissions and limitations
// under the License.
package org.apache.doris.common;
/**
* LDAP configuration
*/
public class LdapConfig extends ConfigBase {
/**
* Flag to enable LDAP authentication.
*/
@Deprecated
@ConfigBase.ConfField
public static boolean ldap_authentication_enabled = false;
/**
* LDAP server ip.
*/
@ConfigBase.ConfField
public static String ldap_host = "";
/**
* LDAP server port.
*/
@ConfigBase.ConfField
public static int ldap_port = 389;
/**
* Search base for users.
* LDAP is a tree structure, and this specifies the base of the subtree in which the search is to be constrained.
*/
@ConfigBase.ConfField
public static String ldap_user_basedn = "";
/**
* The DN to bind as connection, this value will be used to lookup information about other users.
*/
@ConfigBase.ConfField
public static String ldap_admin_name = "";
/**
* User lookup filter, the placeholder {login} will be replaced by the user supplied login.
*/
@ConfigBase.ConfField
public static String ldap_user_filter = "(&(uid={login}))";
/**
* Search base for groups.
*/
@ConfigBase.ConfField
public static String ldap_group_basedn = "";
/**
* Group lookup filter, the placeholder {login} will be replaced by the user supplied login.
*/
@ConfigBase.ConfField
public static String ldap_group_filter = "";
/**
* The user LDAP information cache time.
* After timeout, the user information will be retrieved from the LDAP service again.
*/
@ConfigBase.ConfField(mutable = true)
public static long ldap_user_cache_timeout_s = 5 * 60;
/**
* System LDAP information cache time.
* After timeout, clear all user information in the cache.
*/
@ConfigBase.ConfField(mutable = true)
public static long ldap_cache_timeout_day = 30;
/**
* LDAP read timeout in milliseconds.
* Controls the maximum time to wait for an LDAP response after a request is sent.
* Uses JNDI property "com.sun.jndi.ldap.read.timeout".
* Set to 0 for no timeout (not recommended). Default 5000ms.
*/
@ConfigBase.ConfField
public static int ldap_read_timeout_ms = 5000;
/**
* LDAP connect timeout in milliseconds.
* Controls the maximum time to wait for establishing a TCP connection to the LDAP server.
* Uses JNDI property "com.sun.jndi.ldap.connect.timeout".
* Set to 0 for no timeout (not recommended). Default 5000ms.
*/
@ConfigBase.ConfField
public static int ldap_connect_timeout_ms = 5000;
/**
* Whether to use connection pooling for LDAP search operations.
* When true (default), uses Spring PoolingContextSource with ldap_pool_* settings.
* When false, each LDAP search creates a fresh connection, avoiding dead connection
* detection cost (testOnBorrow can burn read_timeout discovering stale connections
* killed by firewalls/NAT idle timeout). Recommended to set false if experiencing
* intermittent ~5s LDAP search latency spikes.
*/
@ConfigBase.ConfField
public static boolean ldap_search_use_pool = true;
/**
* LDAP pool configuration (only effective when ldap_search_use_pool = true):
* https://docs.spring.io/spring-ldap/docs/2.3.3.RELEASE/reference/#pool-configuration
*/
/**
* The maximum number of active connections of each type (read-only or read-write) that can be allocated
* from this pool at the same time. You can use a non-positive number for no limit.
*/
@ConfigBase.ConfField
public static int ldap_pool_max_active = 8;
/**
* The overall maximum number of active connections (for all types) that can be allocated from this pool
* at the same time. You can use a non-positive number for no limit.
*/
@ConfigBase.ConfField
public static int ldap_pool_max_total = -1;
/**
* The maximum number of active connections of each type (read-only or read-write) that can remain idle
* in the pool without extra connections being released. You can use a non-positive number for no limit.
*/
@ConfigBase.ConfField
public static int ldap_pool_max_idle = 8;
/**
* The minimum number of active connections of each type (read-only or read-write) that can remain idle
* in the pool without extra connections being created. You can use zero (the default) to create none.
*/
@ConfigBase.ConfField
public static int ldap_pool_min_idle = 0;
/**
* The maximum number of milliseconds that the pool waits (when no connections are available) for a connection
* to be returned before throwing an exception. You can use a non-positive number to wait indefinitely.
*/
@ConfigBase.ConfField
public static int ldap_pool_max_wait = -1;
/**
* Specifies the behavior when the pool is exhausted.
*
* The '0' option throws NoSuchElementException when the pool is exhausted.
*
* The '1' option waits until a new object is available. If max-wait is positive and no new object is available
* after the max-wait time expires, NoSuchElementException is thrown.
*
* The '2' option creates and returns a new object (essentially making max-active meaningless).
*/
@ConfigBase.ConfField
public static byte ldap_pool_when_exhausted = 1;
/**
* Whether objects are validated before being borrowed from the pool. If the object fails to validate,
* it is dropped from the pool, and an attempt to borrow another is made.
*/
@ConfigBase.ConfField
public static boolean ldap_pool_test_on_borrow = true;
/**
* Whether objects are validated before being returned to the pool.
*/
@ConfigBase.ConfField
public static boolean ldap_pool_test_on_return = true;
/**
* Whether objects are validated by the idle object evictor (if any). If an object fails to validate,
* it is dropped from the pool.
*/
@ConfigBase.ConfField
public static boolean ldap_pool_test_while_idle = true;
/**
* Flag to enable usage of LDAPS.
*/
@ConfigBase.ConfField
public static boolean ldap_use_ssl = false;
/**
* The method constructs the correct URL connection string for the specified host and port depending on
* the value of the {@code ldap_use_ssl} property.
* If {@code ldap_use_ssl} is true, LDAPS is used as the protocol.
* If {@code ldap_use_ssl} is false or not specified, LDAP is used as the protocol.
* @param hostPortInAccessibleFormat the host and port in accessible format (for example, "host:port")
* @return the LDAP or LDAPS connection URL string
*/
public static String getConnectionURL(String hostPortInAccessibleFormat) {
return ((LdapConfig.ldap_use_ssl ? "ldaps" : "ldap") + "://" + hostPortInAccessibleFormat);
}
}