org.openqa.grid.web.servlet.RegistrationServlet Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of selenium-server Show documentation
Show all versions of selenium-server Show documentation
Selenium automates browsers. That's it! What you do with that power is entirely up to you.
// 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.common.collect.Lists;
import com.google.common.io.CharStreams;
import com.google.gson.JsonArray;
import com.google.gson.JsonElement;
import com.google.gson.JsonObject;
import com.google.gson.JsonParser;
import org.openqa.grid.common.RegistrationRequest;
import org.openqa.grid.common.exception.GridConfigurationException;
import org.openqa.grid.internal.BaseRemoteProxy;
import org.openqa.grid.internal.GridRegistry;
import org.openqa.grid.internal.RemoteProxy;
import org.openqa.grid.internal.utils.configuration.GridNodeConfiguration;
import org.openqa.selenium.MutableCapabilities;
import org.openqa.selenium.json.Json;
import org.openqa.selenium.remote.DesiredCapabilities;
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.util.logging.Logger;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
/**
* entry point for the registration API the grid provides. The {@link RegistrationRequest} sent to
* http://hub:port/grid/register will be used to create a RemoteProxy and add it to the grid.
*/
public class RegistrationServlet extends RegistryBasedServlet {
private static final long serialVersionUID = -8670670577712086527L;
private static final Logger log = Logger.getLogger(RegistrationServlet.class.getName());
public RegistrationServlet() {
this(null);
}
public RegistrationServlet(GridRegistry registry) {
super(registry);
}
@Override
protected void doGet(HttpServletRequest request, HttpServletResponse response)
throws ServletException, IOException {
process(request, response);
}
@Override
protected void doPost(HttpServletRequest request, HttpServletResponse response)
throws ServletException, IOException {
process(request, response);
}
protected void process(HttpServletRequest request, HttpServletResponse response)
throws IOException {
String requestJsonString;
try (BufferedReader rd = new BufferedReader(new InputStreamReader(request.getInputStream()))) {
requestJsonString = CharStreams.toString(rd);
}
log.fine("getting the following registration request : " + requestJsonString);
// getting the settings from the registration
JsonObject json = new JsonParser().parse(requestJsonString).getAsJsonObject();
if (!json.has("configuration")) {
// bad request. there must be a configuration for the proxy
throw new GridConfigurationException("No configuration received for proxy.");
}
final RegistrationRequest registrationRequest;
if (isV2RegistrationRequestJson(json)) {
// Se2 compatible request
GridNodeConfiguration nodeConfiguration =
mapV2Configuration(json.getAsJsonObject("configuration"));
registrationRequest = new RegistrationRequest(nodeConfiguration);
// get the "capabilities" and "id" from the v2 json request
considerV2Json(registrationRequest.getConfiguration(), json);
} else {
// Se3 compatible request.
registrationRequest = RegistrationRequest.fromJson(json);
}
final RemoteProxy proxy = BaseRemoteProxy.getNewInstance(registrationRequest, getRegistry());
reply(response, "ok");
new Thread(new Runnable() { // Thread safety reviewed
public void run() {
getRegistry().add(proxy);
log.fine("proxy added " + proxy.getRemoteHost());
}
}).start();
}
/**
* @deprecated because V3 node configuration data structure is internally different than V2.
* That said V2 nodes do need to be able to register with a V3 hub.
*/
@Deprecated
private GridNodeConfiguration mapV2Configuration(JsonObject json) {
// servlets should result in a parse error since the type changed from String to
// List with V3. So, we need to save it off and then parse normally.
JsonElement servlets = json.has("servlets") ? json.get("servlets") : null;
// V3 beta versions send a V2 RegistrationRequest which specifies servlets as a List
// When this is the case, we don't need to remove it for parsing.
if (servlets != null && servlets.isJsonPrimitive()) {
json.remove("servlets");
}
// if a JsonSyntaxException happens here, so be it. We won't be able to map the request
// to a grid node configuration anyhow.
GridNodeConfiguration pendingConfiguration = GridNodeConfiguration.loadFromJSON(json);
// add the servlets that were saved off
if (servlets != null && servlets.isJsonPrimitive() &&
(pendingConfiguration.servlets == null || pendingConfiguration.servlets.isEmpty())) {
pendingConfiguration.servlets = Lists.newArrayList(servlets.getAsString().split(","));
}
return pendingConfiguration;
}
/**
* @deprecated because V3 does not have separate "capabilities": { } object in the serialized json
* representation of the RegistrationRequest. That said V2 nodes do need to be able to register
* with a V3 hub.
*/
@Deprecated
private boolean isV2RegistrationRequestJson(JsonObject json) {
return json.has("capabilities") && json.has("configuration");
}
/**
* @deprecated because V3 does not have separate "capabilities": { } object and "id": "value"
* in the serialized json representation of the RegistrationRequest. That said V2 nodes do need
* to be able to register with a V3 hub.
*/
@Deprecated
private void considerV2Json(GridNodeConfiguration configuration, JsonObject json) {
// Backwards compatible with Selenium 2.x remotes which might send a
// registration request with the json field "id". 3.x remotes will include the "id" with the
// "configuration" object. The presence of { "id": "value" } should always override
// { "configuration": { "id": "value" } }
if (json.has("id")) {
configuration.id = json.get("id").getAsString();
}
// Backwards compatible with Selenium 2.x remotes which send a registration request with the
// json object "capabilities". 3.x remotes will include the "capabilities" object with the
// "configuration" object. The presence of { "capabilities": [ {...}, {...} ] } should always
// override { "configuration": { "capabilities": [ {...}, {...} ] } }
if (json.has("capabilities")) {
configuration.capabilities.clear();
JsonArray capabilities = json.get("capabilities").getAsJsonArray();
Json converter = new Json();
for (int i = 0; i < capabilities.size(); i++) {
MutableCapabilities cap = converter.toType(capabilities.get(i), DesiredCapabilities.class);
configuration.capabilities.add(cap);
}
configuration.fixUpCapabilities();
}
}
protected void reply(HttpServletResponse response, String content) throws IOException {
response.setContentType("text/html");
response.setCharacterEncoding("UTF-8");
response.setStatus(200);
response.getWriter().print(content);
}
}