org.yamcs.cfdp.CfdpFileTransfer Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of yamcs-core Show documentation

There is a newer version: 5.10.9

package org.yamcs.cfdp;

import org.yamcs.filetransfer.FileTransfer;
import org.yamcs.protobuf.TransferDirection;

public interface CfdpFileTransfer extends FileTransfer {

    enum PredefinedTransferTypes {
        FILE_TRANSFER("File Transfer"),
        LARGE_FILE_TRANSFER("Large File Transfer"),
        METADATA_ONLY_TRANSFER("Metadata Only Transfer"),
        DOWNLOAD_REQUEST("Download Request"),
        DOWNLOAD_REQUEST_RESPONSE("Download Request Response"),
        DIRECTORY_LISTING_REQUEST("Directory Listing Request"),
        DIRECTORY_LISTING_RESPONSE("Directory Listing Response"),
        ORIGINATING_TRANSACTION_ID_ONLY("Originating Transaction ID only"),
        UNKNOWN_METADATA_OPTION("Unknown Metadata Option"),
        UNKNOWN("Unknown");

        private final String value;

        PredefinedTransferTypes(String value) {
            this.value = value;
        }

        @Override
        public String toString() {
            return value.toUpperCase();
        }
    }

    /**
     * Get the CFDP transaction id. Returns null for queued transfers.
     */
    CfdpTransactionId getTransactionId();

    long getInitiatorEntityId();

    long getDestinationId();

    @Override
    default Long getLocalEntityId() {
        if (getDirection() == TransferDirection.UPLOAD) {
            return getInitiatorEntityId();
        } else {
            return getDestinationId();
        }
    }

    @Override
    default Long getRemoteEntityId() {
        if (getDirection() == TransferDirection.UPLOAD) {
            return getDestinationId();
        } else {
            return getInitiatorEntityId();
        }
    }
}