Package jenkins.plugins.publish_over_ssh

Class BapSshHostConfiguration

java.lang.Object

jenkins.plugins.publish_over.BPHostConfiguration<BapSshClient,BapSshCommonConfiguration>

jenkins.plugins.publish_over_ssh.BapSshHostConfiguration

All Implemented Interfaces:

Describable<BapSshHostConfiguration>, Serializable

public class BapSshHostConfiguration
extends jenkins.plugins.publish_over.BPHostConfiguration<BapSshClient,BapSshCommonConfiguration>
implements Describable<BapSshHostConfiguration>

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONFIG_KEY_PREFERRED_AUTHENTICATIONS
static final boolean	DEFAULT_AVOID_SAME_FILES_UPLOAD
static final String	DEFAULT_JUMP_HOST
static final int	DEFAULT_PORT
static final int	DEFAULT_TIMEOUT
static final String	HTTP_PROXY_TYPE
static final String	SOCKS_4_PROXY_TYPE
static final String	SOCKS_5_PROXY_TYPE

Constructor Summary

Constructors

Constructor	Description
BapSshHostConfiguration()
BapSshHostConfiguration(String name, String hostname, String username, String encryptedPassword, String remoteRootDir, int port, int timeout, boolean overrideKey, String keyPath, String key, boolean disableExec, boolean avoidSameFileUploads, String proxyHost, int proxyPort, String proxyUser, String secretProxyPassword, String proxyType)

Method Summary

Modifier and Type	Method	Description
protected org.apache.commons.lang.builder.EqualsBuilder	addToEquals(org.apache.commons.lang.builder.EqualsBuilder builder, BapSshHostConfiguration that)
protected org.apache.commons.lang.builder.HashCodeBuilder	addToHashCode(org.apache.commons.lang.builder.HashCodeBuilder builder)
protected org.apache.commons.lang.builder.ToStringBuilder	addToToString(org.apache.commons.lang.builder.ToStringBuilder builder)
BapSshClient	createClient(jenkins.plugins.publish_over.BPBuildInfo buildInfo)
BapSshClient	createClient(jenkins.plugins.publish_over.BPBuildInfo buildInfo, boolean connectSftp)
BapSshClient	createClient(jenkins.plugins.publish_over.BPBuildInfo buildInfo, jenkins.plugins.publish_over.BapPublisher publisher)
protected com.jcraft.jsch.JSch	createJSch()
boolean	equals(Object that)
BapSshHostConfigurationDescriptor	getDescriptor()
final String	getEncryptedPassword()
String	getJumpHost()
String	getKey()
String	getKeyPath()
String	getName()
protected final String	getPassword()
String	getProxyHost()
String	getProxyPassword()
int	getProxyPort()
String	getProxyType()
String	getProxyUser()
Secret	getSecretProxyPassword()
int	getTimeout()
int	hashCode()
boolean	isAvoidSameFileUploads()
boolean	isDisableExec()
boolean	isEffectiveDisableExec()
boolean	isOverrideKey()
Object	readResolve()
void	setDisableExec(boolean disableExec)
void	setEncryptedPassword(String encryptedPassword)
void	setHostname(String hostname)
void	setJumpHost(String jumpHost)
void	setKey(String key)
void	setKeyPath(String keyPath)
void	setOverrideKey(boolean overrideKey)
final void	setPassword(String password)
void	setPort(int port)
void	setProxyHost(String proxyHost)
void	setProxyPassword(String proxyPassword)
void	setProxyPort(int proxyPort)
void	setProxyType(String proxyType)
void	setProxyUser(String proxyUser)
void	setRemoteRootDir(String remoteRootDir)
void	setSecretProxyPassword(Secret secretProxyPassword)
void	setTimeout(int timeout)
String	toString()

Methods inherited from class jenkins.plugins.publish_over.BPHostConfiguration

addToEquals, changeToRootDirectory, exception, getCommonConfig, getHostname, getHostnameTrimmed, getPort, getRemoteRootDir, getUsername, isDirectoryAbsolute, setCommonConfig, setName, setUsername

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

DEFAULT_PORT

public static final int DEFAULT_PORT

See Also:

• Constant Field Values

DEFAULT_TIMEOUT

public static final int DEFAULT_TIMEOUT

See Also:

• Constant Field Values

CONFIG_KEY_PREFERRED_AUTHENTICATIONS

public static final String CONFIG_KEY_PREFERRED_AUTHENTICATIONS

See Also:

• Constant Field Values

DEFAULT_JUMP_HOST

public static final String DEFAULT_JUMP_HOST

See Also:

• Constant Field Values

HTTP_PROXY_TYPE

public static final String HTTP_PROXY_TYPE

See Also:

• Constant Field Values

SOCKS_4_PROXY_TYPE

public static final String SOCKS_4_PROXY_TYPE

See Also:

• Constant Field Values

SOCKS_5_PROXY_TYPE

public static final String SOCKS_5_PROXY_TYPE

See Also:

• Constant Field Values

DEFAULT_AVOID_SAME_FILES_UPLOAD

public static final boolean DEFAULT_AVOID_SAME_FILES_UPLOAD

See Also:

• Constant Field Values

Constructor Details

BapSshHostConfiguration

public BapSshHostConfiguration()

BapSshHostConfiguration

@DataBoundConstructor
public BapSshHostConfiguration(String name,
 String hostname,
 String username,
 String encryptedPassword,
 String remoteRootDir,
 int port,
 int timeout,
 boolean overrideKey,
 String keyPath,
 String key,
 boolean disableExec,
 boolean avoidSameFileUploads,
 String proxyHost,
 int proxyPort,
 String proxyUser,
 String secretProxyPassword,
 String proxyType)

