org.openqa.grid.web.servlet.HubStatusServlet.java Source code

Introduction

Here is the source code for org.openqa.grid.web.servlet.HubStatusServlet.java

Source

// Licensed to the Software Freedom Conservancy (SFC) under one
// or more contributor license agreements.  See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership.  The SFC 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.openqa.grid.web.servlet;

import com.google.gson.Gson;
import com.google.gson.JsonElement;
import com.google.gson.JsonObject;
import com.google.gson.JsonParser;
import com.google.gson.JsonSyntaxException;

import org.openqa.grid.common.exception.GridException;
import org.openqa.grid.internal.Registry;
import org.openqa.grid.internal.RemoteProxy;
import org.openqa.grid.internal.TestSlot;

import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import java.util.Map;

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

/**
 * API to query the hub config remotely.
 *
 * use the API by sending a GET to grid/api/hub/
 * with the content of the request in JSON,specifying the
 * parameters you're interesting in, for instance, to get
 * the timeout of the hub and the registered servlets :
 *
 * {"configuration":
 *      [
 *      "timeout",
 *      "servlets"
 *      ]
 * }
 *
 * alternatively you can use a query string ?configuration=timeout,servlets
 *
 * if no param is specified, all params known to the hub are returned.
 *
 */
public class HubStatusServlet extends RegistryBasedServlet {

    public HubStatusServlet() {
        super(null);
    }

    public HubStatusServlet(Registry registry) {
        super(registry);
    }

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

    protected void process(HttpServletRequest request, HttpServletResponse response) throws IOException {
        response.setContentType("application/json");
        response.setCharacterEncoding("UTF-8");
        response.setStatus(200);
        JsonObject res;
        try {
            res = getResponse(request);
            response.getWriter().print(res);
            response.getWriter().close();
        } catch (JsonSyntaxException e) {
            throw new GridException(e.getMessage());
        }

    }

    private JsonObject getResponse(HttpServletRequest request) throws IOException {
        JsonObject res = new JsonObject();
        res.addProperty("success", true);
        try {
            if (request.getInputStream() != null) {
                JsonObject requestJSON = getRequestJSON(request);
                List<String> keysToReturn = null;

                if (request.getParameter("configuration") != null
                        && !"".equals(request.getParameter("configuration"))) {
                    keysToReturn = Arrays.asList(request.getParameter("configuration").split(","));
                } else if (requestJSON != null && requestJSON.has("configuration")) {
                    keysToReturn = new Gson().fromJson(requestJSON.getAsJsonArray("configuration"),
                            ArrayList.class);
                }

                Registry registry = getRegistry();
                JsonElement config = registry.getConfiguration().toJson();
                for (Map.Entry<String, JsonElement> entry : config.getAsJsonObject().entrySet()) {
                    if (keysToReturn == null || keysToReturn.isEmpty() || keysToReturn.contains(entry.getKey())) {
                        res.add(entry.getKey(), entry.getValue());
                    }
                }
                if (keysToReturn == null || keysToReturn.isEmpty()
                        || keysToReturn.contains("newSessionRequestCount")) {
                    res.addProperty("newSessionRequestCount", registry.getNewSessionRequestCount());
                }

                if (keysToReturn == null || keysToReturn.isEmpty() || keysToReturn.contains("slotCounts")) {
                    res.add("slotCounts", getSlotCounts());
                }
            }
        } catch (Exception e) {
            res.remove("success");
            res.addProperty("success", false);
            res.addProperty("msg", e.getMessage());
        }
        return res;

    }

    private JsonObject getSlotCounts() {
        int freeSlots = 0;
        int totalSlots = 0;

        for (RemoteProxy proxy : getRegistry().getAllProxies()) {
            for (TestSlot slot : proxy.getTestSlots()) {
                if (slot.getSession() == null) {
                    freeSlots += 1;
                }

                totalSlots += 1;
            }
        }

        JsonObject result = new JsonObject();

        result.addProperty("free", freeSlots);
        result.addProperty("total", totalSlots);

        return result;
    }

    private JsonObject getRequestJSON(HttpServletRequest request) throws IOException {
        JsonObject requestJSON = null;
        BufferedReader rd = new BufferedReader(new InputStreamReader(request.getInputStream()));
        StringBuilder s = new StringBuilder();
        String line;
        while ((line = rd.readLine()) != null) {
            s.append(line);
        }
        rd.close();
        String json = s.toString();
        if (!"".equals(json)) {
            requestJSON = new JsonParser().parse(json).getAsJsonObject();
        }
        return requestJSON;
    }
}