com.xebialabs.xltest.jenkins

Class JenkinsConnection

java.lang.Object

com.xebialabs.overthere.spi.BaseOverthereConnection

com.xebialabs.xltest.jenkins.JenkinsConnection

All Implemented Interfaces:

com.xebialabs.overthere.OverthereConnection, com.xebialabs.overthere.spi.OverthereConnectionBuilder, java.io.Closeable, java.lang.AutoCloseable

public class JenkinsConnection
extends com.xebialabs.overthere.spi.BaseOverthereConnection
implements com.xebialabs.overthere.spi.OverthereConnectionBuilder

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	JenkinsConnection.JenkinsOverthereProcess

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	JENKINS_PROTOCOL
static java.lang.String	JOB_NAME The name of the job.
static java.lang.String	JOB_PARAMETERS Additional parameters needed for teh Job, such as browser, environment, tags, ....
static java.lang.String	TIMEOUT
static java.lang.String	UNIQUE_ID_PARAMETER This parameter is set so we can track the job, based on the parameter provided.

Fields inherited from class com.xebialabs.overthere.spi.BaseOverthereConnection

canStartProcess, connectionTimeoutMillis, deleteTemporaryDirectoryOnDisconnect, mapper, options, os, protocol, random, streamBufferSize, temporaryDirectoryPath, temporaryFileCreationRetries, temporaryFileHolderDirectories, temporaryFileHolderDirectoryNamePrefix, temporaryFileHolderDirectoryNameSuffix, workingDirectory

Constructor Summary

Constructors

Constructor and Description
JenkinsConnection(java.lang.String protocol, com.xebialabs.overthere.ConnectionOptions options, com.xebialabs.overthere.spi.AddressPortMapper mapper)

Method Summary

Methods

Modifier and Type	Method and Description
int	buildJob(java.util.Map<java.lang.String,java.lang.Object> parameters)
com.xebialabs.overthere.OverthereConnection	connect()
protected void	doClose()
protected java.io.File	downloadJenkinsWorkspace(java.lang.String hostPath)
void	execute(java.util.Map<java.lang.String,java.lang.Object> parameters)
protected void	extract(java.io.File baseDir, java.io.InputStream is)
java.io.File	getAbsoluteFileInLocalWorkspaceDirectory(java.lang.String path)
com.xebialabs.overthere.OverthereFile	getFile(com.xebialabs.overthere.OverthereFile parent, java.lang.String child)
com.xebialabs.overthere.OverthereFile	getFile(java.lang.String hostPath)
com.xebialabs.overthere.OverthereFile	getFileForTempFile(com.xebialabs.overthere.OverthereFile parent, java.lang.String name)
com.xebialabs.overthere.OverthereProcess	startProcess(com.xebialabs.overthere.CmdLine commandLine) Starts a command with its argument and returns control to the caller.
com.xebialabs.overthere.OverthereProcess	startProcess(java.util.Map<java.lang.String,java.lang.Object> jobParameters)
java.lang.String	toString()

Methods inherited from class com.xebialabs.overthere.spi.BaseOverthereConnection

canStartProcess, close, connected, equals, execute, execute, execute, finalize, getHostOperatingSystem, getOptions, getTempFile, getTempFile, getWorkingDirectory, hashCode, setWorkingDirectory

Methods inherited from class java.lang.Object

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

Field Detail

JENKINS_PROTOCOL

public static final java.lang.String JENKINS_PROTOCOL

See Also:

Constant Field Values

JOB_NAME

public static final java.lang.String JOB_NAME

The name of the job.

See Also:

Constant Field Values

UNIQUE_ID_PARAMETER

public static final java.lang.String UNIQUE_ID_PARAMETER

This parameter is set so we can track the job, based on the parameter provided.

See Also:

Constant Field Values

JOB_PARAMETERS

public static final java.lang.String JOB_PARAMETERS

Additional parameters needed for teh Job, such as browser, environment, tags, ....

See Also:

Constant Field Values

TIMEOUT

public static final java.lang.String TIMEOUT

See Also:

Constant Field Values

Constructor Detail

JenkinsConnection

public JenkinsConnection(java.lang.String protocol,
                 com.xebialabs.overthere.ConnectionOptions options,
                 com.xebialabs.overthere.spi.AddressPortMapper mapper)

Method Detail

getFile

public com.xebialabs.overthere.OverthereFile getFile(java.lang.String hostPath)

Specified by:

getFile in interface com.xebialabs.overthere.OverthereConnection

getFile

public com.xebialabs.overthere.OverthereFile getFile(com.xebialabs.overthere.OverthereFile parent,
                                            java.lang.String child)

Specified by:

getFile in interface com.xebialabs.overthere.OverthereConnection

execute

public void execute(java.util.Map<java.lang.String,java.lang.Object> parameters)

startProcess

public com.xebialabs.overthere.OverthereProcess startProcess(com.xebialabs.overthere.CmdLine commandLine)

Starts a command with its argument and returns control to the caller.

Specified by:

startProcess in interface com.xebialabs.overthere.OverthereConnection

Overrides:

startProcess in class com.xebialabs.overthere.spi.BaseOverthereConnection

Parameters:

commandLine - the command line to execute.

Returns:

an object representing the executing command or null if this is not supported by the host connection.

startProcess

public com.xebialabs.overthere.OverthereProcess startProcess(java.util.Map<java.lang.String,java.lang.Object> jobParameters)

connect

public com.xebialabs.overthere.OverthereConnection connect()

Specified by:

connect in interface com.xebialabs.overthere.spi.OverthereConnectionBuilder

doClose

protected void doClose()

Specified by:

doClose in class com.xebialabs.overthere.spi.BaseOverthereConnection

getFileForTempFile

public com.xebialabs.overthere.OverthereFile getFileForTempFile(com.xebialabs.overthere.OverthereFile parent,
                                                       java.lang.String name)

Specified by:

getFileForTempFile in class com.xebialabs.overthere.spi.BaseOverthereConnection

toString

public java.lang.String toString()

Specified by:

toString in interface com.xebialabs.overthere.OverthereConnection

Specified by:

toString in class com.xebialabs.overthere.spi.BaseOverthereConnection

downloadJenkinsWorkspace

protected java.io.File downloadJenkinsWorkspace(java.lang.String hostPath)

extract

protected void extract(java.io.File baseDir,
           java.io.InputStream is)
                throws java.io.IOException

Throws:

java.io.IOException

buildJob

public int buildJob(java.util.Map<java.lang.String,java.lang.Object> parameters)

getAbsoluteFileInLocalWorkspaceDirectory

public java.io.File getAbsoluteFileInLocalWorkspaceDirectory(java.lang.String path)