org.griphyn.cPlanner.transfer.implementation
Class Condor

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

All Implemented Interfaces:

Implementation, MultipleFTPerXFERJob

public class Condor
extends AbstractMultipleFTPerXFERJob

A prototype implementation that leverages the Condor file transfer mechanism to do the transfer to the remote directory . Currently, this will only work for staging in data to a remote site from the submit host.

Additionally, this will only work with local replica selector that prefers file urls from the submit host for staging.

In order to use the transfer implementation implemented by this class,

     - property pegasus.transfer.stagein.impl must be set to
       value Condor.
     - property pegasus.selector.replica must be set to value
       Local
 

Version:

$Revision: 387 $

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.
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

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

Method Summary

TransferJob	createTransferJob(SubInfo job, Collection files, Collection execFiles, String txJobName, int jobClass) Constructs a condor file transfer job that handles multiple transfers.
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 stdIn, 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

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

Constructor Detail

Condor

public Condor(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

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:

false

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

getCompleteTCName

protected String getCompleteTCName()

Returns the complete name for the transformation.

Specified by:

getCompleteTCName in class AbstractMultipleFTPerXFERJob

Returns:

the complete name.

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.

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.

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.

getDescription

public String getDescription()

Returns a textual description of the transfer implementation.

Returns:

a short textual description

getEnvironmentVariables

protected List getEnvironmentVariables(String site)

Returns the environment profiles that are required for the default entry to sensibly work. There are no variables to be returned for this case.

Specified by:

getEnvironmentVariables in class AbstractMultipleFTPerXFERJob

Parameters:

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

Returns:

an empty list

createTransferJob

public TransferJob createTransferJob(SubInfo job,
                                     Collection files,
                                     Collection execFiles,
                                     String txJobName,
                                     int jobClass)

Constructs a condor file transfer job that handles multiple transfers. The job itself is a /bin/true job that currently only manages to transfer input files from the local host.

Specified by:

createTransferJob in interface Implementation

Overrides:

createTransferJob in class AbstractMultipleFTPerXFERJob

Parameters:

job - the SubInfo object for the job, in relation to which the transfer node is being added. Either the transfer node can be transferring this jobs input files to the execution pool, or transferring this job's output files to the output pool.

files - collection of FileTransfer objects representing the data files and staged executables to be transferred.

execFiles - subset collection of the files parameter, that identifies the executable files that are being transferred.

txJobName - the name of transfer node.

jobClass - the job Class for the newly added job. Can be one of the following: stage-in stage-out inter-pool transfer

Returns:

the created TransferJob.

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.

useThirdPartyTransferAlways

public boolean useThirdPartyTransferAlways()

Return a boolean indicating whether the transfers to be done always in a third party transfer mode. Fix me. should say NEVER.

Returns:

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

See Also:

PegasusProperties.getThirdPartySites(String)

writeJumboStdIn

protected void writeJumboStdIn(FileWriter stdIn,
                               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:

stdIn - the writer to the stdin file.

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

Throws:

Exception