Package org.forgerock.opendj.config.dsconfig

Class LdapManagementContextFactory

java.lang.Object

org.forgerock.opendj.config.dsconfig.LdapManagementContextFactory

All Implemented Interfaces:

Closeable, AutoCloseable, ManagementContextFactory

public final class LdapManagementContextFactory
extends Object
implements ManagementContextFactory

An LDAP management context factory for the DSConfig tool.

Constructor Summary

Constructors

Constructor	Description
LdapManagementContextFactory(com.forgerock.opendj.cli.LdapClientProvider cfp)	Creates a new LDAP management context factory based on LDAP client.

Method Summary

Modifier and Type	Method	Description
void	close()	Closes the management context returned by ManagementContextFactory.getManagementContext().
ManagementContext	getManagementContext()	Gets the management context which sub-commands should use in order to manage the directory server.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

LdapManagementContextFactory

public LdapManagementContextFactory(com.forgerock.opendj.cli.LdapClientProvider cfp)

Creates a new LDAP management context factory based on LDAP client.

Parameters:

cfp - The LDAP client provider which should be used in this context.

Method Details

getManagementContext

public ManagementContext getManagementContext()
                                       throws com.forgerock.opendj.cli.ClientException

Description copied from interface: ManagementContextFactory

Gets the management context which sub-commands should use in order to manage the directory server.

The manangement context is created lazily, this method should always return the same management context instance.

Specified by:

getManagementContext in interface ManagementContextFactory

Returns:

Returns the management context which sub-commands should use in order to manage the directory server.

Throws:

com.forgerock.opendj.cli.ClientException - If the management context could not be created.

close

public void close()

Description copied from interface: ManagementContextFactory

Closes the management context returned by ManagementContextFactory.getManagementContext().

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface ManagementContextFactory