1<?php
2
3/**
4 * This file is part of the FreeDSx LDAP package.
5 *
6 * (c) Chad Sikorra <Chad.Sikorra@gmail.com>
7 *
8 * For the full copyright and license information, please view the LICENSE
9 * file that was distributed with this source code.
10 */
11
12namespace FreeDSx\Ldap\Server\RequestHandler;
13
14use FreeDSx\Ldap\Entry\Entry;
15use FreeDSx\Ldap\Operation\Request\SearchRequest;
16use FreeDSx\Ldap\Server\RequestContext;
17
18/**
19 * Request Handlers wanting more control over the RootDSE may implement this interface.
20 *
21 * @author Chad Sikorra <Chad.Sikorra@gmail.com>
22 */
23interface RootDseHandlerInterface
24{
25    /**
26     * Either return your own RootDse, or just pass back / modify the entry already generated.
27     *
28     * @param RequestContext $context
29     * @param SearchRequest $request
30     * @param Entry $rootDse
31     * @return Entry
32     */
33    public function rootDse(RequestContext $context, SearchRequest $request, Entry $rootDse): Entry;
34}
35