Package com.atlassian.bamboo.specs.builders.task

Class BaseSshTask<T extends BaseSshTask<T,E>,E extends BaseSshTaskProperties>

java.lang.Object

com.atlassian.bamboo.specs.api.builders.EntityPropertiesBuilder<P>

com.atlassian.bamboo.specs.api.builders.task.Task<T,E>

com.atlassian.bamboo.specs.builders.task.BaseSshTask<T,E>

Direct Known Subclasses:

ScpTask, SshTask

public abstract class BaseSshTask<T extends BaseSshTask<T,E>,E extends BaseSshTaskProperties>
extends Task<T,E>

Field Summary

Fields

Modifier and Type	Field	Description
protected BaseSshTaskProperties.AuthenticationType	authenticationType
protected @Nullable String	hostFingerprint
protected List<String>	hosts
protected @Nullable String	key
protected @Nullable String	passphrase
protected @Nullable String	password
protected int	port
protected @Nullable SharedCredentialsIdentifierProperties	sharedCredentials
protected String	username

Fields inherited from class com.atlassian.bamboo.specs.api.builders.task.Task

conditions, description, requirements, taskEnabled

Constructor Summary

Constructors

Constructor	Description
BaseSshTask()

Method Summary

Modifier and Type	Method	Description
T	authenticateWithKey(@NotNull String key)	Authenticate with key (without passphrase).
T	authenticateWithKey(@NotNull Path keyPath)	Authenticate with key (without passphrase).
T	authenticateWithKeyWithPassphrase(@NotNull String key, @NotNull String passphrase)	Authenticate with key with passphrase.
T	authenticateWithKeyWithPassphrase(@NotNull Path keyPath, @NotNull String passphrase)	Authenticate with key with passphrase.
T	authenticateWithPassword(@NotNull String password)	Authenticate with password associated with username username(String).
T	authenticateWithSshSharedCredentials(@NotNull SharedCredentialsIdentifier sharedCredentials)
T	authenticateWithUsernamePasswordSharedCredentials(@NotNull SharedCredentialsIdentifier sharedCredentials)
boolean	equals(Object o)
int	hashCode()
T	host(@NotNull String host)	Hostname or IP address of the remote host.
T	host(@NotNull String... host)	Hostnames or IP addresses of the remote hosts.
T	hostFingerprint(@NotNull String hostFingerprint)	Set public key fingerprint.
T	port(int port)	Set the port number of the remote host that is used for the SSH connection.
T	portDefault()	Set the port number of the remote host to the default value (22).
T	username(@NotNull String username)	Username you want to use to access the remote host.

Methods inherited from class com.atlassian.bamboo.specs.api.builders.task.Task

build, conditions, description, enabled, requirements, toString

Methods inherited from class java.lang.Object

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

Field Detail

hosts

protected List<String> hosts

username

protected String username

authenticationType

protected BaseSshTaskProperties.AuthenticationType authenticationType

password

@Nullable
protected @Nullable String password

key

@Nullable
protected @Nullable String key

passphrase

@Nullable
protected @Nullable String passphrase

hostFingerprint

@Nullable
protected @Nullable String hostFingerprint

port

protected int port

sharedCredentials

@Nullable
protected @Nullable SharedCredentialsIdentifierProperties sharedCredentials

Constructor Detail

BaseSshTask

public BaseSshTask()

Method Detail

host

public T host(@NotNull
              @NotNull String host)

Hostname or IP address of the remote host.

host

public T host(@NotNull
              @NotNull String... host)

Hostnames or IP addresses of the remote hosts.

username

public T username(@NotNull
                  @NotNull String username)

Username you want to use to access the remote host.

authenticateWithPassword

public T authenticateWithPassword(@NotNull
                                  @NotNull String password)

Authenticate with password associated with username username(String).

authenticateWithKeyWithPassphrase

public T authenticateWithKeyWithPassphrase(@NotNull
                                           @NotNull String key,
                                           @NotNull
                                           @NotNull String passphrase)

Authenticate with key with passphrase.

Parameters:

key - - SSH private key

passphrase - - SSH passphrase

authenticateWithKeyWithPassphrase

public T authenticateWithKeyWithPassphrase(@NotNull
                                           @NotNull Path keyPath,
                                           @NotNull
                                           @NotNull String passphrase)

Authenticate with key with passphrase.

Parameters:

keyPath - - path to SSH private key

passphrase - - SSH passphrase

authenticateWithKey

public T authenticateWithKey(@NotNull
                             @NotNull String key)

Authenticate with key (without passphrase).

Parameters:

key - - SSH private key

authenticateWithKey

public T authenticateWithKey(@NotNull
                             @NotNull Path keyPath)

Authenticate with key (without passphrase).

Parameters:

keyPath - - path to SSH private key

authenticateWithSshSharedCredentials

public T authenticateWithSshSharedCredentials(@NotNull
                                              @NotNull SharedCredentialsIdentifier sharedCredentials)

authenticateWithUsernamePasswordSharedCredentials

public T authenticateWithUsernamePasswordSharedCredentials(@NotNull
                                                           @NotNull SharedCredentialsIdentifier sharedCredentials)

hostFingerprint

public T hostFingerprint(@NotNull
                         @NotNull String hostFingerprint)

Set public key fingerprint.

port

public T port(int port)

Set the port number of the remote host that is used for the SSH connection. The default value is 22.

See Also:

portDefault()

portDefault

public T portDefault()

Set the port number of the remote host to the default value (22).

See Also:

portDefault()

equals

public boolean equals(Object o)

Overrides:

equals in class Task<T extends BaseSshTask<T,E>,E extends BaseSshTaskProperties>

hashCode

public int hashCode()

Overrides:

hashCode in class Task<T extends BaseSshTask<T,E>,E extends BaseSshTaskProperties>