edu.isi.pegasus.planner.refiner.cleanup
Class Cleanup

java.lang.Object
  edu.isi.pegasus.planner.refiner.cleanup.Cleanup

All Implemented Interfaces:

CleanupImplementation

public class Cleanup
extends Object
implements CleanupImplementation

Use's RM to do removal of the files on the remote sites.

Version:

$Revision: 4778 $

Author:

Karan Vahi

Field Summary

static String	DEFAULT_CLEANUP_CATEGORY_KEY Default category for registration jobs
static String	DERIVATION_NAME The name of the underlying derivation.
static String	DERIVATION_NAMESPACE The derivation namespace for the job.
static String	DERIVATION_VERSION The derivation version number for the job.
static String	DESCRIPTION A short description of the transfer implementation.
static String	EXECUTABLE_BASENAME The basename of the pegasus cleanup executable.
static String	FILE_URL_SCHEME The scheme name for file url.
private LogManager	mLogger The handle to the logger.
private PegasusProperties	mProps The handle to the properties passed to Pegasus.
protected SiteStore	mSiteStore Handle to the stagingSite catalog.
private String	mSubmitDirectory The submit directory where the output files have to be written.
protected TransformationCatalog	mTCHandle The handle to the transformation catalog.
protected ReplicaCatalog	mTransientRC Handle to the transient replica catalog.
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 job.
static String	TRANSFORMATION_VERSION The version number for the job.

Fields inherited from interface edu.isi.pegasus.planner.refiner.cleanup.CleanupImplementation

VERSION

Constructor Summary

Cleanup()
The default constructor.

Method Summary

Job	createCleanupJob(String id, List files, Job job) Creates a cleanup job that removes the files from remote working directory.
private TransformationCatalogEntry	defaultTCEntry(String site) Returns a default TC entry to be used in case entry is not found in the transformation catalog.
static String	getCompleteTranformationName() A convenience method to return the complete transformation name being used to construct jobs in this class.
protected TransformationCatalogEntry	getTCEntry(String site) Returns the TCEntry object for the rm executable on a grid stagingSite.
void	initialize(PegasusBag bag) Creates a new instance of InPlace

Methods inherited from class java.lang.Object

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

Field Detail

FILE_URL_SCHEME

public static final String FILE_URL_SCHEME

The scheme name for file url.

See Also:

Constant Field Values

DEFAULT_CLEANUP_CATEGORY_KEY

public static final String DEFAULT_CLEANUP_CATEGORY_KEY

Default category for registration jobs

See Also:

Constant Field Values

TRANSFORMATION_NAMESPACE

public static final String TRANSFORMATION_NAMESPACE

The transformation namespace for the 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 job.

DERIVATION_NAMESPACE

public static final String DERIVATION_NAMESPACE

The derivation namespace for the 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 job.

EXECUTABLE_BASENAME

public static final String EXECUTABLE_BASENAME

The basename of the pegasus cleanup executable.

See Also:

Constant Field Values

DESCRIPTION

public static final String DESCRIPTION

A short description of the transfer implementation.

See Also:

Constant Field Values

mTCHandle

protected TransformationCatalog mTCHandle

The handle to the transformation catalog.

mSiteStore

protected SiteStore mSiteStore

Handle to the stagingSite catalog.

mTransientRC

protected ReplicaCatalog mTransientRC

Handle to the transient replica catalog.

mProps

private PegasusProperties mProps

The handle to the properties passed to Pegasus.

mSubmitDirectory

private String mSubmitDirectory

The submit directory where the output files have to be written.

mLogger

private LogManager mLogger

The handle to the logger.

Constructor Detail

Cleanup

public Cleanup()

The default constructor.

Method Detail

getCompleteTranformationName

public static String getCompleteTranformationName()

A convenience method to return the complete transformation name being used to construct jobs in this class.

Returns:

the complete transformation name

initialize

public void initialize(PegasusBag bag)

Creates a new instance of InPlace

Specified by:

initialize in interface CleanupImplementation

Parameters:

bag - the bag of initialization objects.

createCleanupJob

public Job createCleanupJob(String id,
                            List files,
                            Job job)

Creates a cleanup job that removes the files from remote working directory. This will eventually make way to it's own interface.

Specified by:

createCleanupJob in interface CleanupImplementation

Parameters:

id - the identifier to be assigned to the job.

files - the list of PegasusFile that need to be cleaned up.

job - the primary compute job with which this cleanup job is associated.

Returns:

the cleanup job.

getTCEntry

protected TransformationCatalogEntry getTCEntry(String site)

Returns the TCEntry object for the rm executable on a grid stagingSite.

Parameters:

stagingSite - the stagingSite corresponding to which the entry is required.

Returns:

the TransformationCatalogEntry corresponding to the stagingSite.

defaultTCEntry

private TransformationCatalogEntry defaultTCEntry(String site)

Returns a default TC entry to be used in case entry is not found in the transformation catalog.

Parameters:

stagingSite - the stagingSite for which the default entry is required.

Returns:

the default entry.