Package org.yamcs.filetransfer

Interface FileListingService

All Known Subinterfaces:

FileTransferService

All Known Implementing Classes:

AbstractFileTransferService, CfdpService

public interface FileListingService

Method Summary

Modifier and Type	Method	Description
void	fetchFileList(String source, String destination, String remotePath, Map<String,Object> options)	Start fetching a new file list from remote.
ListFilesResponse	getFileList(String source, String destination, String remotePath, Map<String,Object> options)	Return latest file list of the given destination.
Set<RemoteFileListMonitor>	getRemoteFileListMonitors()
default void	init(String yamcsInstance, String serviceName, YConfiguration config)
void	notifyRemoteFileListMonitors(ListFilesResponse listFilesResponse)
void	registerRemoteFileListMonitor(RemoteFileListMonitor monitor)
void	saveFileList(ListFilesResponse listFilesResponse)
void	unregisterRemoteFileListMonitor(RemoteFileListMonitor monitor)

Method Details

registerRemoteFileListMonitor

void registerRemoteFileListMonitor(RemoteFileListMonitor monitor)

unregisterRemoteFileListMonitor

void unregisterRemoteFileListMonitor(RemoteFileListMonitor monitor)

notifyRemoteFileListMonitors

void notifyRemoteFileListMonitors(ListFilesResponse listFilesResponse)

getRemoteFileListMonitors

Set<RemoteFileListMonitor> getRemoteFileListMonitors()

init

default void init(String yamcsInstance,
 String serviceName,
 YConfiguration config)
           throws InitException

Throws:

InitException

getFileList

ListFilesResponse getFileList(String source,
 String destination,
 String remotePath,
 Map<String,Object> options)

Return latest file list of the given destination.

Parameters:

source - source requesting the file list (e.g. local entity for CFDP)

destination - destination from which the file list is needed (e.g. remote entity for CFDP)

remotePath - path on the destination from which to get the file list

options - reliability of the file listing request (e.g. transmission mode for CFDP, may not be needed)

Returns:

file list

fetchFileList

void fetchFileList(String source,
 String destination,
 String remotePath,
 Map<String,Object> options)

Start fetching a new file list from remote.

Parameters:

source - source requesting the file list (e.g. local entity for CFDP)

destination - destination from which the file list is needed (e.g. remote entity for CFDP)

remotePath - path on the destination from which to get the file list

options - reliability of the file listing request (e.g. transmission mode for CFDP, may not be needed)

saveFileList

void saveFileList(ListFilesResponse listFilesResponse)