Spring LDAP

https://docs.spring.io/spring-ldap/reference/3.3
Admin
Spring LDAP makes it easier to build Spring-based applications that use the Lightweight Directory...
Tokens:314,005
Snippets:3,272
Trust Score:10
Update:1 month ago
Show doc for...
Tokens:
Raw
### Attribute Syntax to Java Class Mapping Example

Source: https://docs.spring.io/spring-ldap/reference/3.3/api/java/org/springframework/ldap/odm/tools/SchemaToJava.html

This example shows the format for a configuration file that maps LDAP attribute syntaxes to Java classes. Syntaxes not listed will default to String or byte[].

```properties
# List of attribute syntax to java class mappings

# Syntax                                           Java class
# ------                                           ----------

1.3.6.1.4.1.1466.115.121.1.50, java.lang.Integer
1.3.6.1.4.1.1466.115.121.1.40, some.other.Class

```

--------------------------------

### startEmbeddedServer

Source: https://docs.spring.io/spring-ldap/reference/3.3/api/java/org/springframework/ldap/test/LdapTestUtils.html

Starts an embedded Apache Directory Server.

```APIDOC
## startEmbeddedServer

### Description
Starts an embedded Apache Directory Server.

### Method
static void

### Parameters
#### Path Parameters
- **port** (int) - Required - The port to start the server on.
- **defaultPartitionSuffix** (String) - Required - The default partition suffix.
- **defaultPartitionName** (String) - Required - The default partition name.
```

--------------------------------

### PresentFilter Example

Source: https://docs.spring.io/spring-ldap/reference/3.3/api/java/org/springframework/ldap/filter/PresentFilter.html

Example of how to create and encode a PresentFilter.

```APIDOC
```java
PresentFilter filter = new PresentFilter("foo");
System.out.println(filter.encode());
```

This will result in the LDAP filter string: `(foo=*)
```

--------------------------------

### EmbeddedLdapServer Start

Source: https://docs.spring.io/spring-ldap/reference/3.3/api/java/org/springframework/ldap/test/unboundid/EmbeddedLdapServer.html

Starts the embedded LDAP server. This method should be called after the server has been configured.

```APIDOC
## start

### Description
Starts the embedded LDAP server.

### Method
`public void start()`
```

--------------------------------

### getContextSource()

Source: https://docs.spring.io/spring-ldap/reference/3.3/api/java/index-all.html

Get the ContextSource.

```APIDOC
## getContextSource()

### Description
Retrieves the ContextSource. This method is available in LdapTemplate and various pooling and transaction management classes.

### Method
N/A (Method Signature)

### Endpoint
N/A

### Response
* Description not provided in source.
```

--------------------------------

### getContextFactory()

Source: https://docs.spring.io/spring-ldap/reference/3.3/api/java/index-all.html

Get the context factory.

```APIDOC
## getContextFactory()

### Description
Retrieves the context factory used by the AbstractContextSource.

### Method
N/A (Method Signature)

### Endpoint
N/A

### Response
* Description not provided in source.
```

--------------------------------

### getContextFactory

Source: https://docs.spring.io/spring-ldap/reference/3.3/api/java/org/springframework/ldap/core/support/AbstractContextSource.html

Get the context factory.

```APIDOC
## getContextFactory

### Description
Get the context factory.

### Method
public Class<?> getContextFactory()

### Response
#### Success Response
- **Class<?>** - the context factory.
```

--------------------------------

### SimpleCharStream.getBeginLine()

Source: https://docs.spring.io/spring-ldap/reference/3.3/api/java/index-all.html

Get token beginning line number.

```APIDOC
## getBeginLine()

### Description
Get token beginning line number.

### Method
N/A (Method signature)

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A
```

--------------------------------

### setupEnvironment Method

Source: https://docs.spring.io/spring-ldap/reference/3.3/api/java/org/springframework/ldap/core/support/DigestMd5DirContextAuthenticationStrategy.html

Prepares the environment for creating a DirContext instance for DIGEST-MD5 authentication.

```APIDOC
## setupEnvironment(Hashtable<String,Object> env, String userDn, String password)

### Description
This method is responsible for preparing the environment to be used when creating the `DirContext` instance. The base environment (including URL, `ContextFactory` etc. will already be set, and this method is called just before the actual Context is to be created.

Specified by:
`setupEnvironment` in interface `DirContextAuthenticationStrategy`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Method
`public void setupEnvironment(Hashtable<String,Object> env, String userDn, String password)`

### Parameters
* **env** (Hashtable<String,Object>) - The `Hashtable` to be sent to the `DirContext` instance on initialization. Pre-configured with the basic settings; the implementation of this method is responsible for manipulating the environment as appropriate for the particular authentication mechanism.
* **userDn** (String) - The user DN to authenticate, as received from the `AuthenticationSource` of the `ContextSource`.
* **password** (String) - The password to authenticate with, as received from the `AuthenticationSource` of the `ContextSource`.
```

--------------------------------

### NotPresentFilter Example Usage

Source: https://docs.spring.io/spring-ldap/reference/3.3/api/java/org/springframework/ldap/filter/NotPresentFilter.html

Example of how to create and encode a NotPresentFilter.

```APIDOC
```java
NotPresentFilter filter = new NotPresentFilter("foo");
System.out.println(filter.encode());
```

This would result in:

```
(!(foo=*))
```
```

--------------------------------

### setupEnvironment

Source: https://docs.spring.io/spring-ldap/reference/3.3/api/java/org/springframework/ldap/core/support/AbstractTlsDirContextAuthenticationStrategy.html

This method is responsible for preparing the environment to be used when creating the `DirContext` instance. The base environment (including URL, `ContextFactory` etc.) will already be set, and this method is called just before the actual Context is to be created.

```APIDOC
## setupEnvironment

### Description
This method is responsible for preparing the environment to be used when creating the `DirContext` instance. The base environment (including URL, `ContextFactory` etc.) will already be set, and this method is called just before the actual Context is to be created.

Specified by:
    `setupEnvironment` in interface `DirContextAuthenticationStrategy` 

### Method
public final void setupEnvironment(Hashtable<String,Object> env, String userDn, String password)

### Parameters
#### Path Parameters
- **env** (Hashtable<String,Object>) - The `Hashtable` to be sent to the `DirContext` instance on initialization. Pre-configured with the basic settings; the implementation of this method is responsible for manipulating the environment as appropriate for the particular authentication mechanism.
- **userDn** (String) - the user DN to authenticate, as received from the `AuthenticationSource` of the `ContextSource`.
- **password** (String) - the password to authenticate with, as received from the `AuthenticationSource` of the `ContextSource`.

```

--------------------------------

### cleanAndSetup

Source: https://docs.spring.io/spring-ldap/reference/3.3/api/java/org/springframework/ldap/test/unboundid/LdapTestUtils.html

Performs a clean setup of the LDAP directory by clearing specified sub-contexts and then loading an LDIF file. This is a convenient method for preparing the directory state before tests.

```APIDOC
## cleanAndSetup

### Description
Cleans and sets up the LDAP directory.

### Method
`static void`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
* `contextSource` (ContextSource) - The ContextSource to use.
* `rootNode` (Name) - The root node to clean and set up.
* `ldifFile` (org.springframework.core.io.Resource) - The LDIF file to load.

### Throws
* `NamingException`
* `IOException`
```

--------------------------------

### Starting Filter Condition

Source: https://docs.spring.io/spring-ldap/reference/3.3/api/java/org/springframework/ldap/query/LdapQueryBuilder.html

Initiates the specification of filter conditions for the LDAP query. This method is used to start building the 'where' clause of the query.

```java
ConditionCriteria criteria = query().where("objectclass");
```

--------------------------------

### cleanAndSetup

Source: https://docs.spring.io/spring-ldap/reference/3.3/api/java/org/springframework/ldap/test/LdapTestUtils.html

Cleans and sets up the LDAP server.

```APIDOC
## cleanAndSetup

### Description
Cleans and sets up the LDAP server.

### Method Signature
`public static void cleanAndSetup(ContextSource contextSource, Name rootNode, org.springframework.core.io.Resource ldifFile) throws NamingException, IOException`

### Parameters
* **contextSource** (ContextSource) - the ContextSource to use for getting a DirContext.
* **rootNode** (Name) - the distinguished name of the root node.
* **ldifFile** (org.springframework.core.io.Resource) - a Resource representing a valid LDIF file.

### Throws
* `NamingException`
* `IOException`
```

--------------------------------

### getContextSource

Source: https://docs.spring.io/spring-ldap/reference/3.3/api/java/org/springframework/ldap/core/LdapTemplate.html

Get the ContextSource.

```APIDOC
## getContextSource

### Description
Get the ContextSource.

### Method
Not specified (likely a getter).

### Endpoint
Not specified.

### Parameters
None.

### Response
#### Success Response
- **ContextSource** - Description not specified.
```

--------------------------------

### cleanAndSetup

Source: https://docs.spring.io/spring-ldap/reference/3.3/api/java/org/springframework/ldap/test/LdapTestUtils.html

Cleans up the existing LDAP context and sets it up with the provided LDIF file.

```APIDOC
## cleanAndSetup

### Description
Cleans up the existing LDAP context and sets it up with the provided LDIF file.

### Method
static void

### Parameters
#### Path Parameters
- **contextSource** (ContextSource) - Required - The ContextSource to use.
- **rootNode** (Name) - Required - The root distinguished name for the LDAP tree.
- **ldifFile** (org.springframework.core.io.Resource) - Required - The LDIF file to load.
```

--------------------------------

### doCreateInstance Method

Source: https://docs.spring.io/spring-ldap/reference/3.3/api/java/org/springframework/ldap/test/ContextSourceEc2InstanceLaunchingFactoryBean.html

Implement to create the actual target object using the provided DNS name.

```APIDOC
## doCreateInstance(String dnsName)

### Description
Implementations of this method are responsible for creating the actual target object. This method is called by the superclass `AbstractEc2InstanceLaunchingFactoryBean`.

### Method
`protected final Object doCreateInstance(String dnsName) throws Exception`

### Parameters
#### Path Parameters
- **dnsName** (String) - The IP address or DNS name of the launched EC2 image.

### Returns
The object to be returned by this FactoryBean.

### Throws
- `Exception` - If an error occurs during initialization.
```

--------------------------------

### startEmbeddedServer

Source: https://docs.spring.io/spring-ldap/reference/3.3/api/java/org/springframework/ldap/test/LdapTestUtils.html

Starts an embedded Apache Directory Server. Only one embedded server will be permitted in the same JVM.

```APIDOC
## startEmbeddedServer

### Description
Starts an embedded Apache Directory Server. Only one embedded server will be permitted in the same JVM.

### Method Signature
`public static void startEmbeddedServer(int port, String defaultPartitionSuffix, String defaultPartitionName) throws IllegalStateException`

### Parameters
* **port** (int) - the port on which the server will be listening.
* **defaultPartitionSuffix** (String) - The default base suffix that will be used for the LDAP server.
* **defaultPartitionName** (String) - The name to use in the directory server configuration for the default base suffix.

### Throws
* `IllegalStateException` - if an embedded server is already started.

### Since
1.3.2
```

--------------------------------

### getDelegateLdapContext()

Source: https://docs.spring.io/spring-ldap/reference/3.3/api/java/index-all.html

Get the delegate LdapContext.

```APIDOC
## getDelegateLdapContext()

### Description
Retrieves the delegate LdapContext. This method is part of the delegation pattern for LdapContext objects, typically seen in pooling scenarios.

### Method
N/A (Method Signature)

### Endpoint
N/A

### Response
* Description not provided in source.
```

--------------------------------

### AbstractEc2InstanceLaunchingFactoryBean Methods

Source: https://docs.spring.io/spring-ldap/reference/3.3/api/java/index-all.html

Methods for configuring an AbstractEc2InstanceLaunchingFactoryBean, specifically for setting AWS credentials.

```APIDOC
## AbstractEc2InstanceLaunchingFactoryBean Methods

### Description
Methods for configuring an AbstractEc2InstanceLaunchingFactoryBean, specifically for setting AWS credentials.

### Methods
- `setAwsKey(String)`: Set the AWS key.
- `setAwsSecretKey(String)`: Set the AWS secret key.
```

--------------------------------

### getDelegateDirContext()

Source: https://docs.spring.io/spring-ldap/reference/3.3/api/java/index-all.html

Get the delegate DirContext.

```APIDOC
## getDelegateDirContext()

### Description
Retrieves the delegate DirContext. This method is used in classes that delegate DirContext operations, commonly found in pooling implementations.

### Method
N/A (Method Signature)

### Endpoint
N/A

### Response
* Description not provided in source.
```

--------------------------------

### LdapClient.authenticate

Source: https://docs.spring.io/spring-ldap/reference/3.3/api/java/org/springframework/ldap/core/LdapClient.html

Starts building an authentication request. Returns a specification for authentication parameters.

```APIDOC
## authenticate()

### Description
Start building an authentication request.

### Method
`LdapClient.AuthenticateSpec`

### Response
- **AuthenticateSpec** - A spec for specifying the authentication parameters.
```

--------------------------------

### getDelegateContext()

Source: https://docs.spring.io/spring-ldap/reference/3.3/api/java/index-all.html

Get the delegate context.

```APIDOC
## getDelegateContext()

### Description
Retrieves the delegate context. This method is found in classes that implement delegation patterns for contexts, often related to pooling.

### Method
N/A (Method Signature)

### Endpoint
N/A

### Response
* Description not provided in source.
```

--------------------------------

### startApacheDirectoryServer (Deprecated)

Source: https://docs.spring.io/spring-ldap/reference/3.3/api/java/org/springframework/ldap/test/LdapTestUtils.html

Deprecated. Use `startEmbeddedServer(int, String, String)` instead. Starts an embedded Apache Directory Server.

```APIDOC
## startApacheDirectoryServer (Deprecated)

### Description
Deprecated. Use `startEmbeddedServer(int, String, String)` instead. Starts an embedded Apache Directory Server.

### Method
static DirContext

### Parameters
#### Path Parameters
- **port** (int) - Required - The port to start the server on.
- **defaultPartitionSuffix** (String) - Required - The default partition suffix.
- **defaultPartitionName** (String) - Required - The default partition name.
- **principal** (String) - Required - The principal to use for authentication.
- **credentials** (String) - Required - The credentials for authentication.
- **extraSchemas** (Set) - Optional - A set of extra schemas to load.
```

--------------------------------

### startApacheDirectoryServer (Deprecated, no schema)

Source: https://docs.spring.io/spring-ldap/reference/3.3/api/java/org/springframework/ldap/test/LdapTestUtils.html

Starts an in-process Apache Directory Server. This method is deprecated and users should use `startEmbeddedServer` instead.

```APIDOC
## startApacheDirectoryServer

### Description
Starts an in-process Apache Directory Server. This method is deprecated and users should use `startEmbeddedServer` instead.

### Method Signature
`public static DirContext startApacheDirectoryServer(int port, String defaultPartitionSuffix, String defaultPartitionName, String principal, String credentials) throws NamingException`

### Throws
* `NamingException`
```

--------------------------------

### VirtualListViewResultsCookie.getContentCount()

Source: https://docs.spring.io/spring-ldap/reference/3.3/api/java/index-all.html

Gets the content count.

```APIDOC
## getContentCount()

### Description
Gets the content count.

### Method
N/A (Method signature)

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A
```

--------------------------------

### startApacheDirectoryServer (Deprecated)

Source: https://docs.spring.io/spring-ldap/reference/3.3/api/java/org/springframework/ldap/test/LdapTestUtils.html

Starts an in-process Apache Directory Server. This method is deprecated and users should use `startEmbeddedServer` instead.

```APIDOC
## startApacheDirectoryServer

### Description
Starts an in-process Apache Directory Server. This method is deprecated and users should use `startEmbeddedServer` instead.

### Method Signature
`public static DirContext startApacheDirectoryServer(int port, String defaultPartitionSuffix, String defaultPartitionName, String principal, String credentials, Set extraSchemas) throws NamingException`

### Parameters
* **port** (int) - the port on which the server will be listening.
* **defaultPartitionSuffix** (String) - The default base suffix that will be used for the LDAP server.
* **defaultPartitionName** (String) - The name to use in the directory server configuration for the default base suffix.
* **principal** (String) - The principal to use when starting the directory server.
* **credentials** (String) - The credentials to use when starting the directory server.
* **extraSchemas** (Set) - Set of extra schemas to add to the bootstrap schemas of ApacheDS. May be `null`.

### Returns
An unusable DirContext instance.

### Throws
* `NamingException` - If anything goes wrong when starting the server.
```

--------------------------------

### LikeFilter Output Example

Source: https://docs.spring.io/spring-ldap/reference/3.3/api/java/org/springframework/ldap/filter/LikeFilter.html

Demonstrates the LDAP filter string generated by a LikeFilter instance configured for a wildcard search.

```text
(cn=foo*)
```

--------------------------------

### getTarget

Source: https://docs.spring.io/spring-ldap/reference/3.3/api/java/org/springframework/ldap/transaction/compensating/manager/TransactionAwareContextSourceProxy.html

Get the target ContextSource.

```APIDOC
## getTarget()

### Description
Get the target ContextSource.

### Method
public ContextSource getTarget()

### Parameters
None

### Response
#### Success Response (200)
* **ContextSource** - the target ContextSource.
```

--------------------------------

### ContextSourceEc2InstanceLaunchingFactoryBean Constructor

Source: https://docs.spring.io/spring-ldap/reference/3.3/api/java/org/springframework/ldap/test/ContextSourceEc2InstanceLaunchingFactoryBean.html

Initializes a new instance of the ContextSourceEc2InstanceLaunchingFactoryBean class.

```APIDOC
## ContextSourceEc2InstanceLaunchingFactoryBean()

### Description
Initializes a new instance of the ContextSourceEc2InstanceLaunchingFactoryBean class.

### Constructor
`ContextSourceEc2InstanceLaunchingFactoryBean()`
```

--------------------------------

### getObjectDirectoryMapper

Source: https://docs.spring.io/spring-ldap/reference/3.3/api/java/org/springframework/ldap/core/LdapTemplate.html

Get the configured ObjectDirectoryMapper.

```APIDOC
## getObjectDirectoryMapper

### Description
Get the configured ObjectDirectoryMapper.

### Method
Not specified (likely a getter).

### Endpoint
Not specified.

### Parameters
None.

### Response
#### Success Response
- **ObjectDirectoryMapper** - Description not specified.
```

--------------------------------

### doBegin Method

Source: https://docs.spring.io/spring-ldap/reference/3.3/api/java/org/springframework/transaction/compensating/support/AbstractCompensatingTransactionManagerDelegate.html

Begins a new transaction.

```APIDOC
## doBegin

### Description
Begins a new transaction.

### Signature
`public void doBegin(Object transaction, org.springframework.transaction.TransactionDefinition definition) throws org.springframework.transaction.TransactionException`

### Parameters
#### Path Parameters
- **transaction** (Object) - Required - The transaction object.
- **definition** (org.springframework.transaction.TransactionDefinition) - Required - The transaction definition.

### Throws
- `org.springframework.transaction.TransactionException`
```

--------------------------------

### getValue()

Source: https://docs.spring.io/spring-ldap/reference/3.3/api/java/index-all.html

Deprecated. Gets the value of this LdapRdn.

```APIDOC
## getValue()

### Description
Deprecated. Get the value of this LdapRdn.

### Method
Method

### Class
org.springframework.ldap.core.LdapRdn
```

--------------------------------

### New Instance

Source: https://docs.spring.io/spring-ldap/reference/3.3/api/java/org/springframework/ldap/pool/DelegatingLdapContext.html

Creates a new LdapContext instance with specified request controls.

```APIDOC
## Method: newInstance

### Description
Creates a new `LdapContext` instance with specified request controls.

### Specified by
`newInstance` in interface `LdapContext`

### Parameters
* `requestControls` (Control[]) - The request controls to use for the new instance.

### Throws
* `NamingException`

### See Also
* `LdapContext.newInstance(javax.naming.ldap.Control[])`
```

--------------------------------

### LdapRdn.getComponents()

Source: https://docs.spring.io/spring-ldap/reference/3.3/api/java/index-all.html

Deprecated. Gets all components in this LdapRdn.

```APIDOC
## getComponents()

### Description
Deprecated. Gets all components in this LdapRdn.

### Method
N/A (Method signature)

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A
```

--------------------------------

### DifferentSubtreeTempEntryRenamingStrategy Constructors

Source: https://docs.spring.io/spring-ldap/reference/3.3/api/java/org/springframework/ldap/transaction/compensating/support/DifferentSubtreeTempEntryRenamingStrategy.html

Constructors for initializing DifferentSubtreeTempEntryRenamingStrategy.

```APIDOC
## Constructor Summary

Constructors

Constructor
Description
`DifferentSubtreeTempEntryRenamingStrategy(String subtreeNode)`
`DifferentSubtreeTempEntryRenamingStrategy(Name subtreeNode)`
```

--------------------------------

### SimpleCharStream.getColumn()

Source: https://docs.spring.io/spring-ldap/reference/3.3/api/java/index-all.html

Deprecated. Gets the column number.

```APIDOC
## getColumn()

### Description
Deprecated. Gets the column number.

### Method
N/A (Method signature)

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A
```

--------------------------------

### DirContextAdapter Constructors

Source: https://docs.spring.io/spring-ldap/reference/3.3/api/java/org/springframework/ldap/core/DirContextAdapter.html

Provides documentation for the constructors of DirContextAdapter, used for initializing new instances.

```APIDOC
## Constructor Details
### DirContextAdapter 
public DirContextAdapter()
Default constructor.

### DirContextAdapter 
public DirContextAdapter(String dnString)
Create a new DirContextAdapter from the supplied DN String. 

Parameters:
    `dnString` - the DN string. Must be syntactically correct, or an exception will be thrown.

### DirContextAdapter 
public DirContextAdapter(Name dn)
Create a new adapter from the supplied dn.
```

--------------------------------

### getTargetContext

Source: https://docs.spring.io/spring-ldap/reference/3.3/api/java/org/springframework/ldap/pool2/DelegatingDirContext.html

Gets the target DirContext of the proxy.

```APIDOC
## getgetTargetContext()

### Description
Get the target `DirContext` of the proxy.

### Method
DirContext
```

--------------------------------

### Search using a ContextMapper

Source: https://docs.spring.io/spring-ldap/reference/3.3/dirobjectfactory.html

Demonstrates implementing a ContextMapper to transform LDAP entries into domain objects using DirContextAdapter.

```java
public class PersonRepoImpl implements PersonRepo {
   ...
   private static class PersonContextMapper implements ContextMapper {
      public Object mapFromContext(Object ctx) {
         DirContextAdapter context = (DirContextAdapter)ctx;
         Person p = new Person();
         p.setFullName(context.getStringAttribute("cn"));
         p.setLastName(context.getStringAttribute("sn"));
         p.setDescription(context.getStringAttribute("description"));
         return p;
      }
   }

   public Person findByPrimaryKey(
      String name, String company, String country) {
      Name dn = buildDn(name, company, country);
      return ldapClient.search().name(dn).toObject(new PersonContextMapper());
   }
}
```

--------------------------------

### getReadWriteContext

Source: https://docs.spring.io/spring-ldap/reference/3.3/api/java/org/springframework/ldap/core/support/ObservationContextSource.html

Gets a read-write DirContext instance.

```APIDOC
## getReadWriteContext()

### Description
Gets a read-write `DirContext` instance.

### Method
`public DirContext getReadWriteContext() throws NamingException`

### Returns
A `DirContext` instance, never `null`.

### Throws
`NamingException` - if some error occurs creating an `DirContext`.
```

--------------------------------

### Constructor Details

Source: https://docs.spring.io/spring-ldap/reference/3.3/api/java/org/springframework/ldap/control/VirtualListViewControlAggregateDirContextProcessor.html

Detailed information about the constructors.

```APIDOC
## Constructor Details

### VirtualListViewControlAggregateDirContextProcessor

`public VirtualListViewControlAggregateDirContextProcessor(String sortKey, int pageSize)`

### VirtualListViewControlAggregateDirContextProcessor

`public VirtualListViewControlAggregateDirContextProcessor(String sortKey, int pageSize, int targetOffset, int listSize, VirtualListViewResultsCookie cookie)`

### VirtualListViewControlAggregateDirContextProcessor

`public VirtualListViewControlAggregateDirContextProcessor(SortControlDirContextProcessor sortControlDirContextProcessor, VirtualListViewControlDirContextProcessor virtualListViewControlDirContextProcessor)`
```

--------------------------------

### getReadOnlyContext

Source: https://docs.spring.io/spring-ldap/reference/3.3/api/java/org/springframework/ldap/core/support/ObservationContextSource.html

Gets a read-only DirContext instance.

```APIDOC
## getReadOnlyContext()

### Description
Gets a read-only `DirContext` instance. The returned `DirContext` must be possible to perform read-only operations on.

### Method
`public DirContext getReadOnlyContext() throws NamingException`

### Returns
A `DirContext` instance, never null.

### Throws
`NamingException` - if some error occurs creating an `DirContext`.
```

--------------------------------

### getReadWriteContext

Source: https://docs.spring.io/spring-ldap/reference/3.3/api/java/org/springframework/ldap/core/support/AbstractContextSource.html

Gets a read-write DirContext instance.

```APIDOC
## getReadWriteContext

### Description
Gets a read-write DirContext instance.

### Method
public DirContext getReadWriteContext()

### Response
#### Success Response
- **DirContext** - A DirContext instance, never null.
```

--------------------------------

### createInstance

Source: https://docs.spring.io/spring-ldap/reference/3.3/api/java/org/springframework/ldap/test/unboundid/TestContextSourceFactoryBean.html

Creates and returns a new instance of ContextSource.

```APIDOC
## createInstance()

### Description
Creates and returns a new instance of ContextSource.

### Method
`protected ContextSource createInstance() throws Exception`

### Returns
* **ContextSource** - A new instance of ContextSource.
```

--------------------------------

### Constructing a new LdapQueryBuilder

Source: https://docs.spring.io/spring-ldap/reference/3.3/api/java/org/springframework/ldap/query/LdapQueryBuilder.html

Shows how to create a new instance of LdapQueryBuilder. This is the starting point for building any LDAP query.

```java
LdapQueryBuilder query = query();
```

--------------------------------

### AbstractEc2InstanceLaunchingFactoryBean Configuration

Source: https://docs.spring.io/spring-ldap/reference/3.3/api/java/org/springframework/ldap/test/AbstractEc2InstanceLaunchingFactoryBean.html

Configuration options for AbstractEc2InstanceLaunchingFactoryBean, including AWS credentials, keypair, group name, and image name.

```APIDOC
## AbstractEc2InstanceLaunchingFactoryBean

### Description
Abstract FactoryBean superclass to use for automatically launching an EC2 instance before creating the actual target object. This approach is particularly useful for integration testing purposes.

### Methods

#### `setImageName(String imageName)`
Set the name of the AMI image to be launched.

Parameters:
- `imageName` (String) - the AMI image name.

#### `setAwsKey(String awsKey)`
Set the AWS key.

Parameters:
- `awsKey` (String) - the AWS key.

#### `setAwsSecretKey(String awsSecretKey)`
Set the AWS secret key.

Parameters:
- `awsSecretKey` (String) - the aws secret key.

#### `setKeypairName(String keypairName)`
Set the name of the keypair.

Parameters:
- `keypairName` (String) - The keypair name.

#### `setGroupName(String groupName)`
Set the name of the access group. This group should be configured with the appropriate ports open for this test case to execute.

Parameters:
- `groupName` (String) - the group name.

#### `createInstance()`
Protected method to create the instance.

Throws:
- `Exception`

#### `doCreateInstance(String ip)`
Implement to create the actual target object.

Parameters:
- `ip` (String) - the ip address of the launched EC2 image.

Returns:
- the object to be returned by this FactoryBean.

Throws:
- `Exception` - if an error occurs during initialization.

#### `destroyInstance(Object ignored)`
Protected method to destroy the instance.

Overrides:
- `destroyInstance` in class `org.springframework.beans.factory.config.AbstractFactoryBean`

Throws:
- `Exception`
```

--------------------------------

### getValue()

Source: https://docs.spring.io/spring-ldap/reference/3.3/api/java/index-all.html

Deprecated. Gets the (Attribute) value of this component.

```APIDOC
## getValue()

### Description
Deprecated. Get the (Attribute) value of this component.

### Method
Method

### Class
org.springframework.ldap.core.LdapRdnComponent
```

--------------------------------

### startEmbeddedServer

Source: https://docs.spring.io/spring-ldap/reference/3.3/api/java/org/springframework/ldap/test/unboundid/LdapTestUtils.html

Starts an embedded Apache Directory Server on a specified port with a default partition suffix and name. This method ensures only one embedded server can run in a JVM and throws an IllegalStateException if a server is already active.

```APIDOC
## startEmbeddedServer

### Description
Starts an embedded Apache Directory Server. Only one embedded server will be permitted in the same JVM.

### Method
`static void`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
* `port` (int) - The port on which the server will be listening.
* `defaultPartitionSuffix` (String) - The default base suffix that will be used for the LDAP server.
* `defaultPartitionName` (String) - The name to use in the directory server configuration for the default base suffix.

### Throws
* `IllegalStateException` - if an embedded server is already started.

```

--------------------------------

### LdapRdn.getComponent()

Source: https://docs.spring.io/spring-ldap/reference/3.3/api/java/index-all.html

Deprecated. Gets the first LdapRdnComponent of this LdapRdn.

```APIDOC
## getComponent()

### Description
Deprecated. Gets the first LdapRdnComponent of this LdapRdn.

### Method
N/A (Method signature)

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A
```

--------------------------------

### getDirContextInstance(Hashtable)

Source: https://docs.spring.io/spring-ldap/reference/3.3/api/java/index-all.html

Create a new InitialDirContext instance.

```APIDOC
## getDirContextInstance(Hashtable)

### Description
Creates a new InitialDirContext instance using the provided Hashtable of environment properties. This method is implemented by subclasses of AbstractContextSource.

### Method
N/A (Method Signature)

### Endpoint
N/A

### Parameters
* **environment** (Hashtable) - A Hashtable containing environment properties for the DirContext.

### Response
* Description not provided in source.
```

--------------------------------

### Creating a new LdapNameBuilder instance

Source: https://docs.spring.io/spring-ldap/reference/3.3/api/java/org/springframework/ldap/support/LdapNameBuilder.html

Shows how to initialize a new LdapNameBuilder, either from scratch or from an existing Name object or string.

```java
LdapNameBuilder.newInstance();
```

```java
LdapNameBuilder.newInstance(name);
```

```java
LdapNameBuilder.newInstance(name);
```

--------------------------------

### SimpleCharStream.getBeginColumn()

Source: https://docs.spring.io/spring-ldap/reference/3.3/api/java/index-all.html

Get token beginning column number.

```APIDOC
## getBeginColumn()

### Description
Get token beginning column number.

### Method
N/A (Method signature)

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A
```

--------------------------------

### create

Source: https://docs.spring.io/spring-ldap/reference/3.3/api/java/org/springframework/ldap/odm/core/OdmManager.html

Creates a given entry in the LDAP directory.

```APIDOC
## create

### Description
Creates the given entry in the LDAP directory.

### Method Signature
`void create(Object entry)`

### Parameters
#### Request Body
- **entry** (Object) - Required - The entry to be created, it must _not_ already exist in the directory.

### Throws
- **NamingException** - on error.
```

--------------------------------

### BaseLdapPathSource.getBaseLdapPathAsString()

Source: https://docs.spring.io/spring-ldap/reference/3.3/api/java/index-all.html

Get the base LDAP path as a String.

```APIDOC
## getBaseLdapPathAsString()

### Description
Get the base LDAP path as a String.

### Method
N/A (Method signature)

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A
```

--------------------------------

### AbstractContextSource.getBaseLdapPathAsString()

Source: https://docs.spring.io/spring-ldap/reference/3.3/api/java/index-all.html

Gets the base LDAP path as a String.

```APIDOC
## getBaseLdapPathAsString()

### Description
Gets the base LDAP path as a String.

### Method
N/A (Method signature)

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A
```

--------------------------------

### AbstractContextSource.getBaseLdapPath()

Source: https://docs.spring.io/spring-ldap/reference/3.3/api/java/index-all.html

Deprecated. Gets the base LDAP path.

```APIDOC
## getBaseLdapPath()

### Description
Deprecated. `DistinguishedName` and associated classes and methods are deprecated as of 2.0.

### Method
N/A (Method signature)

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A
```

--------------------------------

### LdifPopulator Constructor

Source: https://docs.spring.io/spring-ldap/reference/3.3/api/java/org/springframework/ldap/test/LdifPopulator.html

Initializes a new instance of the LdifPopulator class.

```APIDOC
## LdifPopulator()

### Description
Initializes a new instance of the LdifPopulator class.

### Constructor
`LdifPopulator()`
```

--------------------------------

### LdifPopulator Constructor

Source: https://docs.spring.io/spring-ldap/reference/3.3/api/java/org/springframework/ldap/test/unboundid/LdifPopulator.html

Initializes a new instance of the LdifPopulator class.

```APIDOC
## LdifPopulator()

### Description
Initializes a new instance of the `LdifPopulator` class.

### Constructor
`LdifPopulator()`
```

--------------------------------

### BaseLdapPathSource.getBaseLdapName()

Source: https://docs.spring.io/spring-ldap/reference/3.3/api/java/index-all.html

Get the base LDAP path as a LdapName.

```APIDOC
## getBaseLdapName()

### Description
Get the base LDAP path as a `LdapName`.

### Method
N/A (Method signature)

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A
```

--------------------------------

### create

Source: https://docs.spring.io/spring-ldap/reference/3.3/api/java/org/springframework/ldap/core/LdapOperations.html

Creates a new entry in the LDAP directory.

```APIDOC
## create(Object entry)

### Description
Create the given entry in the LDAP directory.

### Method
void

### Parameters
* **entry** (Object) - The entry object to create.
```

--------------------------------

### AbstractContextSource.getBaseLdapName()

Source: https://docs.spring.io/spring-ldap/reference/3.3/api/java/index-all.html

Gets the base LDAP path as an LdapName.

```APIDOC
## getBaseLdapName()

### Description
Gets the base LDAP path as an LdapName.

### Method
N/A (Method signature)

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A
```

--------------------------------

### getTransactedResource Method

Source: https://docs.spring.io/spring-ldap/reference/3.3/api/java/org/springframework/ldap/transaction/compensating/manager/DirContextHolder.html

Gets the actual transacted resource.

```APIDOC
## getTransactedResource()

### Description
Get the actual transacted resource.

### Method
protected Object

### Returns
* Object - the transaction's target resource
```

--------------------------------

### Constructor

Source: https://docs.spring.io/spring-ldap/reference/3.3/api/java/org/springframework/ldap/pool2/DelegatingLdapContext.html

Initializes a new DelegatingLdapContext with a pool, delegate LdapContext, and context type.

```APIDOC
## Constructor: DelegatingLdapContext

### Description
Creates a new delegating ldap context for the specified pool, context and context type.

### Parameters
* `keyedObjectPool` (org.apache.commons.pool2.KeyedObjectPool<Object,Object>) - The pool the delegate context was checked out from.
* `delegateLdapContext` (LdapContext) - The ldap context to delegate operations to.
* `dirContextType` (DirContextType) - The type of context, used as a key for the pool.

### Throws
* `IllegalArgumentException` - if any of the arguments are null
```

--------------------------------

### getReadWriteContext

Source: https://docs.spring.io/spring-ldap/reference/3.3/api/java/org/springframework/ldap/pool2/factory/PooledContextSource.html

Gets a read-write DirContext instance from the pool.

```APIDOC
## getReadWriteContext

### Description
Gets a read-write `DirContext` instance.

### Method
public DirContext getReadWriteContext()

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **DirContext** (DirContext) - A `DirContext` instance, never `null`.

#### Response Example
None
```

--------------------------------

### Constructor

Source: https://docs.spring.io/spring-ldap/reference/3.3/api/java/org/springframework/ldap/odm/core/impl/DefaultObjectDirectoryMapper.html

Constructs a new DefaultObjectDirectoryMapper.

```APIDOC
## Constructor

### DefaultObjectDirectoryMapper

`public DefaultObjectDirectoryMapper()`

**Description:**
Initializes a new instance of the `DefaultObjectDirectoryMapper` class.
```

--------------------------------

### getReadOnlyContext

Source: https://docs.spring.io/spring-ldap/reference/3.3/api/java/org/springframework/ldap/pool2/factory/PooledContextSource.html

Gets a read-only DirContext instance from the pool.

```APIDOC
## getReadOnlyContext

### Description
Gets a read-only `DirContext`. The returned `DirContext` must be possible to perform read-only operations on.

### Method
public DirContext getReadOnlyContext()

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **DirContext** (DirContext) - A DirContext instance, never null.

#### Response Example
None
```

--------------------------------

### getDirContextInstance Method

Source: https://docs.spring.io/spring-ldap/reference/3.3/api/java/org/springframework/ldap/core/support/DirContextSource.html

This protected method is responsible for creating a new InitialDirContext instance using the provided environment properties. It is an implementation of the abstract method from AbstractContextSource.

```APIDOC
## Method Details

### `getDirContextInstance`

```java
protected DirContext getDirContextInstance(Hashtable environment) throws NamingException
```

**Description:** Creates a new `InitialDirContext` instance.

**Parameters:**
* `environment` (Hashtable) - The environment to use when creating the context.

**Returns:**
* A new `InitialDirContext` implementation.

**Throws:**
* `NamingException` - If one is encountered when creating the instance.
```

--------------------------------

### getReadWriteContext

Source: https://docs.spring.io/spring-ldap/reference/3.3/api/java/org/springframework/ldap/pool2/factory/PooledContextSource.html

Gets a read-write DirContext instance from the pool.

```APIDOC
## getReadWriteContext()

### Description
Gets a read-write `DirContext` instance from the pool.

### Method
`getReadWriteContext()`

### Returns
- `DirContext` - A read-write DirContext instance
```

--------------------------------

### SchemaToJava Main Method Signature

Source: https://docs.spring.io/spring-ldap/reference/3.3/api/java/org/springframework/ldap/odm/tools/SchemaToJava.html

The main entry point for the SchemaToJava command-line tool. It accepts an array of strings for command-line arguments.

```java
public static void main(String[] argv)
```

--------------------------------

### DirContextAdapter Constructors

Source: https://docs.spring.io/spring-ldap/reference/3.3/api/java/org/springframework/ldap/core/DirContextAdapter.html

Provides details on the various constructors available for creating DirContextAdapter instances, allowing initialization with DN strings, attributes, or existing adapters.

```APIDOC
## DirContextAdapter Constructors

### Default Constructor
```java
DirContextAdapter()
```

### Constructor with DN String
```java
DirContextAdapter(String dnString)
```

### Constructor with Attributes and DN
```java
DirContextAdapter(Attributes attrs, Name dn)
```

### Constructor with Attributes, DN, and Base
```java
DirContextAdapter(Attributes attrs, Name dn, Name base)
```

### Constructor with Attributes, DN, Base, and Referral URL
```java
DirContextAdapter(Attributes attrs, Name dn, Name base, String referralUrl)
```

### Constructor with DN
```java
DirContextAdapter(Name dn)
```

### Protected Cloning Constructor
```java
protected DirContextAdapter(DirContextAdapter main)
```
```

--------------------------------

### getReadOnlyContext

Source: https://docs.spring.io/spring-ldap/reference/3.3/api/java/org/springframework/ldap/pool2/factory/PooledContextSource.html

Gets a read-only DirContext instance from the pool.

```APIDOC
## getReadOnlyContext()

### Description
Gets a read-only `DirContext` instance from the pool.

### Method
`getReadOnlyContext()`

### Returns
- `DirContext` - A read-only DirContext instance
```

--------------------------------

### getBaseLdapPathAsString

Source: https://docs.spring.io/spring-ldap/reference/3.3/api/java/org/springframework/ldap/core/support/ObservationContextSource.html

Get the base LDAP path as a String.

```APIDOC
## getBaseLdapPathAsString()

### Description
Get the base LDAP path as a String.

### Method
`public String getBaseLdapPathAsString()`

### Returns
The base LDAP path as a String. An empty String will be returned if no base path is specified.
```

--------------------------------

### AbstractFallbackRequestAndResponseControlDirContextProcessor Constructor

Source: https://docs.spring.io/spring-ldap/reference/3.3/api/java/org/springframework/ldap/control/AbstractFallbackRequestAndResponseControlDirContextProcessor.html

Initializes a new instance of the AbstractFallbackRequestAndResponseControlDirContextProcessor class.

```APIDOC
## AbstractFallbackRequestAndResponseControlDirContextProcessor

### Description
Initializes a new instance of the `AbstractFallbackRequestAndResponseControlDirContextProcessor` class.

### Constructor
`public AbstractFallbackRequestAndResponseControlDirContextProcessor()`
```

--------------------------------

### DirContextAdapter Constructors

Source: https://docs.spring.io/spring-ldap/reference/3.3/api/java/org/springframework/ldap/core/DirContextAdapter.html

Provides different ways to create a DirContextAdapter instance.

```APIDOC
## DirContextAdapter Constructors

### DirContextAdapter(Attributes attrs, Name dn)

**Description**: Create a new adapter from the supplied attributes and dn.

**Parameters**:
- `attrs` (Attributes) - the attributes.
- `dn` (Name) - the dn.

### DirContextAdapter(Attributes attrs, Name dn, Name base)

**Description**: Create a new adapter from the supplied attributes, dn, and base.

**Parameters**:
- `attrs` (Attributes) - the attributes.
- `dn` (Name) - the dn.
- `base` (Name) - the base name.

### DirContextAdapter(Attributes attrs, Name dn, Name base, String referralUrl)

**Description**: Create a new adapter from the supplied attributes, dn, base, and referral url.

**Parameters**:
- `attrs` (Attributes) - the attributes.
- `dn` (Name) - the dn.
- `base` (Name) - the base.
- `referralUrl` (String) - the referral url (if this instance results from a referral).

### DirContextAdapter(DirContextAdapter main)

**Description**: Constructor for cloning an existing adapter.

**Parameters**:
- `main` (DirContextAdapter) - The adapter to be copied.
```

--------------------------------

### getBaseLdapName

Source: https://docs.spring.io/spring-ldap/reference/3.3/api/java/org/springframework/ldap/core/support/ObservationContextSource.html

Get the base LDAP path as a LdapName.

```APIDOC
## getBaseLdapName()

### Description
Get the base LDAP path as a `LdapName`.

### Method
`public LdapName getBaseLdapName()`

### Returns
The base LDAP path as a `LdapName`. The path will be empty if no base path is specified.
```

--------------------------------

### LdapClient.create

Source: https://docs.spring.io/spring-ldap/reference/3.3/api/java/org/springframework/ldap/core/LdapClient.html

Creates an instance of LdapClient using a ContextSource or LdapTemplate.

```APIDOC
## create(ContextSource contextSource)

### Description
Create an instance of `LdapClient`.

### Method
`static LdapClient`

### Parameters
#### Path Parameters
- **contextSource** (ContextSource) - Required - The ContextSource to use for creating the LdapClient.

### Response
- **LdapClient** - An instance of `LdapClient`.
```

```APIDOC
## create(LdapTemplate ldap)

### Description
Create an instance of `LdapClient`.

### Method
`static LdapClient`

### Parameters
#### Path Parameters
- **ldap** (LdapTemplate) - Required - The LdapTemplate to use for creating the LdapClient.

### Response
- **LdapClient** - An instance of `LdapClient`.
```

--------------------------------

### getBaseLdapPath

Source: https://docs.spring.io/spring-ldap/reference/3.3/api/java/org/springframework/ldap/core/support/ObservationContextSource.html

Get the base LDAP path as a DistinguishedName.

```APIDOC
## getBaseLdapPath()

### Description
Get the base LDAP path as a `DistinguishedName`.

### Method
`@Deprecated public DistinguishedName getBaseLdapPath()`

### Returns
The base LDAP path as a `DistinguishedName`. The path will be empty if no base path is specified.
```

--------------------------------

### newInstance

Source: https://docs.spring.io/spring-ldap/reference/3.3/api/java/org/springframework/ldap/pool2/DelegatingLdapContext.html

Creates a new LdapContext instance with the specified request controls.

```APIDOC
## Method: newInstance

### Description
Creates a new LdapContext instance with the specified request controls.

### Specified by
`newInstance` in interface `LdapContext`

### Parameters
* `requestControls` (Control[]) - The request controls to use for the new instance.

### Throws
* `NamingException`

### See Also
* `LdapContext.newInstance(Control[])`
```

--------------------------------

### getBaseLdapPathAsString

Source: https://docs.spring.io/spring-ldap/reference/3.3/api/java/org/springframework/ldap/core/support/AbstractContextSource.html

Get the base LDAP path as a String.

```APIDOC
## getBaseLdapPathAsString

### Description
Get the base LDAP path as a String.

### Method
public String getBaseLdapPathAsString()

### Response
#### Success Response
- **String** - the base LDAP path as a An empty String will be returned if no base path is specified.
```
Tokens:
Raw