org.griphyn.cPlanner.transfer.implementation
Class Transfer

java.lang.Object
  org.griphyn.cPlanner.transfer.implementation.Abstract
      org.griphyn.cPlanner.transfer.implementation.AbstractMultipleFTPerXFERJob
          org.griphyn.cPlanner.transfer.implementation.Transfer

All Implemented Interfaces:

Implementation, MultipleFTPerXFERJob

public class Transfer
extends AbstractMultipleFTPerXFERJob

The implementation that creates transfer jobs referring to the transfer executable distributed with the VDS.

The Transfer client is generally invoked on the remote execution sites, unless the user uses the thirdparty transfer option, in which case the transfer is invoked on the submit host. Hence there should be an entry in the transformation catalog for logical transformation Transfer at the execution sites. Transfer is distributed as part of the VDS worker package and can be found at $PEGASUS_HOME/bin/transfer.

It leads to the creation of the setup chmod jobs to the workflow, that appear as parents to compute jobs in case the transfer implementation does not preserve the X bit on the file being transferred. This is required for staging of executables as part of the workflow. The setup jobs are only added as children to the stage in jobs.

In order to use the transfer implementation implemented by this class, the property pegasus.transfer.*.impl must be set to value Transfer.

Version:

$Revision: 362 $

Author:

Karan Vahi

Field Summary

static String	DERIVATION_NAME The name of the underlying derivation.
static String	DERIVATION_NAMESPACE The derivation namespace for for the transfer job.
static String	DERIVATION_VERSION The derivation version number for the transfer job.
static String	DESCRIPTION A short description of the transfer implementation.
protected String	mNumOfTXProcesses The number of g-u-c processes that are spawned to transfer the files in one transfer job.
protected String	mNumOfTXStreams The number of streams that each g-u-c process opens to do the ftp transfer.
protected boolean	mUseForce Whether to use force option for the transfer executable or not.
static String	TRANSFORMATION_NAME The name of the underlying transformation that is queried for in the Transformation Catalog.
static String	TRANSFORMATION_NAMESPACE The transformation namespace for the transfer job.
static String	TRANSFORMATION_VERSION The version number for the transfer job.

Fields inherited from class org.griphyn.cPlanner.transfer.implementation.Abstract

CHANGE_XBIT_TRANSFORMATION, mDisabledChmodSites, mLocalUserProxy, mLocalUserProxyBasename, mLogger, mPOptions, mProps, mRefiner, mSCHandle, mTCHandle, NOOP_PREFIX, SET_XBIT_PREFIX, XBIT_DERIVATION_NS, XBIT_DERIVATION_VERSION, XBIT_TRANSFORMATION_NS, XBIT_TRANSFORMATION_VERSION

Fields inherited from interface org.griphyn.cPlanner.transfer.Implementation

TRANSFER_UNIVERSE, VERSION

Constructor Summary

Transfer(PegasusProperties properties, PlannerOptions options)
The overloaded constructor, that is called by the Factory to load the class.

Method Summary

boolean	doesPreserveXBit() Returns a boolean indicating whether the transfer protocol being used by the implementation preserves the X Bit or not while staging.
protected String	generateArgumentString(TransferJob job) It constructs the arguments to the transfer executable that need to be passed to the executable referred to in this transfer mode.
protected String	getCompleteTCName() Returns the complete name for the transformation.
protected String	getDerivationName() Returns the logical name of the derivation that this implementation refers to.
protected String	getDerivationNamespace() Returns the namespace of the derivation that this implementation refers to.
protected String	getDerivationVersion() Returns the version of the derivation that this implementation refers to.
String	getDescription() Returns a textual description of the transfer implementation.
protected List	getEnvironmentVariables(String site) Returns the environment profiles that are required for the default entry to sensibly work.
TransformationCatalogEntry	getTransformationCatalogEntry(String siteHandle) Retrieves the transformation catalog entry for the executable that is being used to transfer the files in the implementation.
boolean	useThirdPartyTransferAlways() Return a boolean indicating whether the transfers to be done always in a third party transfer mode.
protected void	writeJumboStdIn(FileWriter writer, Collection files) Writes to a FileWriter stream the stdin which goes into the magic script via standard input

Methods inherited from class org.griphyn.cPlanner.transfer.implementation.AbstractMultipleFTPerXFERJob

createTransferJob, defaultTCEntry, postProcess, prepareSTDIN

Methods inherited from class org.griphyn.cPlanner.transfer.implementation.Abstract

addSetXBitJobs, addSetXBitJobs, addSetXBitJobs, applyPriority, checkAndTransferProxy, construct, createNoOPJob, createSetXBitJob, determineDisabledChmodSites, disableChmodJobCreation, getNOOPJobName, getPathToUserProxy, getPriority, getSetXBitJobName, setRefiner