Method Details

setJumpHost

@DataBoundSetter
public void setJumpHost(String jumpHost)

getJumpHost

public String getJumpHost()

getName

public String getName()

Overrides:

getName in class jenkins.plugins.publish_over.BPHostConfiguration<BapSshClient,BapSshCommonConfiguration>

setHostname

@DataBoundSetter
public void setHostname(String hostname)

Overrides:

setHostname in class jenkins.plugins.publish_over.BPHostConfiguration<BapSshClient,BapSshCommonConfiguration>

setRemoteRootDir

@DataBoundSetter
public void setRemoteRootDir(String remoteRootDir)

Overrides:

setRemoteRootDir in class jenkins.plugins.publish_over.BPHostConfiguration<BapSshClient,BapSshCommonConfiguration>

setPort

@DataBoundSetter
public void setPort(int port)

Overrides:

setPort in class jenkins.plugins.publish_over.BPHostConfiguration<BapSshClient,BapSshCommonConfiguration>

getTimeout

public int getTimeout()

setTimeout

@DataBoundSetter
public void setTimeout(int timeout)

getPassword

protected final String getPassword()

Overrides:

getPassword in class jenkins.plugins.publish_over.BPHostConfiguration<BapSshClient,BapSshCommonConfiguration>

setPassword

public final void setPassword(String password)

Overrides:

setPassword in class jenkins.plugins.publish_over.BPHostConfiguration<BapSshClient,BapSshCommonConfiguration>

getEncryptedPassword

public final String getEncryptedPassword()

Overrides:

getEncryptedPassword in class jenkins.plugins.publish_over.BPHostConfiguration<BapSshClient,BapSshCommonConfiguration>

setEncryptedPassword

@DataBoundSetter
public void setEncryptedPassword(String encryptedPassword)

getKeyPath

public String getKeyPath()

setKeyPath

@DataBoundSetter
public void setKeyPath(String keyPath)

getKey

public String getKey()

setKey

@DataBoundSetter
public void setKey(String key)

isOverrideKey

public boolean isOverrideKey()

setOverrideKey

@DataBoundSetter
public void setOverrideKey(boolean overrideKey)

isDisableExec

public boolean isDisableExec()

setDisableExec

@DataBoundSetter
public void setDisableExec(boolean disableExec)

getProxyType

public String getProxyType()

getProxyHost

public String getProxyHost()

getProxyPort

public int getProxyPort()

getProxyUser

public String getProxyUser()

getProxyPassword

public String getProxyPassword()

getSecretProxyPassword

public Secret getSecretProxyPassword()

setProxyType

@DataBoundSetter
public void setProxyType(String proxyType)

setProxyHost

@DataBoundSetter
public void setProxyHost(String proxyHost)

setProxyPort

@DataBoundSetter
public void setProxyPort(int proxyPort)

setProxyUser

@DataBoundSetter
public void setProxyUser(String proxyUser)

setProxyPassword

@DataBoundSetter
public void setProxyPassword(String proxyPassword)

setSecretProxyPassword

@DataBoundSetter
public void setSecretProxyPassword(Secret secretProxyPassword)

isAvoidSameFileUploads

public boolean isAvoidSameFileUploads()

readResolve

public Object readResolve()

Overrides:

readResolve in class jenkins.plugins.publish_over.BPHostConfiguration<BapSshClient,BapSshCommonConfiguration>

isEffectiveDisableExec

public boolean isEffectiveDisableExec()

createClient

public BapSshClient createClient(jenkins.plugins.publish_over.BPBuildInfo buildInfo,
 jenkins.plugins.publish_over.BapPublisher publisher)

Overrides:

createClient in class jenkins.plugins.publish_over.BPHostConfiguration<BapSshClient,BapSshCommonConfiguration>

createClient

public BapSshClient createClient(jenkins.plugins.publish_over.BPBuildInfo buildInfo)

Specified by:

createClient in class jenkins.plugins.publish_over.BPHostConfiguration<BapSshClient,BapSshCommonConfiguration>

createClient

public BapSshClient createClient(jenkins.plugins.publish_over.BPBuildInfo buildInfo,
 boolean connectSftp)

createJSch

protected com.jcraft.jsch.JSch createJSch()

getDescriptor

public BapSshHostConfigurationDescriptor getDescriptor()

Specified by:

getDescriptor in interface Describable<BapSshHostConfiguration>

addToEquals

protected org.apache.commons.lang.builder.EqualsBuilder addToEquals(org.apache.commons.lang.builder.EqualsBuilder builder,
 BapSshHostConfiguration that)

addToHashCode

protected org.apache.commons.lang.builder.HashCodeBuilder addToHashCode(org.apache.commons.lang.builder.HashCodeBuilder builder)

Overrides:

addToHashCode in class jenkins.plugins.publish_over.BPHostConfiguration<BapSshClient,BapSshCommonConfiguration>

addToToString

protected org.apache.commons.lang.builder.ToStringBuilder addToToString(org.apache.commons.lang.builder.ToStringBuilder builder)

Overrides:

addToToString in class jenkins.plugins.publish_over.BPHostConfiguration<BapSshClient,BapSshCommonConfiguration>

equals

public boolean equals(Object that)

Overrides:

equals in class jenkins.plugins.publish_over.BPHostConfiguration<BapSshClient,BapSshCommonConfiguration>

hashCode

public int hashCode()

Overrides:

hashCode in class jenkins.plugins.publish_over.BPHostConfiguration<BapSshClient,BapSshCommonConfiguration>

toString

public String toString()

Overrides:

toString in class jenkins.plugins.publish_over.BPHostConfiguration<BapSshClient,BapSshCommonConfiguration>