Package org.yamcs.cfdp

Class CfdpIncomingTransfer

java.lang.Object

org.yamcs.cfdp.OngoingCfdpTransfer

org.yamcs.cfdp.CfdpIncomingTransfer

All Implemented Interfaces:

CfdpFileTransfer, FileTransfer

public class CfdpIncomingTransfer
extends OngoingCfdpTransfer

Nested Class Summary

Nested classes/interfaces inherited from interface org.yamcs.cfdp.CfdpFileTransfer

CfdpFileTransfer.PredefinedTransferTypes

Field Summary

Fields inherited from class org.yamcs.cfdp.OngoingCfdpTransfer

acknowledged, cfdpTransactionId, creationTime, eventProducer, executor, inactivityFuture, log, startTime, state, transferType, wallclockStartTime

Constructor Summary

Constructors

Constructor	Description
CfdpIncomingTransfer(String yamcsInstance, long id, long creationTime, ScheduledThreadPoolExecutor executor, YConfiguration config, CfdpHeader hdr, Stream cfdpOut, FileSaveHandler fileSaveHandler, EventProducer eventProducer, TransferMonitor monitor, Map<ConditionCode,org.yamcs.cfdp.OngoingCfdpTransfer.FaultHandlingAction> faultHandlerActions)

Method Summary

Modifier and Type	Method	Description
protected void	cancel(ConditionCode code)
String	getBucketName()	return the name of the bucket where the file is being transfered to/from.
TransferDirection	getDirection()
DirectoryListingResponse	getDirectoryListingResponse()
byte[]	getFileData()
long	getInitiatorEntityId()	Return the entity id of the Sender
String	getObjectName()	return the name of the object (file) which is being transfered.
String	getOriginalObjectName()
CfdpTransactionId	getOriginatingTransactionId()
String	getRemotePath()	return the remote path of the file which is being transfered.
long	getTotalSize()	return the file size in bytes or -1 if the size is not known.
long	getTransferredSize()
protected void	onInactivityTimerExpiration()
void	processPacket(CfdpPacket packet)
protected void	resume()
protected void	suspend()

Methods inherited from class org.yamcs.cfdp.OngoingCfdpTransfer

abandonTransfer, cancelInactivityTimer, cancellable, cancelTransfer, changeState, failTransfer, getCreationTime, getDestinationId, getFailuredReason, getFaultHandlingAction, getId, getStartTime, getTransactionId, getTransferState, getTransferType, getTransferType, isOngoing, isReliable, pausable, pauseTransfer, pushError, rescheduleInactivityTimer, resumeTransfer, sendInfoEvent, sendPacket, sendWarnEvent, toEventMsg

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.yamcs.cfdp.CfdpFileTransfer

getLocalEntityId, getRemoteEntityId

Constructor Details

CfdpIncomingTransfer

public CfdpIncomingTransfer(String yamcsInstance,
 long id,
 long creationTime,
 ScheduledThreadPoolExecutor executor,
 YConfiguration config,
 CfdpHeader hdr,
 Stream cfdpOut,
 FileSaveHandler fileSaveHandler,
 EventProducer eventProducer,
 TransferMonitor monitor,
 Map<ConditionCode,org.yamcs.cfdp.OngoingCfdpTransfer.FaultHandlingAction> faultHandlerActions)

Method Details

processPacket

public void processPacket(CfdpPacket packet)

Specified by:

processPacket in class OngoingCfdpTransfer

onInactivityTimerExpiration

protected void onInactivityTimerExpiration()

Specified by:

onInactivityTimerExpiration in class OngoingCfdpTransfer

suspend

protected void suspend()

Specified by:

suspend in class OngoingCfdpTransfer

resume

protected void resume()

Specified by:

resume in class OngoingCfdpTransfer

cancel

protected void cancel(ConditionCode code)

Specified by:

cancel in class OngoingCfdpTransfer

getInitiatorEntityId

public long getInitiatorEntityId()

Description copied from class: OngoingCfdpTransfer

Return the entity id of the Sender

Specified by:

getInitiatorEntityId in interface CfdpFileTransfer

Overrides:

getInitiatorEntityId in class OngoingCfdpTransfer

getBucketName

public String getBucketName()

Description copied from interface: FileTransfer

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

public String getObjectName()

Description copied from interface: FileTransfer

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.

getOriginalObjectName

public String getOriginalObjectName()

getRemotePath

public String getRemotePath()

Description copied from interface: FileTransfer

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.

getDirection

public TransferDirection getDirection()

getTotalSize

public long getTotalSize()

Description copied from interface: FileTransfer

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

public long getTransferredSize()

getDirectoryListingResponse

public DirectoryListingResponse getDirectoryListingResponse()

getFileData

public byte[] getFileData()

getOriginatingTransactionId

public CfdpTransactionId getOriginatingTransactionId()