|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opends.server.tools.dsconfig.LDAPManagementContextFactory
public final class LDAPManagementContextFactory
An LDAP management context factory.
Constructor Summary | |
---|---|
LDAPManagementContextFactory()
Creates a new LDAP management context factory. |
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. |
ManagementContext |
getManagementContext(ConsoleApplication app,
LDAPConnectionConsoleInteraction ci)
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. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public LDAPManagementContextFactory()
Method Detail |
---|
public ManagementContext getManagementContext(ConsoleApplication app) throws ArgumentException, ClientException
getManagementContext
in interface ManagementContextFactory
app
- The application instance.
ArgumentException
- If a management context related argument could not be
parsed successfully.
ClientException
- If the management context could not be created.public void close()
close
in interface ManagementContextFactory
public CommandBuilder getContextCommandBuilder()
getContextCommandBuilder
in interface ManagementContextFactory
public ManagementContext getManagementContext(ConsoleApplication app, LDAPConnectionConsoleInteraction ci) throws ArgumentException, ClientException
app
- The application instance.ci
- the LDAPConsoleInteraction object to be used. The code assumes
that the LDAPConsoleInteraction has already been run.
ArgumentException
- If a management context related argument could not be
parsed successfully.
ClientException
- If the management context could not be created.public void registerGlobalArguments(SubCommandArgumentParser parser) throws ArgumentException
registerGlobalArguments
in interface ManagementContextFactory
parser
- The application sub-command argument parser.
ArgumentException
- If the factory failed to register its required global
options.public void validateGlobalArguments() throws ArgumentException
validateGlobalArguments
in interface ManagementContextFactory
ArgumentException
- If the global arguments are invalid for some reason.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |