Module org.yamcs.api

Package org.yamcs.protobuf

Class AbstractFileTransferApi<T>

java.lang.Object

org.yamcs.protobuf.AbstractFileTransferApi<T>

All Implemented Interfaces:

Api<T>

Direct Known Subclasses:

FileTransferApiClient

@Generated(value="org.yamcs.maven.ServiceGenerator",
           date="2026-08-07T12:09:14.413966199Z")
public abstract class AbstractFileTransferApi<T>
extends Object
implements Api<T>

  This API deals with transmission (upload and download) of file to and from spacecraft.
 
  The API can be used to interface any implementation of the FileTransferService.
  One such implementation is for the CFDP (CCSDS File Delivery Protocol).
 

Constructor Summary

Constructors

Constructor	Description
AbstractFileTransferApi()

Method Summary

Modifier and Type	Method	Description
final void	callMethod(com.google.protobuf.Descriptors.MethodDescriptor method, T ctx, com.google.protobuf.Message request, Observer<com.google.protobuf.Message> future)
final Observer<com.google.protobuf.Message>	callMethod(com.google.protobuf.Descriptors.MethodDescriptor method, T ctx, Observer<com.google.protobuf.Message> future)
abstract void	cancelTransfer(T ctx, CancelTransferRequest request, Observer<com.google.protobuf.Empty> observer)	Cancel a transfer The ongoing transfer is aborted, partially uploaded/downloaded files are retained.
abstract void	createTransfer(T ctx, CreateTransferRequest request, Observer<TransferInfo> observer)	Create a transfer
abstract void	fetchFileList(T ctx, ListFilesRequest request, Observer<com.google.protobuf.Empty> observer)	Request file list from remote
final com.google.protobuf.Descriptors.ServiceDescriptor	getDescriptorForType()
abstract void	getFileList(T ctx, ListFilesRequest request, Observer<ListFilesResponse> observer)	Get latest file list
abstract void	getFileTransferService(T ctx, GetFileTransferServiceRequest request, Observer<FileTransferServiceInfo> observer)	Get a file transfer service
final com.google.protobuf.Message	getRequestPrototype(com.google.protobuf.Descriptors.MethodDescriptor method)
final com.google.protobuf.Message	getResponsePrototype(com.google.protobuf.Descriptors.MethodDescriptor method)
abstract void	getTransfer(T ctx, GetTransferRequest request, Observer<TransferInfo> observer)	Get a transfer
abstract void	listFileTransferServices(T ctx, ListFileTransferServicesRequest request, Observer<ListFileTransferServicesResponse> observer)	List file transfer services
abstract void	listTransfers(T ctx, ListTransfersRequest request, Observer<ListTransfersResponse> observer)	List transfers
abstract void	pauseTransfer(T ctx, PauseTransferRequest request, Observer<com.google.protobuf.Empty> observer)	Pause a transfer
abstract void	resumeTransfer(T ctx, ResumeTransferRequest request, Observer<com.google.protobuf.Empty> observer)	Resume a transfer
abstract void	runFileAction(T ctx, RunFileActionRequest request, Observer<com.google.protobuf.Struct> observer)	Run a file-specific action.
abstract void	subscribeRemoteFileList(T ctx, SubscribeTransfersRequest request, Observer<ListFilesResponse> observer)	Subscribe to remote file list updates
abstract void	subscribeTransfers(T ctx, SubscribeTransfersRequest request, Observer<TransferInfo> observer)	Subscribe to transfer updates

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

AbstractFileTransferApi

public AbstractFileTransferApi()

Method Details

listFileTransferServices

public abstract void listFileTransferServices(T ctx,
 ListFileTransferServicesRequest request,
 Observer<ListFileTransferServicesResponse> observer)

  List file transfer services
 

getFileTransferService

public abstract void getFileTransferService(T ctx,
 GetFileTransferServiceRequest request,
 Observer<FileTransferServiceInfo> observer)

  Get a file transfer service
 

listTransfers

public abstract void listTransfers(T ctx,
 ListTransfersRequest request,
 Observer<ListTransfersResponse> observer)

  List transfers
 

getTransfer

public abstract void getTransfer(T ctx,
 GetTransferRequest request,
 Observer<TransferInfo> observer)

  Get a transfer
 

createTransfer

public abstract void createTransfer(T ctx,
 CreateTransferRequest request,
 Observer<TransferInfo> observer)

  Create a transfer
 

pauseTransfer

public abstract void pauseTransfer(T ctx,
 PauseTransferRequest request,
 Observer<com.google.protobuf.Empty> observer)

  Pause a transfer
 

cancelTransfer

public abstract void cancelTransfer(T ctx,
 CancelTransferRequest request,
 Observer<com.google.protobuf.Empty> observer)

  Cancel a transfer
 
  The ongoing transfer is aborted, partially uploaded/downloaded files
  are retained.
 

resumeTransfer

public abstract void resumeTransfer(T ctx,
 ResumeTransferRequest request,
 Observer<com.google.protobuf.Empty> observer)

  Resume a transfer
 

subscribeTransfers

public abstract void subscribeTransfers(T ctx,
 SubscribeTransfersRequest request,
 Observer<TransferInfo> observer)

  Subscribe to transfer updates
 

subscribeRemoteFileList

public abstract void subscribeRemoteFileList(T ctx,
 SubscribeTransfersRequest request,
 Observer<ListFilesResponse> observer)

  Subscribe to remote file list updates
 

fetchFileList

public abstract void fetchFileList(T ctx,
 ListFilesRequest request,
 Observer<com.google.protobuf.Empty> observer)

  Request file list from remote
 

getFileList

public abstract void getFileList(T ctx,
 ListFilesRequest request,
 Observer<ListFilesResponse> observer)

  Get latest file list
 

runFileAction

public abstract void runFileAction(T ctx,
 RunFileActionRequest request,
 Observer<com.google.protobuf.Struct> observer)

  Run a file-specific action.
 
  Available actions are specific to the File Transfer implementation.
 

getDescriptorForType

public final com.google.protobuf.Descriptors.ServiceDescriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface Api<T>

getRequestPrototype

public final com.google.protobuf.Message getRequestPrototype(com.google.protobuf.Descriptors.MethodDescriptor method)

Specified by:

getRequestPrototype in interface Api<T>

getResponsePrototype

public final com.google.protobuf.Message getResponsePrototype(com.google.protobuf.Descriptors.MethodDescriptor method)

Specified by:

getResponsePrototype in interface Api<T>

callMethod

public final void callMethod(com.google.protobuf.Descriptors.MethodDescriptor method,
 T ctx,
 com.google.protobuf.Message request,
 Observer<com.google.protobuf.Message> future)

Specified by:

callMethod in interface Api<T>

callMethod

public final Observer<com.google.protobuf.Message> callMethod(com.google.protobuf.Descriptors.MethodDescriptor method,
 T ctx,
 Observer<com.google.protobuf.Message> future)

Specified by:

callMethod in interface Api<T>