org.opentcs.kernel.services.StandardPeripheralJobService Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of opentcs-kernel Show documentation
opentcs-kernel
There is a newer version: 6.1.2
// SPDX-FileCopyrightText: The openTCS Authors
// SPDX-License-Identifier: MIT
package org.opentcs.kernel.services;

import static java.util.Objects.requireNonNull;

import jakarta.inject.Inject;
import org.opentcs.access.KernelRuntimeException;
import org.opentcs.access.to.peripherals.PeripheralJobCreationTO;
import org.opentcs.components.kernel.services.InternalPeripheralJobService;
import org.opentcs.components.kernel.services.PeripheralJobService;
import org.opentcs.components.kernel.services.TCSObjectService;
import org.opentcs.customizations.kernel.GlobalSyncObject;
import org.opentcs.data.ObjectExistsException;
import org.opentcs.data.ObjectUnknownException;
import org.opentcs.data.TCSObjectReference;
import org.opentcs.data.peripherals.PeripheralJob;
import org.opentcs.kernel.workingset.PeripheralJobPoolManager;

/**
 * This class is the standard implementation of the {@link PeripheralJobService} interface.
 */
public class StandardPeripheralJobService
    extends
      AbstractTCSObjectService
    implements
      InternalPeripheralJobService {

  /**
   * A global object to be used for synchronization within the kernel.
   */
  private final Object globalSyncObject;
  /**
   * The job pool manager.
   */
  private final PeripheralJobPoolManager jobPoolManager;

  /**
   * Creates a new instance.
   *
   * @param objectService The tcs obejct service.
   * @param globalSyncObject The kernel threads' global synchronization object.
   * @param jobPoolManager The job pool manager to be used.
   */
  @Inject
  public StandardPeripheralJobService(
      TCSObjectService objectService,
      @GlobalSyncObject
      Object globalSyncObject,
      PeripheralJobPoolManager jobPoolManager
  ) {
    super(objectService);
    this.globalSyncObject = requireNonNull(globalSyncObject, "globalSyncObject");
    this.jobPoolManager = requireNonNull(jobPoolManager, "jobPoolManager");
  }

  @Override
  public void updatePeripheralJobState(
      TCSObjectReference ref,
      PeripheralJob.State state
  )
      throws ObjectUnknownException {
    requireNonNull(ref, "ref");
    requireNonNull(state, "state");

    synchronized (globalSyncObject) {
      jobPoolManager.setPeripheralJobState(ref, state);
    }
  }

  @Override
  public PeripheralJob createPeripheralJob(PeripheralJobCreationTO to)
      throws ObjectUnknownException,
        ObjectExistsException,
        KernelRuntimeException {
    requireNonNull(to, "to");

    synchronized (globalSyncObject) {
      return jobPoolManager.createPeripheralJob(to);
    }
  }
}