Package org.yamcs.cfdp

Class QueuedCfdpOutgoingTransfer

java.lang.Object

org.yamcs.cfdp.QueuedCfdpOutgoingTransfer

All Implemented Interfaces:

CfdpFileTransfer, FileTransfer

public class QueuedCfdpOutgoingTransfer
extends Object
implements CfdpFileTransfer

Nested Class Summary

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

CfdpFileTransfer.PredefinedTransferTypes

Constructor Summary

Constructors

Constructor	Description
QueuedCfdpOutgoingTransfer(long initiatorEntityId, long id, long creationTime, PutRequest putRequest, Bucket bucket, Integer customPduSize, Integer customPduDelay)

Method Summary

Modifier and Type	Method	Description
boolean	cancellable()
Bucket	getBucket()
String	getBucketName()	return the name of the bucket where the file is being transfered to/from.
long	getCreationTime()
Integer	getCustomPduDelay()
Integer	getCustomPduSize()
long	getDestinationId()
TransferDirection	getDirection()
String	getFailuredReason()
long	getId()
long	getInitiatorEntityId()
String	getObjectName()	return the name of the object (file) which is being transfered.
PutRequest	getPutRequest()
String	getRemotePath()	return the remote path of the file which is being transfered.
long	getStartTime()
long	getTotalSize()	return the file size in bytes or -1 if the size is not known.
CfdpTransactionId	getTransactionId()	Get the CFDP transaction id.
long	getTransferredSize()
TransferState	getTransferState()
String	getTransferType()
boolean	isReliable()
boolean	pausable()
void	setFailureReason(String failureReason)
void	setTransferState(TransferState state)

Methods inherited from class java.lang.Object

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

Constructor Details

QueuedCfdpOutgoingTransfer

public QueuedCfdpOutgoingTransfer(long initiatorEntityId,
 long id,
 long creationTime,
 PutRequest putRequest,
 Bucket bucket,
 Integer customPduSize,
 Integer customPduDelay)

Method Details

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.

Specified by:

getBucketName in interface FileTransfer

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.

Specified by:

getObjectName in interface FileTransfer

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.

Specified by:

getRemotePath in interface FileTransfer

getDirection

public TransferDirection getDirection()

Specified by:

getDirection in interface FileTransfer

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.

Specified by:

getTotalSize in interface FileTransfer

getTransferredSize

public long getTransferredSize()

Specified by:

getTransferredSize in interface FileTransfer

getId

public long getId()

Specified by:

getId in interface FileTransfer

getTransferState

public TransferState getTransferState()

Specified by:

getTransferState in interface FileTransfer

isReliable

public boolean isReliable()

Specified by:

isReliable in interface FileTransfer

getFailuredReason

public String getFailuredReason()

Specified by:

getFailuredReason in interface FileTransfer

getStartTime

public long getStartTime()

Specified by:

getStartTime in interface FileTransfer

pausable

public boolean pausable()

Specified by:

pausable in interface FileTransfer

cancellable

public boolean cancellable()

Specified by:

cancellable in interface FileTransfer

getTransactionId

public CfdpTransactionId getTransactionId()

Description copied from interface: CfdpFileTransfer

Get the CFDP transaction id. Returns null for queued transfers.

Specified by:

getTransactionId in interface CfdpFileTransfer

Returns:

getDestinationId

public long getDestinationId()

Specified by:

getDestinationId in interface CfdpFileTransfer

getTransferType

public String getTransferType()

Specified by:

getTransferType in interface FileTransfer

setTransferState

public void setTransferState(TransferState state)

setFailureReason

public void setFailureReason(String failureReason)

getCreationTime

public long getCreationTime()

Specified by:

getCreationTime in interface FileTransfer

getInitiatorEntityId

public long getInitiatorEntityId()

Specified by:

getInitiatorEntityId in interface CfdpFileTransfer

getPutRequest

public PutRequest getPutRequest()

getBucket

public Bucket getBucket()

getCustomPduSize

public Integer getCustomPduSize()

getCustomPduDelay

public Integer getCustomPduDelay()