org.apache.hadoop.hdfs.server.namenode.NameNodeHttpServer.java Source code

Java tutorial

Introduction

Here is the source code for org.apache.hadoop.hdfs.server.namenode.NameNodeHttpServer.java

Source

/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.hadoop.hdfs.server.namenode;

import static org.apache.hadoop.hdfs.DFSConfigKeys.DFS_ADMIN;
import static org.apache.hadoop.hdfs.DFSConfigKeys.DFS_DATANODE_HTTPS_ADDRESS_KEY;
import static org.apache.hadoop.hdfs.DFSConfigKeys.DFS_SERVER_HTTPS_KEYSTORE_RESOURCE_KEY;
import static org.apache.hadoop.hdfs.DFSConfigKeys.DFS_SERVER_HTTPS_KEYSTORE_RESOURCE_DEFAULT;

import java.io.IOException;
import java.net.InetSocketAddress;
import java.security.PrivilegedExceptionAction;
import java.util.HashMap;
import java.util.Map;

import javax.servlet.ServletContext;

import org.apache.commons.logging.Log;
import org.apache.hadoop.classification.InterfaceAudience;
import org.apache.hadoop.conf.Configuration;
import org.apache.hadoop.hdfs.DFSConfigKeys;
import org.apache.hadoop.hdfs.HdfsConfiguration;
import org.apache.hadoop.hdfs.server.common.JspHelper;
import org.apache.hadoop.hdfs.server.namenode.web.resources.NamenodeWebHdfsMethods;
import org.apache.hadoop.hdfs.web.AuthFilter;
import org.apache.hadoop.hdfs.web.WebHdfsFileSystem;
import org.apache.hadoop.hdfs.web.resources.Param;
import org.apache.hadoop.http.HttpServer;
import org.apache.hadoop.net.NetUtils;
import org.apache.hadoop.security.SecurityUtil;
import org.apache.hadoop.security.UserGroupInformation;
import org.apache.hadoop.security.authorize.AccessControlList;

/**
 * Encapsulates the HTTP server started by the NameNode. 
 */
@InterfaceAudience.Private
public class NameNodeHttpServer {
    private HttpServer httpServer;
    private final Configuration conf;
    private final NameNode nn;

    private final Log LOG = NameNode.LOG;
    private InetSocketAddress httpAddress;

    private InetSocketAddress bindAddress;

    public static final String NAMENODE_ADDRESS_ATTRIBUTE_KEY = "name.node.address";
    public static final String FSIMAGE_ATTRIBUTE_KEY = "name.system.image";
    protected static final String NAMENODE_ATTRIBUTE_KEY = "name.node";

    public NameNodeHttpServer(Configuration conf, NameNode nn, InetSocketAddress bindAddress) {
        this.conf = conf;
        this.nn = nn;
        this.bindAddress = bindAddress;
    }

    private String getDefaultServerPrincipal() throws IOException {
        return SecurityUtil.getServerPrincipal(conf.get(DFSConfigKeys.DFS_NAMENODE_USER_NAME_KEY),
                nn.getNameNodeAddress().getHostName());
    }

