edu.isi.pegasus.common.credential.impl
Class Irods

java.lang.Object
  edu.isi.pegasus.common.credential.impl.Abstract
      edu.isi.pegasus.common.credential.impl.Irods

All Implemented Interfaces:

CredentialHandler

public class Irods
extends Abstract
implements CredentialHandler

A convenience class that allows us to determine the path to the user irodsEnvFile file.

Version:

$Revision: 4929 $

Author:

Mats Rynge

Nested Class Summary

Nested classes/interfaces inherited from interface edu.isi.pegasus.common.credential.CredentialHandler

CredentialHandler.TYPE

Field Summary

static String	DESCRIPTION The description.
static String	IRODSENVFILE The name of the environment variable that specifies the path to the s3cfg file.

Fields inherited from class edu.isi.pegasus.common.credential.impl.Abstract

mLogger, mProps, mSiteStore

Fields inherited from interface edu.isi.pegasus.common.credential.CredentialHandler

VERSION

Constructor Summary

Irods()
The default constructor.

Method Summary

String	getBaseName() returns the basename of the path to the local credential
String	getDescription() Returns the description for the implementing handler
String	getEnvironmentVariable() Returns the name of the environment variable that needs to be set for the job associated with the credential.
String	getPath(String site) Returns the path to irodsEnv.

Methods inherited from class edu.isi.pegasus.common.credential.impl.Abstract

getPath, initialize

Methods inherited from class java.lang.Object

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

Methods inherited from interface edu.isi.pegasus.common.credential.CredentialHandler

getPath, initialize

Field Detail

IRODSENVFILE

public static final String IRODSENVFILE

The name of the environment variable that specifies the path to the s3cfg file.

See Also:

Constant Field Values

DESCRIPTION

public static final String DESCRIPTION

The description.

See Also:

Constant Field Values

Constructor Detail

Irods

public Irods()

The default constructor.

Method Detail

getPath

public String getPath(String site)

Returns the path to irodsEnv. The order of preference is as follows - If a irods is specified in the local catalog entry - Else the one pointed to by the environment variable S3CFG

Specified by:

getPath in interface CredentialHandler

Parameters:

site - the site handle

Returns:

the path to s3cfg.

getBaseName

public String getBaseName()

returns the basename of the path to the local credential

Specified by:

getBaseName in interface CredentialHandler

Returns:

getEnvironmentVariable

public String getEnvironmentVariable()

Returns the name of the environment variable that needs to be set for the job associated with the credential.

Specified by:

getEnvironmentVariable in interface CredentialHandler

Returns:

the name of the environment variable.

getDescription

public String getDescription()

Returns the description for the implementing handler

Specified by:

getDescription in interface CredentialHandler

Returns:

description