org.opentcs.kernel.extensions.adminwebapi.AdminWebApi Maven / Gradle / Ivy

Go to download
/**
 * Copyright (c) The openTCS Authors.
 *
 * This program is free software and subject to the MIT license. (For details,
 * see the licensing information (LICENSE.txt) you should have received with
 * this copy of the software.)
 */
package org.opentcs.kernel.extensions.adminwebapi;

import static java.util.Objects.requireNonNull;

import jakarta.inject.Inject;
import org.opentcs.components.kernel.KernelExtension;
import org.opentcs.kernel.extensions.adminwebapi.v1.V1RequestHandler;
import org.opentcs.kernel.extensions.servicewebapi.HttpConstants;
import spark.Service;

/**
 * Provides an HTTP interface for basic administration needs.
 */
public class AdminWebApi
    implements
      KernelExtension {

  /**
   * The interface configuration.
   */
  private final AdminWebApiConfiguration configuration;
  /**
   * Handles requests for API version 1.
   */
  private final V1RequestHandler v1RequestHandler;
  /**
   * The actual HTTP service.
   */
  private Service service;
  /**
   * Whether this kernel extension is initialized.
   */
  private boolean initialized;

  /**
   * Creates a new instance.
   *
   * @param configuration The interface configuration.
   * @param v1RequestHandler Handles requests for API version 1.
   */
  @Inject
  public AdminWebApi(
      AdminWebApiConfiguration configuration,
      V1RequestHandler v1RequestHandler
  ) {
    this.configuration = requireNonNull(configuration, "configuration");
    this.v1RequestHandler = requireNonNull(v1RequestHandler, "v1RequestHandler");
  }

  @Override
  public void initialize() {
    if (isInitialized()) {
      return;
    }

    service = Service.ignite()
        .ipAddress(configuration.bindAddress())
        .port(configuration.bindPort());

    service.path("/v1", () -> {
      service.get("/version", v1RequestHandler::handleGetVersion);
      service.get("/status", v1RequestHandler::handleGetStatus);
      service.delete("/kernel", v1RequestHandler::handleDeleteKernel);
    }
    );
    service.exception(IllegalArgumentException.class, (exception, request, response) -> {
      response.status(400);
      response.type(HttpConstants.CONTENT_TYPE_TEXT_PLAIN_UTF8);
      response.body(exception.getMessage());
    });
    service.exception(IllegalStateException.class, (exception, request, response) -> {
      response.status(500);
      response.type(HttpConstants.CONTENT_TYPE_TEXT_PLAIN_UTF8);
      response.body(exception.getMessage());
    });

    initialized = true;
  }

  @Override
  public void terminate() {
    if (!isInitialized()) {
      return;
    }

    service.stop();

    initialized = false;
  }

  @Override
  public boolean isInitialized() {
    return initialized;
  }

}