Methods inherited from class java.lang.Object

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

Field Detail

TRANSFORMATION_NAMESPACE

public static final String TRANSFORMATION_NAMESPACE

The transformation namespace for the transfer job.

See Also:

Constant Field Values

TRANSFORMATION_NAME

public static final String TRANSFORMATION_NAME

The name of the underlying transformation that is queried for in the Transformation Catalog.

See Also:

Constant Field Values

TRANSFORMATION_VERSION

public static final String TRANSFORMATION_VERSION

The version number for the transfer job.

DERIVATION_NAMESPACE

public static final String DERIVATION_NAMESPACE

The derivation namespace for for the transfer job.

See Also:

Constant Field Values

DERIVATION_NAME

public static final String DERIVATION_NAME

The name of the underlying derivation.

See Also:

Constant Field Values

DERIVATION_VERSION

public static final String DERIVATION_VERSION

The derivation version number for the transfer job.

See Also:

Constant Field Values

DESCRIPTION

public static final String DESCRIPTION

A short description of the transfer implementation.

See Also:

Constant Field Values

mNumOfTXProcesses

protected String mNumOfTXProcesses

The number of g-u-c processes that are spawned to transfer the files in one transfer job.

mNumOfTXStreams

protected String mNumOfTXStreams

The number of streams that each g-u-c process opens to do the ftp transfer.

mUseForce

protected boolean mUseForce

Whether to use force option for the transfer executable or not.

Constructor Detail

Transfer

public Transfer(PegasusProperties properties,
                PlannerOptions options)

The overloaded constructor, that is called by the Factory to load the class.

Parameters:

properties - the properties object.

options - the options passed to the Planner.

Method Detail

useThirdPartyTransferAlways

public boolean useThirdPartyTransferAlways()

Return a boolean indicating whether the transfers to be done always in a third party transfer mode. A value of false, results in the direct or peer to peer transfers being done.

A value of false does not preclude third party transfers. They still can be done, by setting the property "pegasus.transfer.*.thirdparty.sites".

Returns:

boolean indicating whether to always use third party transfers or not.

See Also:

PegasusProperties.getThirdPartySites(String)

doesPreserveXBit

public boolean doesPreserveXBit()

Returns a boolean indicating whether the transfer protocol being used by the implementation preserves the X Bit or not while staging.

Returns:

boolean

getDescription

public String getDescription()

Returns a textual description of the transfer implementation.

Returns:

a short textual description

getTransformationCatalogEntry

public TransformationCatalogEntry getTransformationCatalogEntry(String siteHandle)

Retrieves the transformation catalog entry for the executable that is being used to transfer the files in the implementation.

Parameters:

siteHandle - the handle of the site where the transformation is to be searched.

Returns:

the transformation catalog entry if found, else null.

getEnvironmentVariables

protected List getEnvironmentVariables(String site)

Returns the environment profiles that are required for the default entry to sensibly work.

Specified by:

getEnvironmentVariables in class AbstractMultipleFTPerXFERJob

Parameters:

site - the site where the job is going to run.

Returns:

List of environment variables, else null in case where the required environment variables could not be found.

getDerivationNamespace

protected String getDerivationNamespace()

Returns the namespace of the derivation that this implementation refers to.

Specified by:

getDerivationNamespace in class AbstractMultipleFTPerXFERJob

Returns:

the namespace of the derivation.

getDerivationName

protected String getDerivationName()

Returns the logical name of the derivation that this implementation refers to.

Specified by:

getDerivationName in class AbstractMultipleFTPerXFERJob

Returns:

the name of the derivation.

getDerivationVersion

protected String getDerivationVersion()

Returns the version of the derivation that this implementation refers to.

Specified by:

getDerivationVersion in class AbstractMultipleFTPerXFERJob

Returns:

the version of the derivation.

generateArgumentString

protected String generateArgumentString(TransferJob job)

It constructs the arguments to the transfer executable that need to be passed to the executable referred to in this transfer mode.

Specified by:

generateArgumentString in class AbstractMultipleFTPerXFERJob

Parameters:

job - the object containing the transfer node.

Returns:

the argument string

writeJumboStdIn

protected void writeJumboStdIn(FileWriter writer,
                               Collection files)
                        throws Exception

Writes to a FileWriter stream the stdin which goes into the magic script via standard input

Specified by:

writeJumboStdIn in class AbstractMultipleFTPerXFERJob

Parameters:

writer - the writer to the stdin file.

files - Collection of FileTransfer objects containing the information about sourceam fin and destURL's.

Throws:

Exception

getCompleteTCName

protected String getCompleteTCName()

Returns the complete name for the transformation.

Specified by:

getCompleteTCName in class AbstractMultipleFTPerXFERJob

Returns:

the complete name.