Package org.yamcs.cfdp

Class PutRequest

java.lang.Object

org.yamcs.cfdp.CfdpRequest

org.yamcs.cfdp.PutRequest

Direct Known Subclasses:

FilePutRequest

public class PutRequest
extends CfdpRequest

Put.request (destination CFDP entity ID, [source file name], [destination file name], [segmentation control], [fault handler overrides], [flow label], [transmission mode], [closure requested], [messages to user], [filestore requests])

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	PutRequest.SegmentationControl

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PutRequest(long destinationCfdpEntityId)
protected	PutRequest(long destinationCfdpEntityId, String sourceFileName, String destinationFileName, PutRequest.SegmentationControl segmentationControl, Map<ConditionCode,org.yamcs.cfdp.OngoingCfdpTransfer.FaultHandlingAction> faultHandlerOverride, String flowLabel, CfdpPacket.TransmissionMode transmissionMode, boolean closureRequested, List<MessageToUser> messagesToUser, List<FileStoreRequest> fileStoreRequests)
protected	PutRequest(long destinationCfdpEntityId, CfdpPacket.TransmissionMode transmissionMode, List<MessageToUser> messagesToUser)

Method Summary

Modifier and Type	Method	Description
long	getChecksum()
long	getDestinationCfdpEntityId()
String	getDestinationFileName()
Map<ConditionCode,org.yamcs.cfdp.OngoingCfdpTransfer.FaultHandlingAction>	getFaultHandlerOverride()
byte[]	getFileData()
int	getFileLength()
List<FileStoreRequest>	getFileStoreRequests()
String	getFlowLabel()
CfdpHeader	getHeader()
List<MessageToUser>	getMessagesToUser()
MetadataPacket	getMetadata()
PutRequest.SegmentationControl	getSegmentationControl()
String	getSourceFileName()
CfdpPacket.TransmissionMode	getTransmissionMode()
boolean	isAcknowledged()
boolean	isClosureRequested()
CfdpTransactionId	process(long initiatorEntityId, long sequenceNumber, ChecksumType checksumType, YConfiguration config)	Generate relevant header and metadata the put request (Only implemented for Messages To User currently)

Methods inherited from class org.yamcs.cfdp.CfdpRequest

getType

Methods inherited from class java.lang.Object

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

Constructor Details

PutRequest

protected PutRequest(long destinationCfdpEntityId)

PutRequest

protected PutRequest(long destinationCfdpEntityId,
 String sourceFileName,
 String destinationFileName,
 PutRequest.SegmentationControl segmentationControl,
 Map<ConditionCode,org.yamcs.cfdp.OngoingCfdpTransfer.FaultHandlingAction> faultHandlerOverride,
 String flowLabel,
 CfdpPacket.TransmissionMode transmissionMode,
 boolean closureRequested,
 List<MessageToUser> messagesToUser,
 List<FileStoreRequest> fileStoreRequests)

PutRequest

protected PutRequest(long destinationCfdpEntityId,
 CfdpPacket.TransmissionMode transmissionMode,
 List<MessageToUser> messagesToUser)

Method Details

process

public CfdpTransactionId process(long initiatorEntityId,
 long sequenceNumber,
 ChecksumType checksumType,
 YConfiguration config)

Generate relevant header and metadata the put request (Only implemented for Messages To User currently)

Parameters:

initiatorEntityId -

sequenceNumber -

checksumType -

config -

Returns:

getDestinationCfdpEntityId

public long getDestinationCfdpEntityId()

getSourceFileName

public String getSourceFileName()

getDestinationFileName

public String getDestinationFileName()

getSegmentationControl

public PutRequest.SegmentationControl getSegmentationControl()

getFaultHandlerOverride

public Map<ConditionCode,org.yamcs.cfdp.OngoingCfdpTransfer.FaultHandlingAction> getFaultHandlerOverride()

getFlowLabel

public String getFlowLabel()

getTransmissionMode

public CfdpPacket.TransmissionMode getTransmissionMode()

isAcknowledged

public boolean isAcknowledged()

isClosureRequested

public boolean isClosureRequested()

getMessagesToUser

public List<MessageToUser> getMessagesToUser()

getFileStoreRequests

public List<FileStoreRequest> getFileStoreRequests()

getHeader

public CfdpHeader getHeader()

getMetadata

public MetadataPacket getMetadata()

getFileLength

public int getFileLength()

getFileData

public byte[] getFileData()

getChecksum

public long getChecksum()