View Javadoc

1   /**
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *   http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing, software
13   * distributed under the License is distributed on an "AS IS" BASIS,
14   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15   * See the License for the specific language governing permissions and
16   * limitations under the License.
17   */
18  
19  package org.apache.hadoop.hbase.rest;
20  
21  import java.util.ArrayList;
22  import java.util.List;
23  import java.util.Map;
24  import java.util.Map.Entry;
25  
26  import org.apache.commons.cli.CommandLine;
27  import org.apache.commons.cli.HelpFormatter;
28  import org.apache.commons.cli.Options;
29  import org.apache.commons.cli.ParseException;
30  import org.apache.commons.cli.PosixParser;
31  import org.apache.commons.lang.ArrayUtils;
32  import org.apache.commons.logging.Log;
33  import org.apache.commons.logging.LogFactory;
34  import org.apache.hadoop.classification.InterfaceAudience;
35  import org.apache.hadoop.conf.Configuration;
36  import org.apache.hadoop.hbase.HBaseConfiguration;
37  import org.apache.hadoop.hbase.rest.filter.AuthFilter;
38  import org.apache.hadoop.hbase.security.UserProvider;
39  import org.apache.hadoop.hbase.util.HttpServerUtil;
40  import org.apache.hadoop.hbase.util.InfoServer;
41  import org.apache.hadoop.hbase.util.Strings;
42  import org.apache.hadoop.hbase.util.VersionInfo;
43  import org.apache.hadoop.net.DNS;
44  import org.apache.hadoop.security.UserGroupInformation;
45  import org.mortbay.jetty.Connector;
46  import org.mortbay.jetty.Server;
47  import org.mortbay.jetty.nio.SelectChannelConnector;
48  import org.mortbay.jetty.security.SslSelectChannelConnector;
49  import org.mortbay.jetty.servlet.Context;
50  import org.mortbay.jetty.servlet.FilterHolder;
51  import org.mortbay.jetty.servlet.ServletHolder;
52  import org.mortbay.thread.QueuedThreadPool;
53  
54  import com.google.common.base.Preconditions;
55  import com.sun.jersey.api.json.JSONConfiguration;
56  import com.sun.jersey.spi.container.servlet.ServletContainer;
57  
58  /**
59   * Main class for launching REST gateway as a servlet hosted by Jetty.
60   * <p>
61   * The following options are supported:
62   * <ul>
63   * <li>-p --port : service port</li>
64   * <li>-ro --readonly : server mode</li>
65   * </ul>
66   */
67  @InterfaceAudience.Private
68  public class RESTServer implements Constants {
69  
70    private static void printUsageAndExit(Options options, int exitCode) {
71      HelpFormatter formatter = new HelpFormatter();
72      formatter.printHelp("bin/hbase rest start", "", options,
73        "\nTo run the REST server as a daemon, execute " +
74        "bin/hbase-daemon.sh start|stop rest [--infoport <port>] [-p <port>] [-ro]\n", true);
75      System.exit(exitCode);
76    }
77  
78    /**
79     * The main method for the HBase rest server.
80     * @param args command-line arguments
81     * @throws Exception exception
82     */
83    public static void main(String[] args) throws Exception {
84      Log LOG = LogFactory.getLog("RESTServer");
85  
86      VersionInfo.logVersion();
87      FilterHolder authFilter = null;
88      Configuration conf = HBaseConfiguration.create();
89      Class<? extends ServletContainer> containerClass = ServletContainer.class;
90      UserProvider userProvider = UserProvider.instantiate(conf);
91      // login the server principal (if using secure Hadoop)
92      if (userProvider.isHadoopSecurityEnabled() && userProvider.isHBaseSecurityEnabled()) {
93        String machineName = Strings.domainNamePointerToHostName(
94          DNS.getDefaultHost(conf.get(REST_DNS_INTERFACE, "default"),
95            conf.get(REST_DNS_NAMESERVER, "default")));
96        String keytabFilename = conf.get(REST_KEYTAB_FILE);
97        Preconditions.checkArgument(keytabFilename != null && !keytabFilename.isEmpty(),
98          REST_KEYTAB_FILE + " should be set if security is enabled");
99        String principalConfig = conf.get(REST_KERBEROS_PRINCIPAL);
100       Preconditions.checkArgument(principalConfig != null && !principalConfig.isEmpty(),
101         REST_KERBEROS_PRINCIPAL + " should be set if security is enabled");
102       userProvider.login(REST_KEYTAB_FILE, REST_KERBEROS_PRINCIPAL, machineName);
103       if (conf.get(REST_AUTHENTICATION_TYPE) != null) {
104         containerClass = RESTServletContainer.class;
105         authFilter = new FilterHolder();
106         authFilter.setClassName(AuthFilter.class.getName());
107         authFilter.setName("AuthenticationFilter");
108       }
109     }
110 
111     UserGroupInformation realUser = userProvider.getCurrent().getUGI();
112     RESTServlet servlet = RESTServlet.getInstance(conf, realUser);
113 
114     Options options = new Options();
115     options.addOption("p", "port", true, "Port to bind to [default: 8080]");
116     options.addOption("ro", "readonly", false, "Respond only to GET HTTP " +
117       "method requests [default: false]");
118     options.addOption(null, "infoport", true, "Port for web UI");
119 
120     CommandLine commandLine = null;
121     try {
122       commandLine = new PosixParser().parse(options, args);
123     } catch (ParseException e) {
124       LOG.error("Could not parse: ", e);
125       printUsageAndExit(options, -1);
126     }
127 
128     // check for user-defined port setting, if so override the conf
129     if (commandLine != null && commandLine.hasOption("port")) {
130       String val = commandLine.getOptionValue("port");
131       servlet.getConfiguration()
132           .setInt("hbase.rest.port", Integer.valueOf(val));
133       LOG.debug("port set to " + val);
134     }
135 
136     // check if server should only process GET requests, if so override the conf
137     if (commandLine != null && commandLine.hasOption("readonly")) {
138       servlet.getConfiguration().setBoolean("hbase.rest.readonly", true);
139       LOG.debug("readonly set to true");
140     }
141 
142     // check for user-defined info server port setting, if so override the conf
143     if (commandLine != null && commandLine.hasOption("infoport")) {
144       String val = commandLine.getOptionValue("infoport");
145       servlet.getConfiguration()
146           .setInt("hbase.rest.info.port", Integer.valueOf(val));
147       LOG.debug("Web UI port set to " + val);
148     }
149 
150     @SuppressWarnings("unchecked")
151     List<String> remainingArgs = commandLine != null ?
152         commandLine.getArgList() : new ArrayList<String>();
153     if (remainingArgs.size() != 1) {
154       printUsageAndExit(options, 1);
155     }
156 
157     String command = remainingArgs.get(0);
158     if ("start".equals(command)) {
159       // continue and start container
160     } else if ("stop".equals(command)) {
161       System.exit(1);
162     } else {
163       printUsageAndExit(options, 1);
164     }
165 
166     // set up the Jersey servlet container for Jetty
167     ServletHolder sh = new ServletHolder(containerClass);
168     sh.setInitParameter(
169       "com.sun.jersey.config.property.resourceConfigClass",
170       ResourceConfig.class.getCanonicalName());
171     sh.setInitParameter("com.sun.jersey.config.property.packages",
172       "jetty");
173     // The servlet holder below is instantiated to only handle the case
174     // of the /status/cluster returning arrays of nodes (live/dead). Without
175     // this servlet holder, the problem is that the node arrays in the response
176     // are collapsed to single nodes. We want to be able to treat the
177     // node lists as POJO in the response to /status/cluster servlet call,
178     // but not change the behavior for any of the other servlets
179     // Hence we don't use the servlet holder for all servlets / paths
180     ServletHolder shPojoMap = new ServletHolder(containerClass);
181     @SuppressWarnings("unchecked")
182     Map<String, String> shInitMap = sh.getInitParameters();
183     for (Entry<String, String> e : shInitMap.entrySet()) {
184       shPojoMap.setInitParameter(e.getKey(), e.getValue());
185     }
186     shPojoMap.setInitParameter(JSONConfiguration.FEATURE_POJO_MAPPING, "true");
187 
188     // set up Jetty and run the embedded server
189 
190     Server server = new Server();
191 
192     Connector connector = new SelectChannelConnector();
193     if(conf.getBoolean(REST_SSL_ENABLED, false)) {
194       SslSelectChannelConnector sslConnector = new SslSelectChannelConnector();
195       String keystore = conf.get(REST_SSL_KEYSTORE_STORE);
196       String password = conf.get(REST_SSL_KEYSTORE_PASSWORD);
197       String keyPassword = conf.get(REST_SSL_KEYSTORE_KEYPASSWORD, password);
198       sslConnector.setKeystore(keystore);
199       sslConnector.setPassword(password);
200       sslConnector.setKeyPassword(keyPassword);
201       connector = sslConnector;
202     }
203     connector.setPort(servlet.getConfiguration().getInt("hbase.rest.port", 8080));
204     connector.setHost(servlet.getConfiguration().get("hbase.rest.host", "0.0.0.0"));
205 
206     server.addConnector(connector);
207 
208     // Set the default max thread number to 100 to limit
209     // the number of concurrent requests so that REST server doesn't OOM easily.
210     // Jetty set the default max thread number to 250, if we don't set it.
211     //
212     // Our default min thread number 2 is the same as that used by Jetty.
213     int maxThreads = servlet.getConfiguration().getInt("hbase.rest.threads.max", 100);
214     int minThreads = servlet.getConfiguration().getInt("hbase.rest.threads.min", 2);
215     QueuedThreadPool threadPool = new QueuedThreadPool(maxThreads);
216     threadPool.setMinThreads(minThreads);
217     server.setThreadPool(threadPool);
218 
219     server.setSendServerVersion(false);
220     server.setSendDateHeader(false);
221     server.setStopAtShutdown(true);
222       // set up context
223     Context context = new Context(server, "/", Context.SESSIONS);
224     context.addServlet(shPojoMap, "/status/cluster");
225     context.addServlet(sh, "/*");
226     if (authFilter != null) {
227       context.addFilter(authFilter, "/*", 1);
228     }
229 
230     // Load filters from configuration.
231     String[] filterClasses = servlet.getConfiguration().getStrings(FILTER_CLASSES,
232       ArrayUtils.EMPTY_STRING_ARRAY);
233     for (String filter : filterClasses) {
234       filter = filter.trim();
235       context.addFilter(Class.forName(filter), "/*", 0);
236     }
237     HttpServerUtil.constrainHttpMethods(context);
238 
239     // Put up info server.
240     int port = conf.getInt("hbase.rest.info.port", 8085);
241     if (port >= 0) {
242       conf.setLong("startcode", System.currentTimeMillis());
243       String a = conf.get("hbase.rest.info.bindAddress", "0.0.0.0");
244       InfoServer infoServer = new InfoServer("rest", a, port, false, conf);
245       infoServer.setAttribute("hbase.conf", conf);
246       infoServer.start();
247     }
248 
249     // start server
250     server.start();
251     server.join();
252   }
253 }