edu.isi.pegasus.common.credential
Interface CredentialHandler

All Known Implementing Classes:

Abstract, Irods, Proxy, S3CFG, Ssh

public interface CredentialHandler

The credential interface that defines the credentials that can be associated with jobs.

Author:

Karan Vahi

Nested Class Summary

static class

CredentialHandler.TYPE An enumeration of valid types of credentials that are supported.

Field Summary

static String

VERSION The version of the API being used.

Method Summary

String	getBaseName() returns the basename of the credential file name
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() Returns the path to the credential on the submit host.
String	getPath(String site) Returns the path to the credential for a particular site handle
void	initialize(PegasusBag bag) Initializes the credential implementation.

Field Detail

VERSION

static final String VERSION

The version of the API being used.

See Also:

Constant Field Values

Method Detail

initialize

void initialize(PegasusBag bag)

Initializes the credential implementation. Implementations require access to the logger, properties and the SiteCatalog Store.

Parameters:

bag - the bag of Pegasus objects.

getPath

String getPath()

Returns the path to the credential on the submit host.

Returns:

getPath

String getPath(String site)

Returns the path to the credential for a particular site handle

Parameters:

site - the site catalog entry object.

Returns:

the path to the credential

getEnvironmentVariable

String getEnvironmentVariable()

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

Returns:

the name of the environment variable.

getDescription

String getDescription()

Returns the description for the implementing handler

Returns:

description

getBaseName

String getBaseName()

returns the basename of the credential file name

Returns: