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