    public void start() throws IOException {
        final String infoHost = bindAddress.getHostName();
        int infoPort = bindAddress.getPort();

        httpServer = new HttpServer("hdfs", infoHost, infoPort, infoPort == 0, conf,
                new AccessControlList(conf.get(DFS_ADMIN, " "))) {
            {
                // Add SPNEGO support to NameNode
                if (UserGroupInformation.isSecurityEnabled()) {
                    initSpnego(conf, DFSConfigKeys.DFS_NAMENODE_INTERNAL_SPNEGO_USER_NAME_KEY,
                            DFSConfigKeys.DFS_NAMENODE_KEYTAB_FILE_KEY);
                }
                if (WebHdfsFileSystem.isEnabled(conf, LOG)) {
                    //add SPNEGO authentication filter for webhdfs
                    final String name = "SPNEGO";
                    final String classname = AuthFilter.class.getName();
                    final String pathSpec = WebHdfsFileSystem.PATH_PREFIX + "/*";
                    Map<String, String> params = getAuthFilterParams(conf);
                    defineFilter(webAppContext, name, classname, params, new String[] { pathSpec });
                    LOG.info("Added filter '" + name + "' (class=" + classname + ")");

                    // add webhdfs packages
                    addJerseyResourcePackage(NamenodeWebHdfsMethods.class.getPackage().getName() + ";"
                            + Param.class.getPackage().getName(), pathSpec);
                }
            }

            private Map<String, String> getAuthFilterParams(Configuration conf) throws IOException {
                Map<String, String> params = new HashMap<String, String>();
                String principalInConf = conf.get(DFSConfigKeys.DFS_WEB_AUTHENTICATION_KERBEROS_PRINCIPAL_KEY);
                if (principalInConf != null && !principalInConf.isEmpty()) {
                    params.put(DFSConfigKeys.DFS_WEB_AUTHENTICATION_KERBEROS_PRINCIPAL_KEY,
                            SecurityUtil.getServerPrincipal(principalInConf, bindAddress.getHostName()));
                }
                String httpKeytab = conf.get(DFSConfigKeys.DFS_WEB_AUTHENTICATION_KERBEROS_KEYTAB_KEY);
                if (httpKeytab != null && !httpKeytab.isEmpty()) {
                    params.put(DFSConfigKeys.DFS_WEB_AUTHENTICATION_KERBEROS_KEYTAB_KEY, httpKeytab);
                }
                return params;
            }
        };

        boolean certSSL = conf.getBoolean("dfs.https.enable", false);
        if (certSSL) {
            boolean needClientAuth = conf.getBoolean("dfs.https.need.client.auth", false);
            InetSocketAddress secInfoSocAddr = NetUtils
                    .createSocketAddr(infoHost + ":" + conf.get("dfs.https.port", infoHost + ":" + 0));
            Configuration sslConf = new Configuration(false);
            if (certSSL) {
                sslConf.addResource(conf.get("dfs.https.server.keystore.resource", "ssl-server.xml"));
            }
            httpServer.addSslListener(secInfoSocAddr, sslConf, needClientAuth);
            // assume same ssl port for all datanodes
            InetSocketAddress datanodeSslPort = NetUtils
                    .createSocketAddr(conf.get("dfs.datanode.https.address", infoHost + ":" + 50475));
            httpServer.setAttribute("datanode.https.port", datanodeSslPort.getPort());
        }
        httpServer.setAttribute(NAMENODE_ATTRIBUTE_KEY, nn);
        httpServer.setAttribute(NAMENODE_ADDRESS_ATTRIBUTE_KEY, nn.getNameNodeAddress());
        httpServer.setAttribute(FSIMAGE_ATTRIBUTE_KEY, nn.getFSImage());
        httpServer.setAttribute(JspHelper.CURRENT_CONF, conf);
        setupServlets(httpServer, conf);
        httpServer.start();
        httpAddress = new InetSocketAddress(bindAddress.getAddress(), httpServer.getPort());
    }

    public void stop() throws Exception {
        if (httpServer != null) {
            httpServer.stop();
        }
    }

    public InetSocketAddress getHttpAddress() {
        return httpAddress;
    }

    private static void setupServlets(HttpServer httpServer, Configuration conf) {
        httpServer.addInternalServlet("getDelegationToken", GetDelegationTokenServlet.PATH_SPEC,
                GetDelegationTokenServlet.class, true);
        httpServer.addInternalServlet("renewDelegationToken", RenewDelegationTokenServlet.PATH_SPEC,
                RenewDelegationTokenServlet.class, true);
        httpServer.addInternalServlet("cancelDelegationToken", CancelDelegationTokenServlet.PATH_SPEC,
                CancelDelegationTokenServlet.class, true);
        httpServer.addInternalServlet("fsck", "/fsck", FsckServlet.class, true);
        httpServer.addInternalServlet("getimage", "/getimage", GetImageServlet.class, true);
        httpServer.addInternalServlet("listPaths", "/listPaths/*", ListPathsServlet.class, false);
        httpServer.addInternalServlet("data", "/data/*", FileDataServlet.class, false);
        httpServer.addInternalServlet("checksum", "/fileChecksum/*", FileChecksumServlets.RedirectServlet.class,
                false);
        httpServer.addInternalServlet("contentSummary", "/contentSummary/*", ContentSummaryServlet.class, false);
    }

    public static FSImage getFsImageFromContext(ServletContext context) {
        return (FSImage) context.getAttribute(FSIMAGE_ATTRIBUTE_KEY);
    }

    public static NameNode getNameNodeFromContext(ServletContext context) {
        return (NameNode) context.getAttribute(NAMENODE_ATTRIBUTE_KEY);
    }

    public static Configuration getConfFromContext(ServletContext context) {
        return (Configuration) context.getAttribute(JspHelper.CURRENT_CONF);
    }

    public static InetSocketAddress getNameNodeAddressFromContext(ServletContext context) {
        return (InetSocketAddress) context.getAttribute(NAMENODE_ADDRESS_ATTRIBUTE_KEY);
    }
}