### 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.
```

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

### 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()`
```

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

### 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
```

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

### 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`.
```

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

### 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=*)
```

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

### 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`.

```

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

### 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=*))
```
```

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

### 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`
```

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

### AbstractEc2InstanceLaunchingFactoryBean Methods

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

Methods for configuring EC2 instance launching.

```APIDOC
## setGroupName(String)

### Description
Set the name of the access group.

### Method
Not applicable (Java method)

### Endpoint
Not applicable (Java method)

### Parameters
* **groupName** (String) - Description not specified
```

```APIDOC
## setImageName(String)

### Description
Set the name of the AMI image to be launched.

### Method
Not applicable (Java method)

### Endpoint
Not applicable (Java method)

### Parameters
* **imageName** (String) - Description not specified
```

```APIDOC
## setKeypairName(String)

### Description
Set the name of the keypair.

### Method
Not applicable (Java method)

### Endpoint
Not applicable (Java method)

### Parameters
* **keypairName** (String) - Description not specified
```

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

### 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");
```

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

### 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 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`
```

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

### 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.
```

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

### Search for Entries Starting at a Specific Base DN

Source: https://docs.spring.io/spring-ldap/reference/3.3/query-builder-advanced.html

Perform a search starting from a specified base distinguished name (DN) in the LDAP tree, while also filtering by object class. This limits the search scope.

```java
import static org.springframework.ldap.query.LdapQueryBuilder.query;
...

List<Person> persons = ldapClient.search()
      .query(query().base("dc=261consulting,dc=com").where("objectclass").is("person"))
      .toList(new PersonAttributesMapper());

```

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

### 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.
```

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

### 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.
```

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

### 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
```

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

### 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.
```

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

### 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.
```

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

### 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.
```

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

### 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
```

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

### 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`
```

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

### 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.
```

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

### 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
```

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

### 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
```

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

### 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()`
```

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

### 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
```

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

### 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`
```

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

### isUpdateMode()

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

Gets the update mode of the DirContextOperations or DirContextAdapter.

```APIDOC
## isUpdateMode()

### Description
Gets the update mode.

### Method
N/A (Method signature)

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A

#### Success Response (boolean)
Returns `true` if the update mode is enabled, `false` otherwise.
```

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

### 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[])`
```

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

### 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)`
```

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

### 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
```

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

### 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.
```

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

### 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
```

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

### 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)`
```

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

### 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
```

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

### 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();
```

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

### 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
```

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

### 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`
```

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

### 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
```

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

### isUpdateMode

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

Gets the current update mode of the DirContextAdapter.

```APIDOC
## isUpdateMode()

### Description
Gets the update mode. An entry in update mode will keep track of its modifications so that they can be retrieved using `AttributeModificationsAware.getModificationItems()`.

### Returns
- (boolean) - update mode.
```

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

### 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.

```

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

### 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.
```

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

### getValue() - PoolExhaustedAction

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

Gets the value for a PoolExhaustedAction enum constant.

```APIDOC
## getValue()

### Description
Gets the value for a PoolExhaustedAction enum constant.

### Method
Method

### Enum
org.springframework.ldap.pool.PoolExhaustedAction
```

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

### 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);
```

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

### getCredentials()

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

Get the credentials to use when creating an authenticated context.

```APIDOC
## getCredentials()

### Description
Retrieves the credentials required for creating an authenticated context. This method is part of the AuthenticationSource interface and its implementations.

### Method
N/A (Method Signature)

### Endpoint
N/A

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

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

### 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.
```

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

### LdapRdn.getComponent(int)

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

Deprecated. Get the LdapRdnComponent at index `idx`.

```APIDOC
## getComponent(int)

### Description
Deprecated. Get the LdapRdnComponent at index `idx`.

### Method
N/A (Method signature)

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A
```

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

### ModifyAttributesOperationRecorder.getCompensatingModificationItem()

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

Get a ModificationItem to use for rollback of the supplied modification.

```APIDOC
## getCompensatingModificationItem(Attributes, ModificationItem)

### Description
Get a ModificationItem to use for rollback of the supplied modification.

### 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()`
```

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

### getTransactionSynchronizationKey Method

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

Gets the key used for transaction synchronization.

```APIDOC
## getTransactionSynchronizationKey

### Description
Get the key (normally, a DataSource or similar) that should be used for transaction synchronization.

