org.opends.server.tools.dsconfig
Interface ManagementContextFactory

All Known Implementing Classes:

InternalManagementContextFactory, LDAPManagementContextFactory

public interface ManagementContextFactory

A factory for retrieving the management context which should be used by the dsconfig application.

Factory implementations are responsible for registering their required global options during initialization.

Method Summary

void	close() Closes this management context.
CommandBuilder	getContextCommandBuilder() Returns the command builder that provides the equivalent arguments in interactive mode to get the management context.
ManagementContext	getManagementContext(ConsoleApplication app) Gets the management context which sub-commands should use in order to manage the directory server.
void	registerGlobalArguments(SubCommandArgumentParser parser) Initializes this management context factory using the provided parser.
void	validateGlobalArguments() Validates any global arguments passed to the application.

Method Detail

getManagementContext

ManagementContext getManagementContext(ConsoleApplication app)
                                       throws ArgumentException,
                                              ClientException

Gets the management context which sub-commands should use in order to manage the directory server. Implementations can use the application instance for retrieving passwords interactively.

Parameters:

app - The application instance.

Returns:

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

Throws:

ArgumentException - If a management context related argument could not be parsed successfully.

ClientException - If the management context could not be created.

close

void close()

Closes this management context.

registerGlobalArguments

void registerGlobalArguments(SubCommandArgumentParser parser)
                             throws ArgumentException

Initializes this management context factory using the provided parser. The management context factory can register global options with the parser if required.

Parameters:

parser - The application sub-command argument parser.

Throws:

ArgumentException - If the factory failed to register its required global options.

validateGlobalArguments

void validateGlobalArguments()
                             throws ArgumentException

Validates any global arguments passed to the application. Implementations of this method should check that the values passed to their global arguments are valid and are not incompatible with each other.

Throws:

ArgumentException - If the global arguments are invalid for some reason.

getContextCommandBuilder

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.