Package org.yamcs.filetransfer

Interface FileTransfer

All Known Subinterfaces:
CfdpFileTransfer
All Known Implementing Classes:
CfdpIncomingTransfer, CfdpOutgoingTransfer, CompletedTransfer, OngoingCfdpTransfer, QueuedCfdpOutgoingTransfer
public interface FileTransfer

  • Method Details

    • getBucketName

      String getBucketName()
      return the name of the bucket where the file is being transfered to/from.

      Could be null for incoming transfers. For the CFDP service, the bucket is determined by the source or destination entity id and it is not null. However if the bucket was determined by the filename which is known only when the metadata packet is received, this could be null.

    • getObjectName

      String getObjectName()
      return the name of the object (file) which is being transfered. This is the filename on the local (Yamcs) site.

      Can be null for incoming transfers - for example CFDP can start a transfer without knowing the filename if the first metadata packet has been lost.

    • getRemotePath

      String getRemotePath()
      return the remote path of the file which is being transfered.

      Can be null for incoming transfers - for example CFDP can start a transfer without having this information if the first metadata packet has been lost.

    • getLocalEntityId

      Long getLocalEntityId()

    • getRemoteEntityId

      Long getRemoteEntityId()

    • getDirection

      TransferDirection getDirection()

    • getTotalSize

      long getTotalSize()
      return the file size in bytes or -1 if the size is not known.

      For the CFDP service the incoming files can be unbounded (but this is not yet supported) or the size will be part of the metadata packet which may be missing.

    • getTransferredSize

      long getTransferredSize()

    • getId

      long getId()

    • getTransferState

      TransferState getTransferState()

    • isReliable

      boolean isReliable()

    • getFailuredReason

      String getFailuredReason()

    • getCreationTime

      long getCreationTime()

    • getStartTime

      long getStartTime()

    • getTransferType

      String getTransferType()

    • pausable

      boolean pausable()

    • cancellable

      boolean cancellable()