Package org.forgerock.opendj.config.dsconfig

Class LDAPManagementContextFactory

java.lang.Object

org.forgerock.opendj.config.dsconfig.LDAPManagementContextFactory

public final class LDAPManagementContextFactory
extends Object

An LDAP management context factory for the DSConfig tool.

Constructor Summary

Constructors

Constructor	Description
LDAPManagementContextFactory(com.forgerock.opendj.cli.ConnectionFactoryProvider cfp)	Creates a new LDAP management context factory based on an authenticated connection factory.

Method Summary

Modifier and Type	Method	Description
void	close()	Closes this management context.
com.forgerock.opendj.cli.CommandBuilder	getContextCommandBuilder()	Returns the command builder that provides the equivalent arguments in interactive mode to get the management context.
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 Detail

LDAPManagementContextFactory

public LDAPManagementContextFactory(com.forgerock.opendj.cli.ConnectionFactoryProvider cfp)
                             throws com.forgerock.opendj.cli.ArgumentException

Creates a new LDAP management context factory based on an authenticated connection factory.

Parameters:

cfp - The connection factory provider which should be used in this context.

Throws:

com.forgerock.opendj.cli.ArgumentException - If an exception occurs when creating the authenticated connection factory linked to this context.

Method Detail

close

public void close()

Closes this management context.

getContextCommandBuilder

public com.forgerock.opendj.cli.CommandBuilder getContextCommandBuilder()

Returns the command builder that provides the equivalent arguments in interactive mode to get the management context.

Returns:

the command builder that provides the equivalent arguments in interactive mode to get the management context.

getManagementContext

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

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

Returns:

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

Throws:

com.forgerock.opendj.cli.ArgumentException - If a management context related argument could not be parsed successfully.

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