org.opentcs.access.rmi.services.RemotePeripheralService Maven / Gradle / Ivy

Go to download
// SPDX-FileCopyrightText: The openTCS Authors
// SPDX-License-Identifier: MIT
package org.opentcs.access.rmi.services;

import java.rmi.Remote;
import java.rmi.RemoteException;
import org.opentcs.access.rmi.ClientID;
import org.opentcs.components.kernel.services.PeripheralService;
import org.opentcs.data.model.Location;
import org.opentcs.data.model.TCSResourceReference;
import org.opentcs.drivers.peripherals.PeripheralAdapterCommand;
import org.opentcs.drivers.peripherals.PeripheralCommAdapterDescription;
import org.opentcs.drivers.peripherals.PeripheralProcessModel;
import org.opentcs.drivers.peripherals.management.PeripheralAttachmentInformation;

/**
 * Declares the methods provided by the {@link PeripheralService} via RMI.
 *
 * 
 * The majority of the methods declared here have signatures analogous to their counterparts in
 * {@link PeripheralService}, with an additional {@link ClientID} parameter which serves the purpose
 * of identifying the calling client and determining its permissions.
 * 
 * 
 * To avoid redundancy, the semantics of methods that only pass through their arguments are not
 * explicitly documented here again. See the corresponding API documentation in
 * {@link PeripheralService} for these, instead.
 * 
 */
public interface RemotePeripheralService
    extends
      RemoteTCSObjectService,
      Remote {

  // CHECKSTYLE:OFF
  void attachCommAdapter(
      ClientID clientId,
      TCSResourceReference ref,
      PeripheralCommAdapterDescription description
  )
      throws RemoteException;

  void disableCommAdapter(ClientID clientId, TCSResourceReference ref)
      throws RemoteException;

  void enableCommAdapter(ClientID clientId, TCSResourceReference ref)
      throws RemoteException;

  PeripheralAttachmentInformation fetchAttachmentInformation(
      ClientID clientId,
      TCSResourceReference ref
  )
      throws RemoteException;

  PeripheralProcessModel fetchProcessModel(ClientID clientId, TCSResourceReference ref)
      throws RemoteException;

  void sendCommAdapterCommand(
      ClientID clientId,
      TCSResourceReference ref,
      PeripheralAdapterCommand command
  )
      throws RemoteException;
  // CHECKSTYLE:ON
}