io.parallec.core.bean.ssh

Class SshMeta

java.lang.Object

io.parallec.core.bean.ssh.SshMeta

public class SshMeta
extends Object

all ssh metadata except for the target host name. also those timeout configs and

Author:

Yuanteng (Jeff) Pei

Constructor Summary

Constructors

Constructor and Description
SshMeta() Instantiates a new ssh meta.
SshMeta(String commandLine, String userName, int sshPort, SshLoginType sshLoginType, String privKeyRelativePath, String password, boolean privKeyUsePassphrase, String passphrase, int sshConnectionTimeoutMillis, boolean runAsSuperUser) Instantiates a new ssh meta.

Method Summary

Modifier and Type	Method and Description
String	getCommandLine() Gets the command line.
String	getPassphrase() Gets the passphrase.
String	getPassword() Gets the password.
String	getPrivKeyAbsPath() Gets the priv key abs path.
String	getPrivKeyRelativePath() Gets the priv key relative path.
int	getSshConnectionTimeoutMillis() Gets the ssh connection timeout millis.
SshLoginType	getSshLoginType() Gets the ssh login type.
int	getSshPort() Gets the ssh port.
String	getUserName() Gets the user name.
boolean	isPrivKeyUsePassphrase() Checks if is priv key use passphrase.
boolean	isRunAsSuperUser() Checks if is run as super user.
void	setCommandLine(String commandLine) Sets the command line.
void	setPassphrase(String passphrase) Sets the passphrase.
void	setPassword(String password) Sets the password.
void	setPrivKeyRelativePath(String privKeyRelativePath) Sets the priv key relative path.
void	setPrivKeyUsePassphrase(boolean privKeyUsePassphrase) Sets the priv key use passphrase.
void	setRunAsSuperUser(boolean runAsSuperUser) Sets the runAsSuperUser.
void	setSshConnectionTimeoutMillis(int sshConnectionTimeoutMillis) Sets the ssh connection timeout millis.
void	setSshLoginType(SshLoginType sshLoginType) Sets the ssh login type.
void	setSshPort(int sshPort) Sets the ssh port.
void	setUserName(String userName) Sets the user name.
boolean	validation() Validation.

Methods inherited from class java.lang.Object

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

Constructor Detail

SshMeta

public SshMeta(String commandLine,
               String userName,
               int sshPort,
               SshLoginType sshLoginType,
               String privKeyRelativePath,
               String password,
               boolean privKeyUsePassphrase,
               String passphrase,
               int sshConnectionTimeoutMillis,
               boolean runAsSuperUser)

Instantiates a new ssh meta.

Parameters:

commandLine - the command line

userName - the user name

sshPort - the ssh port

sshLoginType - the ssh login type

privKeyRelativePath - the priv key relative path

password - the password

privKeyUsePassphrase - the priv key use passphrase

passphrase - the passphrase

sshConnectionTimeoutMillis - the ssh connection timeout millis

runAsSuperUser - if the ssh will be run as superuser.

SshMeta

public SshMeta()

Instantiates a new ssh meta. timeout using the default one: sshConnectionTimeoutMillis

Method Detail

isPrivKeyUsePassphrase

public boolean isPrivKeyUsePassphrase()

Checks if is priv key use passphrase.

Returns:

true, if is priv key use passphrase

setPrivKeyUsePassphrase

public void setPrivKeyUsePassphrase(boolean privKeyUsePassphrase)

Sets the priv key use passphrase.

Parameters:

privKeyUsePassphrase - the new priv key use passphrase

getPassphrase

public String getPassphrase()

Gets the passphrase.

Returns:

the passphrase

setPassphrase

public void setPassphrase(String passphrase)

Sets the passphrase.

Parameters:

passphrase - the new passphrase

isRunAsSuperUser

public boolean isRunAsSuperUser()

Checks if is run as super user.

Returns:

true, if is run as super user

setRunAsSuperUser

public void setRunAsSuperUser(boolean runAsSuperUser)

Sets the runAsSuperUser.

Parameters:

runAsSuperUser - the new runAsSuperUser

validation

public boolean validation()
                   throws ParallelTaskInvalidException

Validation.

Returns:

true, if successful

Throws:

ParallelTaskInvalidException - the parallel task invalid exception

getCommandLine

public String getCommandLine()

Gets the command line.

Returns:

the command line

setCommandLine

public void setCommandLine(String commandLine)

Sets the command line.

Parameters:

commandLine - the new command line

getPassword

public String getPassword()

Gets the password.

Returns:

the password

setPassword

public void setPassword(String password)

Sets the password.

Parameters:

password - the new password

getSshLoginType

public SshLoginType getSshLoginType()

Gets the ssh login type.

Returns:

the ssh login type

setSshLoginType

public void setSshLoginType(SshLoginType sshLoginType)

Sets the ssh login type.

Parameters:

sshLoginType - the new ssh login type

getSshPort

public int getSshPort()

Gets the ssh port.

Returns:

the ssh port

setSshPort

public void setSshPort(int sshPort)

Sets the ssh port.

Parameters:

sshPort - the new ssh port

getPrivKeyRelativePath

public String getPrivKeyRelativePath()

Gets the priv key relative path.

Returns:

the priv key relative path

setPrivKeyRelativePath

public void setPrivKeyRelativePath(String privKeyRelativePath)

Sets the priv key relative path.

Parameters:

privKeyRelativePath - the new priv key relative path

getUserName

public String getUserName()

Gets the user name.

Returns:

the user name

setUserName

public void setUserName(String userName)

Sets the user name.

Parameters:

userName - the new user name

getPrivKeyAbsPath

public String getPrivKeyAbsPath()

Gets the priv key abs path.

Returns:

the priv key abs path

getSshConnectionTimeoutMillis

public int getSshConnectionTimeoutMillis()

Gets the ssh connection timeout millis.

Returns:

the ssh connection timeout millis

setSshConnectionTimeoutMillis

public void setSshConnectionTimeoutMillis(int sshConnectionTimeoutMillis)

Sets the ssh connection timeout millis.

Parameters:

sshConnectionTimeoutMillis - the new ssh connection timeout millis