com.google.jenkins.plugins.computeengine

Class WindowsConfiguration

java.lang.Object

com.google.jenkins.plugins.computeengine.WindowsConfiguration

public class WindowsConfiguration
extends Object

Class to contain information needed to configure and access Windows agents This avoids passing in several parameters between multiple classes and also isolates logic in accessing credentials

Constructor Summary

Constructors

Constructor and Description
WindowsConfiguration(String windowsUsername, String passwordCredentialsId, String privateKeyCredentialsId) Constructor for WindowsConfig

Method Summary

Modifier and Type	Method and Description
String	getPassword() Gets the password if a username and password credential is provided
com.cloudbees.plugins.credentials.common.StandardUsernameCredentials	getPrivateKeyCredentials() Returns the SSH private key if a SSH credential is provided
Optional<String>	getPrivateKeyCredentialsId() Returns the Optional for privateKeyCredentialsId.
String	getWindowsUsername() Getter for windowsUsername

Methods inherited from class java.lang.Object

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

Constructor Detail

WindowsConfiguration

public WindowsConfiguration(String windowsUsername,
                            String passwordCredentialsId,
                            String privateKeyCredentialsId)

Constructor for WindowsConfig

Parameters:

windowsUsername - Username of an existing account on the windows agent

passwordCredentialsId - Credentials Id of credential containing password for the account under windowsUsername

privateKeyCredentialsId - Credentials Id of credential containing private SSH key for account under windowsUsername

Method Detail

getWindowsUsername

public String getWindowsUsername()

Getter for windowsUsername

Returns:

windows username string

getPrivateKeyCredentialsId

public Optional<String> getPrivateKeyCredentialsId()

Returns the Optional for privateKeyCredentialsId. May be null if user provided password credentials instead

Returns:

getPassword

public String getPassword()

Gets the password if a username and password credential is provided

Returns:

password in plain text to use for SSH

getPrivateKeyCredentials

public com.cloudbees.plugins.credentials.common.StandardUsernameCredentials getPrivateKeyCredentials()

Returns the SSH private key if a SSH credential is provided

Returns:

SSH private key in plain text to use for SSH