org.opentcs.kernel.extensions.servicewebapi.v1.PathHandler 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.servicewebapi.v1;

import static java.util.Objects.requireNonNull;

import jakarta.annotation.Nonnull;
import jakarta.inject.Inject;
import org.opentcs.components.kernel.services.PlantModelService;
import org.opentcs.components.kernel.services.TCSObjectService;
import org.opentcs.data.ObjectUnknownException;
import org.opentcs.data.model.Path;
import org.opentcs.kernel.extensions.servicewebapi.KernelExecutorWrapper;

/**
 * Handles requests related to paths.
 */
public class PathHandler {

  private final TCSObjectService objectService;
  private final KernelExecutorWrapper executorWrapper;
  private final PlantModelService plantModelService;

  /**
   * Creates a new instance.
   *
   * @param objectService Used to retrieve path instances.
   * @param plantModelService Used to update path locks.
   * @param executorWrapper Executes calls via the kernel executor and waits for the outcome.
   */
  @Inject
  public PathHandler(
      TCSObjectService objectService,
      KernelExecutorWrapper executorWrapper,
      PlantModelService plantModelService
  ) {
    this.objectService = requireNonNull(objectService, "objectService");
    this.executorWrapper = requireNonNull(executorWrapper, "executorWrapper");
    this.plantModelService = requireNonNull(plantModelService, "plantModelService");
  }

  /**
   * Updates the locked state of the path with the given name.
   *
   * @param pathName The name of the path to update.
   * @param lockedValue The path's new locked state (a boolean as a string).
   * @throws ObjectUnknownException If a path with the given name could not be found.
   */
  public void updatePathLock(
      @Nonnull
      String pathName,
      String lockedValue
  )
      throws ObjectUnknownException {
    executorWrapper.callAndWait(() -> {
      Path path = objectService.fetchObject(Path.class, pathName);
      if (path == null) {
        throw new ObjectUnknownException("Unknown path: " + pathName);
      }
      plantModelService.updatePathLock(path.getReference(), Boolean.parseBoolean(lockedValue));
    });
  }
}