Package org.yamcs.http.api

Class FileTransferApi

java.lang.Object

org.yamcs.protobuf.AbstractFileTransferApi<Context>

org.yamcs.http.api.FileTransferApi

All Implemented Interfaces:

Api<Context>

public class FileTransferApi
extends AbstractFileTransferApi<Context>

Constructor Summary

Constructors

Constructor	Description
FileTransferApi()

Method Summary

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

Methods inherited from class org.yamcs.protobuf.AbstractFileTransferApi

callMethod, callMethod, getDescriptorForType, getRequestPrototype, getResponsePrototype

Methods inherited from class java.lang.Object

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

Constructor Details

FileTransferApi

public FileTransferApi()

Method Details

listFileTransferServices

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

Description copied from class: AbstractFileTransferApi

  List file transfer services
 

Specified by:

listFileTransferServices in class AbstractFileTransferApi<Context>

getFileTransferService

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

Description copied from class: AbstractFileTransferApi

  Get a file transfer service
 

Specified by:

getFileTransferService in class AbstractFileTransferApi<Context>

listTransfers

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

Description copied from class: AbstractFileTransferApi

  List transfers
 

Specified by:

listTransfers in class AbstractFileTransferApi<Context>

getTransfer

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

Description copied from class: AbstractFileTransferApi

  Get a transfer
 

Specified by:

getTransfer in class AbstractFileTransferApi<Context>

createTransfer

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

Description copied from class: AbstractFileTransferApi

  Create a transfer
 

Specified by:

createTransfer in class AbstractFileTransferApi<Context>

pauseTransfer

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

Description copied from class: AbstractFileTransferApi

  Pause a transfer
 

Specified by:

pauseTransfer in class AbstractFileTransferApi<Context>

cancelTransfer

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

Description copied from class: AbstractFileTransferApi

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

Specified by:

cancelTransfer in class AbstractFileTransferApi<Context>

resumeTransfer

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

Description copied from class: AbstractFileTransferApi

  Resume a transfer
 

Specified by:

resumeTransfer in class AbstractFileTransferApi<Context>

subscribeTransfers

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

Description copied from class: AbstractFileTransferApi

  Subscribe to transfer updates
 

Specified by:

subscribeTransfers in class AbstractFileTransferApi<Context>

subscribeRemoteFileList

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

Description copied from class: AbstractFileTransferApi

  Subscribe to remote file list updates
 

Specified by:

subscribeRemoteFileList in class AbstractFileTransferApi<Context>

fetchFileList

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

Request file list from remote

Specified by:

fetchFileList in class AbstractFileTransferApi<Context>

getFileList

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

Get latest file list from service

Specified by:

getFileList in class AbstractFileTransferApi<Context>

runFileAction

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

Description copied from class: AbstractFileTransferApi

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

Specified by:

runFileAction in class AbstractFileTransferApi<Context>