org.voltdb.utils.VoltBaseServlet Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of voltdb Show documentation
VoltDB server libraries
There is a newer version: 10.1.1
/* This file is part of VoltDB.
 * Copyright (C) 2008-2018 VoltDB Inc.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with VoltDB.  If not, see .
 */

package org.voltdb.utils;

import static org.voltdb.utils.HTTPAdminListener.HTML_CONTENT_TYPE;

import java.io.IOException;
import java.net.InetAddress;
import java.util.concurrent.TimeUnit;

import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.json_voltpatches.JSONArray;
import org.json_voltpatches.JSONObject;
import org.voltcore.logging.Level;
import org.voltcore.logging.VoltLogger;
import org.voltcore.utils.EstTime;
import org.voltcore.utils.RateLimitedLogger;
import org.voltdb.AuthenticationResult;
import org.voltdb.ClientResponseImpl;
import org.voltdb.HTTPClientInterface;
import org.voltdb.VoltDB;
import org.voltdb.VoltTable;
import org.voltdb.compilereport.ReportMaker;

/**
 *
 * Base servlet to keep common functionality currently adding Host header is done here.
 * HOST header is used by VMC to make API request to configured external interface via HTTP.
 */
public class VoltBaseServlet extends HttpServlet {

    private static final long serialVersionUID = -7435813850243095149L;
    protected VoltLogger m_log = new VoltLogger("HOST");
    private String m_hostHeader = null;
    protected HTTPAdminListener httpAdminListener = VoltDB.instance().getHttpAdminListener();
    protected HTTPClientInterface httpClientInterface = httpAdminListener.httpClientInterface;

    protected String buildClientResponse(String jsonp, byte code, String msg) {
        ClientResponseImpl rimpl = new ClientResponseImpl(code, new VoltTable[0], msg);
        return HTTPClientInterface.asJsonp(jsonp, rimpl.toJSONString());
    }

    //This method is used by every request to put Host: header so that VMC can go back to original server
    //for requests kinda like LB and also used for cases when you are in AWS and public interface is different than internal IPs
    //like behind a NATed network.
    protected String getHostHeader() {
        if (m_hostHeader != null) {
            return m_hostHeader;
        }

        if (!httpAdminListener.m_publicIntf.isEmpty()) {
            m_hostHeader = httpAdminListener.m_publicIntf;
            return m_hostHeader;
        }

        InetAddress addr = null;
        int httpPort = VoltDB.DEFAULT_HTTP_PORT;
        try {
            String localMetadata = VoltDB.instance().getLocalMetadata();
            JSONObject jsObj = new JSONObject(localMetadata);
            JSONArray interfaces = jsObj.getJSONArray("interfaces");
            //The first interface is external interface if specified.
            String iface = interfaces.getString(0);
            addr = InetAddress.getByName(iface);
            httpPort = jsObj.getInt("httpPort");
        } catch (Exception e) {
            m_log.warn("Failed to get HTTP interface information.", e);
        }
        if (addr == null) {
            addr = org.voltcore.utils.CoreUtils.getLocalAddress();
        }
        //Make the header string.
        m_hostHeader = addr.getHostAddress() + ":" + httpPort;
        return m_hostHeader;
    }

    public AuthenticationResult authenticate(HttpServletRequest request) {
        return httpClientInterface.authenticate(request);
    }

    public void unauthenticate(HttpServletRequest request) {
        httpClientInterface.unauthenticate(request);
    }

    @Override
    public void doPost(HttpServletRequest request, HttpServletResponse response)
            throws IOException, ServletException {
        doGet(request, response);
    }

    @Override
    protected void doGet( HttpServletRequest request, HttpServletResponse response ) throws ServletException, IOException {
        response.setHeader("Host", getHostHeader());
    }

    /**
     * Draw the catalog report page, mostly by pulling it from the JAR.
     */
    void handleReportPage(HttpServletRequest request, HttpServletResponse response) {
        try {
            String report = ReportMaker.liveReport();

            response.setContentType(HTML_CONTENT_TYPE);
            response.setStatus(HttpServletResponse.SC_OK);

            response.getWriter().print(report);
        } catch (IOException ex) {
            m_log.warn("Failed to get catalog report.", ex);
        }
    }

    public void rateLimitedLogWarn(String format, Object... parameters) {
        //Rate limited every 60 seconds.
        RateLimitedLogger.tryLogForMessage(EstTime.currentTimeMillis(), 60, TimeUnit.SECONDS, m_log, Level.WARN, null, format, parameters);
    }


}