1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17 package org.apache.hadoop.hbase.util;
18
19 import java.io.IOException;
20 import java.util.Set;
21 import java.util.TreeSet;
22
23 import org.apache.commons.cli.BasicParser;
24 import org.apache.commons.cli.CommandLine;
25 import org.apache.commons.cli.CommandLineParser;
26 import org.apache.commons.cli.HelpFormatter;
27 import org.apache.commons.cli.Options;
28 import org.apache.commons.cli.ParseException;
29 import org.apache.commons.logging.Log;
30 import org.apache.commons.logging.LogFactory;
31 import org.apache.hadoop.conf.Configuration;
32 import org.apache.hadoop.hbase.HBaseConfiguration;
33 import org.apache.hadoop.util.Tool;
34 import org.apache.hadoop.util.ToolRunner;
35
36
37
38
39
40 public abstract class AbstractHBaseTool implements Tool {
41
42 protected static final int EXIT_SUCCESS = 0;
43 protected static final int EXIT_FAILURE = 1;
44
45 private static final String HELP_OPTION = "help";
46
47 private static final Log LOG = LogFactory.getLog(AbstractHBaseTool.class);
48
49 private final Options options = new Options();
50
51 protected Configuration conf = null;
52
53 private static final Set<String> requiredOptions = new TreeSet<String>();
54
55 protected String[] cmdLineArgs = null;
56
57
58
59
60
61 protected abstract void addOptions();
62
63
64
65
66 protected abstract void processOptions(CommandLine cmd);
67
68
69 protected abstract int doWork() throws Exception;
70
71 @Override
72 public Configuration getConf() {
73 return conf;
74 }
75
76 @Override
77 public void setConf(Configuration conf) {
78 this.conf = conf;
79 }
80
81 @Override
82 public final int run(String[] args) throws IOException {
83 if (conf == null) {
84 LOG.error("Tool configuration is not initialized");
85 throw new NullPointerException("conf");
86 }
87
88 CommandLine cmd;
89 try {
90
91 cmd = parseArgs(args);
92 cmdLineArgs = args;
93 } catch (ParseException e) {
94 LOG.error("Error when parsing command-line arguemnts", e);
95 printUsage();
96 return EXIT_FAILURE;
97 }
98
99 if (cmd.hasOption(HELP_OPTION) || !sanityCheckOptions(cmd)) {
100 printUsage();
101 return EXIT_FAILURE;
102 }
103
104 processOptions(cmd);
105
106 int ret = EXIT_FAILURE;
107 try {
108 ret = doWork();
109 } catch (Exception e) {
110 LOG.error("Error running command-line tool", e);
111 return EXIT_FAILURE;
112 }
113 return ret;
114 }
115
116 private boolean sanityCheckOptions(CommandLine cmd) {
117 boolean success = true;
118 for (String reqOpt : requiredOptions) {
119 if (!cmd.hasOption(reqOpt)) {
120 LOG.error("Required option -" + reqOpt + " is missing");
121 success = false;
122 }
123 }
124 return success;
125 }
126
127 protected CommandLine parseArgs(String[] args) throws ParseException {
128 options.addOption(HELP_OPTION, false, "Show usage");
129 addOptions();
130 CommandLineParser parser = new BasicParser();
131 return parser.parse(options, args);
132 }
133
134 protected void printUsage() {
135 HelpFormatter helpFormatter = new HelpFormatter();
136 helpFormatter.setWidth(80);
137 String usageHeader = "Options:";
138 String usageFooter = "";
139 String usageStr = "bin/hbase " + getClass().getName() + " <options>";
140
141 helpFormatter.printHelp(usageStr, usageHeader, options,
142 usageFooter);
143 }
144
145 protected void addRequiredOptWithArg(String opt, String description) {
146 requiredOptions.add(opt);
147 addOptWithArg(opt, description);
148 }
149
150 protected void addOptNoArg(String opt, String description) {
151 options.addOption(opt, false, description);
152 }
153
154 protected void addOptWithArg(String opt, String description) {
155 options.addOption(opt, true, description);
156 }
157
158
159
160
161 public static long parseLong(String s, long minValue, long maxValue) {
162 long l = Long.parseLong(s);
163 if (l < minValue || l > maxValue) {
164 throw new IllegalArgumentException("The value " + l
165 + " is out of range [" + minValue + ", " + maxValue + "]");
166 }
167 return l;
168 }
169
170 public static int parseInt(String s, int minValue, int maxValue) {
171 return (int) parseLong(s, minValue, maxValue);
172 }
173
174
175 protected void doStaticMain(String args[]) {
176 int ret;
177 try {
178 ret = ToolRunner.run(HBaseConfiguration.create(), this, args);
179 } catch (Exception ex) {
180 LOG.error("Error running command-line tool", ex);
181 ret = EXIT_FAILURE;
182 }
183 System.exit(ret);
184 }
185
186 }