| | |
| | | package org.opends.server.admin.client.cli; |
| | | |
| | | import java.io.OutputStream; |
| | | import java.util.Set; |
| | | |
| | | import org.opends.admin.ads.ADSContext; |
| | | import org.opends.admin.ads.ADSContextException; |
| | | import org.opends.server.admin.client.cli.DsFrameworkCliReturnCode.ReturnCode; |
| | | import org.opends.server.util.args.ArgumentException; |
| | | import org.opends.server.util.args.BooleanArgument; |
| | | import org.opends.server.util.args.SubCommand; |
| | | import org.opends.server.util.args.SubCommandArgumentParser; |
| | | |
| | | /** |
| | | * This Interface defines method that a group of subcommand shoud implement. |
| | |
| | | * If there is a problem with any of the parameters used |
| | | * to create this argument. |
| | | */ |
| | | public void initializeCliGroup(SubCommandArgumentParser argParser, |
| | | public void initializeCliGroup(DsFrameworkCliParser argParser, |
| | | BooleanArgument verboseArg) throws ArgumentException; |
| | | |
| | | /** |
| | |
| | | |
| | | /** |
| | | * Handle the subcommand. |
| | | * @param adsContext |
| | | * The context to use to perform ADS operation. |
| | | * @param subCmd |
| | | * The actual subcommand with input parameter |
| | | * |
| | | * @param outStream The output stream to use for standard output. |
| | | * |
| | | * @param errStream The output stream to use for standard error. |
| | | * |
| | | * @return the return code |
| | | * @throws ADSContextException |
| | | * If there is a problem with when trying to perform the |
| | | * operation. |
| | | * @throws ArgumentException |
| | | * If there is a problem with any of the parameters used |
| | | * to execute this subcommand. |
| | | */ |
| | | public ReturnCode performSubCommand(ADSContext adsContext, |
| | | SubCommand subCmd, OutputStream outStream, OutputStream errStream) |
| | | throws ADSContextException; |
| | | public ReturnCode performSubCommand(SubCommand subCmd, |
| | | OutputStream outStream, OutputStream errStream) |
| | | throws ADSContextException, ArgumentException; |
| | | |
| | | /** |
| | | * Get the subcommands list. |
| | | * @return the subcommand list. |
| | | */ |
| | | public Set<SubCommand> getSubCommands(); |
| | | |
| | | /** |
| | | * Indicates whether this subcommand group should be hidden from the usage |
| | | * information. |
| | | * |
| | | * @return <CODE>true</CODE> if this subcommand group should be hidden |
| | | * from the usage information, or <CODE>false</CODE> if |
| | | * not. |
| | | */ |
| | | public boolean isHidden(); |
| | | |
| | | /** |
| | | * Indicates subcommand group name. |
| | | * |
| | | * @return the subcommand group name |
| | | */ |
| | | public String getGroupName(); |
| | | |
| | | } |