### Signature
`protected abstract Object getTransactionSynchronizationKey()`

### Returns
- The transaction synchronization key.
```

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

### 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.
```

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

### getNewHolder Method

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

Gets a new implementation-specific CompensatingTransactionHolderSupport instance.

```APIDOC
## getNewHolder

### Description
Get a new implementation specific `CompensatingTransactionHolderSupport` instance.

### Signature
`protected abstract CompensatingTransactionHolderSupport getNewHolder()`

### Returns
- A new `CompensatingTransactionHolderSupport` instance.
```

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

### filter()

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

Get the filter currently set for the LDAP query.

```APIDOC
## filter()

### Description
Get the filter.

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Method
public Filter filter()

### Returns
the filter.
```

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

### 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.
```

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

### 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)
```

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

### Get Delegate LdapContext

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

Retrieves the direct LdapContext delegate.

```APIDOC
## Method: getDelegateLdapContext

### Description
Retrieves the direct delegate for this ldap context proxy.

### Returns
* `LdapContext` - The direct delegate for this ldap context proxy
```

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

### getValues(String) - DefaultIncrementalAttributesMapper

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

Gets all of the collected values for the specified attribute.

```APIDOC
## getValues(String)

### Description
Get all of the collected values for the specified attribute.

### Method
Method

### Class
org.springframework.ldap.core.support.DefaultIncrementalAttributesMapper
```

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

### 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)
```
```

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

### 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()`
```

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

### getValues(String) - IncrementalAttributesMapper

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

Gets all of the collected values for the specified attribute.

```APIDOC
## getValues(String)

### Description
Get all of the collected values for the specified attribute.

### Method
Method

### Interface
org.springframework.ldap.core.IncrementalAttributesMapper
```

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

### Add Data using LdapClient

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

Demonstrates how to add a new entry to the LDAP tree using LdapClient.bind(). Requires building the distinguished name and attributes for the new entry.

```java
public class PersonRepoImpl implements PersonRepo {
   private LdapClient ldapClient;
   ...
   public void create(Person p) {
      Name dn = buildDn(p);
      ldapClient.bind(dn).attributes(buildAttributes(p)).execute();
   }

   private Attributes buildAttributes(Person p) {
      Attributes attrs = new BasicAttributes();
      BasicAttribute ocattr = new BasicAttribute("objectclass");
      ocattr.add("top");
      ocattr.add("person");
      attrs.put(ocattr);
      attrs.put("cn", "Some Person");
      attrs.put("sn", "Person");
      return attrs;
   }
}
```

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

### getTemporaryName(Name)

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

Gets a temporary name for the current entry to be renamed to.

```APIDOC
## getTemporaryName(Name)

### Description
Get a temporary name for the current entry to be renamed to.

### Method
Method

### Interface
org.springframework.ldap.transaction.compensating.TempEntryRenamingStrategy
```

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

### IncrementalAttributesMapper.getCollectedAttributes()

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

Get all collected values for all managed attributes as an Attributes instance.

```APIDOC
## getCollectedAttributes()

### Description
Get all collected values for all managed attributes as an Attributes instance.

### 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 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.
```

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

### getEnvironment

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

Gets the environment for this context. This method is part of the DirContext interface.

```APIDOC
## getEnvironment

### Description
Gets the environment for this context. This method is part of the DirContext interface.

### Method
public Hashtable<?,?> getEnvironment()

### Returns
- Hashtable<?,?> - The environment for this context.

### Throws
- NamingException
```

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

### 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`.
```

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

### 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, as specified by the DirContextProxy interface.

```APIDOC
## getTargetContext

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

### Method
public DirContext getTargetContext()

### Specified by
`getTargetContext` in interface `DirContextProxy`

### Returns
the target `DirContext`.
```

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

### DummyDirContext Methods

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

This section details the public methods available in the DummyDirContext class, which implements the DirContext interface.

```APIDOC
## DummyDirContext

This class provides a dummy implementation of the `DirContext` interface for testing purposes.

### Constructor

- `DummyDirContext()`: Initializes a new instance of the `DummyDirContext` class.

### Methods

#### `getAttributes`

- **Signature**: `Attributes getAttributes(Name name)`
- **Description**: Retrieves all attributes for a given name.
- **Throws**: `NamingException`

- **Signature**: `Attributes getAttributes(String name)`
- **Description**: Retrieves all attributes for a given name.
- **Throws**: `NamingException`

- **Signature**: `Attributes getAttributes(Name name, String[] attrIds)`
- **Description**: Retrieves specified attributes for a given name.
- **Throws**: `NamingException`

- **Signature**: `Attributes getAttributes(String name, String[] attrIds)`
- **Description**: Retrieves specified attributes for a given name.
- **Throws**: `NamingException`

#### `modifyAttributes`

- **Signature**: `void modifyAttributes(Name name, int modOp, Attributes attrs)`
- **Description**: Modifies attributes associated with a name.
- **Parameters**:
  - `name` (Name): The name of the entry to modify.
  - `modOp` (int): The modification operation type.
  - `attrs` (Attributes): The attributes to modify.
- **Throws**: `NamingException`

#### `bind`

- **Signature**: `void bind(String name, Object obj)`
- **Description**: Binds a name to an object.

- **Signature**: `void bind(String name, Object obj, Attributes attrs)`
- **Description**: Binds a name to an object with attributes.

- **Signature**: `void bind(Name name, Object obj)`
- **Description**: Binds a name to an object.

- **Signature**: `void bind(Name name, Object obj, Attributes attrs)`
- **Description**: Binds a name to an object with attributes.

#### `close`

- **Signature**: `void close()`
- **Description**: Closes this context.

#### `composeName`

- **Signature**: `String composeName(String name, String prefix)`
- **Description**: Composes a name from a name and a prefix.

- **Signature**: `Name composeName(Name name, Name prefix)`
- **Description**: Composes a name from a name and a prefix.

#### `createSubcontext`

- **Signature**: `Context createSubcontext(String name)`
- **Description**: Creates a new subcontext.

- **Signature**: `DirContext createSubcontext(String name, Attributes attrs)`
- **Description**: Creates a new subcontext with attributes.

- **Signature**: `Context createSubcontext(Name name)`
- **Description**: Creates a new subcontext.

- **Signature**: `DirContext createSubcontext(Name name, Attributes attrs)`
- **Description**: Creates a new subcontext with attributes.

#### `destroySubcontext`

- **Signature**: `void destroySubcontext(String name)`
- **Description**: Destroys a subcontext.

- **Signature**: `void destroySubcontext(Name name)`
- **Description**: Destroys a subcontext.

#### `getEnvironment`

- **Signature**: `Hashtable<?,?> getEnvironment()`
- **Description**: Retrieves the environment properties for this context.

#### `getNameInNamespace`

- **Signature**: `String getNameInNamespace()`
- **Description**: Retrieves the name of this context in its namespace.

#### `getNameParser`

- **Signature**: `NameParser getNameParser(String name)`
- **Description**: Retrieves the name parser for this context.

- **Signature**: `NameParser getNameParser(Name name)`
- **Description**: Retrieves the name parser for this context.

#### `getSchema`

- **Signature**: `DirContext getSchema(String name)`
- **Description**: Retrieves the schema for a given name.

- **Signature**: `DirContext getSchema(Name name)`
- **Description**: Retrieves the schema for a given name.

#### `getSchemaClassDefinition`

- **Signature**: `DirContext getSchemaClassDefinition(String name)`
- **Description**: Retrieves the schema class definition for a given name.

- **Signature**: `DirContext getSchemaClassDefinition(Name name)`
- **Description**: Retrieves the schema class definition for a given name.

#### `list`

- **Signature**: `NamingEnumeration<NameClassPair> list(String name)`
- **Description**: Lists the bindings in the specified subcontext.

- **Signature**: `NamingEnumeration<NameClassPair> list(Name name)`
- **Description**: Lists the bindings in the specified subcontext.

#### `listBindings`

- **Signature**: `NamingEnumeration<Binding> listBindings(String name)`
- **Description**: Lists the bindings in the specified subcontext, including the attribute information.

- **Signature**: `NamingEnumeration<Binding> listBindings(Name name)`
- **Description**: Lists the bindings in the specified subcontext, including the attribute information.

#### `lookup`

- **Signature**: `Object lookup(String name)`
- **Description**: Retrieves the named object.

- **Signature**: `Object lookup(Name name)`
- **Description**: Retrieves the named object.

#### `lookupLink`

- **Signature**: `Object lookupLink(String name)`
- **Description**: Retrieves the named object, following links.

