Class Ssh
- java.lang.Object
-
- edu.isi.pegasus.common.credential.impl.Abstract
-
- edu.isi.pegasus.common.credential.impl.Ssh
-
- All Implemented Interfaces:
CredentialHandler
public class Ssh extends Abstract implements CredentialHandler
A convenience class that allows us to determine the path to the user ssh private key file.- Version:
- $Revision: 4817 $
- Author:
- Mats Rynge, Karan Vahi
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface edu.isi.pegasus.common.credential.CredentialHandler
CredentialHandler.TYPE
-
-
Field Summary
Fields Modifier and Type Field Description private static java.lang.String
DESCRIPTION
The descriptionprivate java.lang.String
mLocalCredentialPath
The local path to the credentialprivate static java.lang.String
SSH_PRIVATE_KEY_PEGASUS_PROFILE_KEY
static java.lang.String
SSH_PRIVATE_KEY_VARIABLE
The name of the environment variable that specifies the path to the SSH key.-
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
Constructors Constructor Description Ssh()
The default constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getBaseName(java.lang.String site)
returns the basename of the path to the local credentialjava.lang.String
getDescription()
Returns the description for the implementing handlerjava.lang.String
getEnvironmentVariable(java.lang.String site)
Returns the name of the environment variable that needs to be set for the job associated with the credential.java.lang.String
getLocalPath()
Returns the path to user cred on the local site.java.lang.String
getPath(java.lang.String site)
Returns the path to SSH_PRIVATE_KEY .java.lang.String
getProfileKey()
Returns the env or pegasus profile key that needs to be associated for the credential.void
initialize(PegasusBag bag)
Initializes the credential implementation.-
Methods inherited from class edu.isi.pegasus.common.credential.impl.Abstract
getPath, getSiteNameForEnvironmentKey
-
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
-
-
-
-
Field Detail
-
SSH_PRIVATE_KEY_VARIABLE
public static final java.lang.String SSH_PRIVATE_KEY_VARIABLE
The name of the environment variable that specifies the path to the SSH key.- See Also:
- Constant Field Values
-
SSH_PRIVATE_KEY_PEGASUS_PROFILE_KEY
private static final java.lang.String SSH_PRIVATE_KEY_PEGASUS_PROFILE_KEY
-
DESCRIPTION
private static final java.lang.String DESCRIPTION
The description- See Also:
- Constant Field Values
-
mLocalCredentialPath
private java.lang.String mLocalCredentialPath
The local path to the credential
-
-
Method Detail
-
initialize
public void initialize(PegasusBag bag)
Initializes the credential implementation. Implementations require access to the logger, properties and the SiteCatalog Store.- Specified by:
initialize
in interfaceCredentialHandler
- Overrides:
initialize
in classAbstract
- Parameters:
bag
- the bag of Pegasus objects.
-
getPath
public java.lang.String getPath(java.lang.String site)
Returns the path to SSH_PRIVATE_KEY . The order of preference is as follows - If a SSH_PRIVATE_KEY is specified as a Pegasus Profile in the site catalog - Else the path on the local site- Specified by:
getPath
in interfaceCredentialHandler
- Parameters:
site
- the site handle- Returns:
- the path to SSH private key for the site.
-
getLocalPath
public java.lang.String getLocalPath()
Returns the path to user cred on the local site. The order of preference is as follows - If a SSH_PRIVATE_KEY is specified in the site catalog entry as a Pegasus Profile that is used, else the corresponding env profile for backward support - Else the Pegasus Profile SSH_PRIVATE_KEY specified in the properties, else the corresponding env profile for backward support - Else the one pointed to by the environment variable SSH_PRIVATE_KEY- Parameters:
site
- the site catalog entry object.- Returns:
- the path to user cred.
-
getBaseName
public java.lang.String getBaseName(java.lang.String site)
returns the basename of the path to the local credential- Specified by:
getBaseName
in interfaceCredentialHandler
- Parameters:
site
- the site handle- Returns:
-
getProfileKey
public java.lang.String getProfileKey()
Returns the env or pegasus profile key that needs to be associated for the credential.- Specified by:
getProfileKey
in interfaceCredentialHandler
- Returns:
- the name of the environment variable.
-
getEnvironmentVariable
public java.lang.String getEnvironmentVariable(java.lang.String site)
Returns the name of the environment variable that needs to be set for the job associated with the credential.- Specified by:
getEnvironmentVariable
in interfaceCredentialHandler
- Returns:
- the name of the environment variable.
-
getDescription
public java.lang.String getDescription()
Returns the description for the implementing handler- Specified by:
getDescription
in interfaceCredentialHandler
- Returns:
- description
-
-