Class CommandBase
java.lang.Object
org.apache.zookeeper.server.admin.CommandBase
- All Implemented Interfaces:
Command
- Direct Known Subclasses:
Commands.CnxnStatResetCommand,Commands.ConfCommand,Commands.ConsCommand,Commands.DigestCommand,Commands.DirsCommand,Commands.DumpCommand,Commands.EnvCommand,Commands.GetTraceMaskCommand,Commands.InitialConfigurationCommand,Commands.IsroCommand,Commands.LastSnapshotCommand,Commands.LeaderCommand,Commands.MonitorCommand,Commands.ObserverCnxnStatResetCommand,Commands.RuokCommand,Commands.SetTraceMaskCommand,Commands.SrvrCommand,Commands.StatResetCommand,Commands.SyncedObserverConsCommand,Commands.SystemPropertiesCommand,Commands.VotingViewCommand,Commands.WatchCommand,Commands.WatchesByPathCommand,Commands.WatchSummaryCommand,Commands.ZabStateCommand
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedCommandBase(List<String> names) protectedCommandBase(List<String> names, boolean serverRequired) protectedCommandBase(List<String> names, boolean serverRequired, String doc) -
Method Summary
Modifier and TypeMethodDescriptiongetDoc()A string documenting this command (e.g., what it does, any arguments it takes).getNames()The set of all names that can be used to refer to this command (e.g., "configuration", "config", and "conf").The name that is returned with the command response and that appears in the list of all commands.protected CommandResponseboolean
-
Constructor Details
-
CommandBase
- Parameters:
names- The possible names of this command, with the primary name first.
-
CommandBase
-
CommandBase
-
-
Method Details
-
getPrimaryName
Description copied from interface:CommandThe name that is returned with the command response and that appears in the list of all commands. This should be a member of the set returned by getNames().- Specified by:
getPrimaryNamein interfaceCommand
-
getNames
Description copied from interface:CommandThe set of all names that can be used to refer to this command (e.g., "configuration", "config", and "conf"). -
getDoc
Description copied from interface:CommandA string documenting this command (e.g., what it does, any arguments it takes). -
isServerRequired
public boolean isServerRequired()- Specified by:
isServerRequiredin interfaceCommand- Returns:
- true if the command requires an active ZooKeeperServer or a synced peer in order to resolve
-
initializeResponse
- Returns:
- A response with the command set to the primary name and the error set to null (these are the two entries that all command responses are required to include).
-