- **Signature**: `Object lookupLink(Name name)`
- **Description**: Retrieves the named object, following links.

#### `rebind`

- **Signature**: `void rebind(String name, Object obj)`
- **Description**: Rebinds a name to an object.

- **Signature**: `void rebind(String name, Object obj, Attributes attrs)`
- **Description**: Rebinds a name to an object with attributes.

- **Signature**: `void rebind(Name name, Object obj)`
- **Description**: Rebinds a name to an object.

- **Signature**: `void rebind(Name name, Object obj, Attributes attrs)`
- **Description**: Rebinds a name to an object with attributes.

#### `removeFromEnvironment`

- **Signature**: `Object removeFromEnvironment(String propName)`
- **Description**: Removes a property from the environment.

#### `rename`

- **Signature**: `void rename(String oldName, String newName)`
- **Description**: Renames a name.

- **Signature**: `void rename(Name oldName, Name newName)`
- **Description**: Renames a name.

#### `search`

- **Signature**: `NamingEnumeration<SearchResult> search(String name, String filterExpr, Object[] filterArgs, SearchControls cons)`
- **Description**: Searches for objects based on a filter expression.

- **Signature**: `NamingEnumeration<SearchResult> search(String name, String filter, SearchControls cons)`
- **Description**: Searches for objects based on a filter.

- **Signature**: `NamingEnumeration<SearchResult> search(String name, Attributes matchingAttributes)`
- **Description**: Searches for objects based on matching attributes.

- **Signature**: `NamingEnumeration<SearchResult> search(String name, Attributes matchingAttributes, String[] attributesToReturn)`
- **Description**: Searches for objects based on matching attributes and returns specified attributes.

- **Signature**: `NamingEnumeration<SearchResult> search(Name name, String filterExpr, Object[] filterArgs, SearchControls cons)`
- **Description**: Searches for objects based on a filter expression.

- **Signature**: `NamingEnumeration<SearchResult> search(Name name, String filter, SearchControls cons)`
- **Description**: Searches for objects based on a filter.

- **Signature**: `NamingEnumeration<SearchResult> search(Name name, Attributes matchingAttributes)`
- **Description**: Searches for objects based on matching attributes.

- **Signature**: `NamingEnumeration<SearchResult> search(Name name, Attributes matchingAttributes, String[] attributesToReturn)`
- **Description**: Searches for objects based on matching attributes and returns specified attributes.

#### `unbind`

- **Signature**: `void unbind(String name)`
- **Description**: Unbinds a name.

- **Signature**: `void unbind(Name name)`
- **Description**: Unbinds a name.

```

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

### getContext

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

Gets a DirContext of the specified type from the keyed object pool.

```APIDOC
## getContext(DirContextType dirContextType)

### Description
Gets a `DirContext` of the specified type from the keyed object pool.

### Method
`getContext(DirContextType dirContextType)`

### Parameters
#### Path Parameters
- **dirContextType** (DirContextType) - Description not provided

### Returns
- `DirContext` - A DirContext of the specified type
```

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

### PagedResultsDirContextProcessor Constructors

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

Constructors for initializing PagedResultsDirContextProcessor.

```APIDOC
## Constructor Details

### PagedResultsDirContextProcessor

`public PagedResultsDirContextProcessor(int pageSize)`

Constructs a new instance. This constructor should be used when performing the first paged search operation, when no other results have been retrieved.

Parameters:
* `pageSize` - the page size.
```

```APIDOC
### PagedResultsDirContextProcessor

`public PagedResultsDirContextProcessor(int pageSize, PagedResultsCookie cookie)`

Constructs a new instance with the supplied page size and cookie. The cookie must be the exact same instance as received from a previous paged results search, or `null` if it is the first in an operation sequence.

Parameters:
* `pageSize` - the page size.
* `cookie` - the cookie, as received from a previous search.
```

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

### assembleProviderUrlString

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

Assemble a valid url String from all registered urls to add as PROVIDER_URL to the environment.

```APIDOC
## assembleProviderUrlString

### Description
Assemble a valid url String from all registered urls to add as PROVIDER_URL to the environment.

### Method
public String assembleProviderUrlString(String[] ldapUrls)

### Parameters
#### Path Parameters
- **ldapUrls** (String[]) - Required - all individual url Strings.

### Response
#### Success Response
- **String** - the full url String
```