Python API: sam v8_1_5
sam.requestFileTransfer()

Just having some fun...
This is the python interface to the command 'sam request file transfer'.
Command Description:

This command is the "guts" behind the scenes for storing sam files,
but more flexible.  (The "sam store" command transfers file only
to the Fermilab enstore robot; the "request file transfer" command
can transfer files to any valid sam location).

For files that have been previously declared to SAM, this command
allows you to use local copies of the file to create replicas at
other valid SAM locations, using the file transfer knowledge
encapsulated within the SAM station code.

For new files, you may add the "--declareFile" option, along
with a suitable --descriptionFile (or metadata object, if using
the python API), to declare the file first and *then* create
the replica.

The "--sourceFile" option is the path to the file (including
fileName) on the local system.

The "--destinationPath" option is the target destination, which
must be a valid SAM location.

The "--station" option determines which station's FSS will be
called upon to perform the file transfer.  (The station must be
able to communicate with the local node, of course).

The --temporaryTransferLocation option is a temporary/intermediate
location to transfer the file; This location must be accessible by 
SAM station. When used, the file will be transfered to this location
using samcp before SAM transfers the file to final destination.
This is useful when the originating location of the transfer 
cannot be accessed by SAM.

If the "--eraseSourceWhenDone" flag is passed, the original file
will be removed when the transfer is completed.

If the "--waitForCompletion" flag is passed, the returned
FileTransferStatus object will contain the status of the
transfer.  If this flag is not passed, the returned status
object will contain a status of "pending", and the user
will need to poll with the "get file transfer status" command
to determine if/when the file transfer completes.


A couple of examples using the PYTHON API:

   from Sam import sam
   from SamFile.SamDataFile import SamDataFile
   import SAM

   # declare and transfer a file:
   transferRequestId = sam.requestFileTransfer(station='myStationName',
                           sourceFile='mynode.fnal.gov:/tmp/files/for/sam/myFileNameGoesHere.txt',
                           destinationPath='/pnfs/sam/dzero/logfiles/',
                           declareFile=1,
                           metadata=SamDataFile(fileName='myFileNameGoesHere.txt',
                                                fileType=SAM.DataFileType_NonPhysicsGeneric,
                                                fileSize='1000Kb',
                                                group='dzero',
                                                ))

   # transfer a file that already exists in sam, but without the 'group' attribute;
   #  erase the original when complete
   transferRequestId = sam.requestFileTransfer(station='myStationName',
                           sourceFile='mynode.fnal.gov:/sam/cache/boo/alreadyInSamCache',
                           destinationPath='/my/disk/sam/dzero/important/other/files/',
                           group='test',
                           eraseSourceWhenDone=1)

   # transfer a file that already exists, and WAIT for the
   #  transfer to complete before returning to the called;
   # in this case, the node will be assumed to be the local node.
   transferRequestId = sam.requestFileTransfer(station='myStationName',
                           sourceFile='/tmp/files/mySamFile',
                           destinationPath='/some/place/for/files',
                           group='dzero',
                           waitForCompletion=1)


Python Usage:
	from Sam import sam
	result = sam.requestFileTransfer(...)

Return value: SamStruct.FileTransferStatus.FileTransferStatus

Arguments are passed as keyword-value pairs, as in:
	 myfunc(arg1='myarg', arg2='anotherarg', d=1)

Argument Keyword Description:
	(*) indicates that this keyword is required
	>>> indicates that either the API object or the CLI equivalent (<<<) is required
====================================================================================================================================
    KEYWORD                    DATA TYPE            DESCRIPTION
------------------------------------------------------------------------------------------------------------------------------------
    c                          SamBoolean           automatically close all servants after each method call
    corbaCallTimeout           int                  time in seconds for CORBA method calls to return before timing out (default: 0; zero implies no timeout)
    d                          SamBoolean           debug mode
    declareFile                SamBoolean           indicates that this is a new file which must first be declared to SAM
    descriptionFile            string               metadata description file, if the file must be declared
(*) destinationPath            string               destination location; must be a valid SAM location
    eraseSourceWhenDone        SamBoolean           remove the original file when the transfer is complete
    group                      string               group responsible for the file (if not contained in the metadata)
    metadata                   SamDataFile          SamDataFile object containing the metadata for the file if it needs to be declared
    minPnfsFileStoreSize       SamSize              reject requests to transfer files smaller than this into enstore
    retryInterval              int                  retry interval base in seconds; will multiply this base times retryCount (default: 5)
    retryJitter                int                  retry jitter, random jitter added to base retry interval times retryCount (default: 5)
    retryMaxCount              int                  number of times to retry CORBA calls for retriable exceptions (default: 25; zero implies no retries)
    s                          SamBoolean           retrySilently mode (do not issue messages to stderr on proxy retries)
(*) sourceFile                 string               fully-specified path to the file
(*) station                    string               station (fss) which should perform the file transfer
    t                          SamBoolean           time-it mode (print additional info on timings)
    temporaryTransferLocation  string               Temporary (Intermediate) location to transfer the file; must be accessible by SAM station.
    v                          SamBoolean           verbose mode
    waitForCompletion          SamBoolean           wait, polling the FSS, until the file transfer has completed
====================================================================================================================================

Python API-only Keywords:
	'metadata': replaces descriptionFile

Mutually exclusive keywords:	
	(descriptionFile || metadata) 

Environment Defaults:
	c = os.environ['SAM_PYAPI_AUTO_CLOSE_SERVANTS']
	corbaCallTimeout = os.environ['SAM_PYAPI_CORBA_CALL_TIMEOUT']
	minPnfsFileStoreSize = os.environ['SAM_MIN_PNFS_FILE_STORE_SIZE']
	retryInterval = os.environ['SAM_PYAPI_RETRY_INTERVAL']
	retryJitter = os.environ['SAM_PYAPI_RETRY_JITTER']
	retryMaxCount = os.environ['SAM_PYAPI_RETRY_MAX_COUNT']
	s = os.environ['SAM_PYAPI_RETRY_SILENTLY']
	station = os.environ['SAM_STATION']



See Also: