hudson.plugins.synergy.impl

Class StartCommand

java.lang.Object

hudson.plugins.synergy.impl.Command

hudson.plugins.synergy.impl.StartCommand

public class StartCommand
extends Command

A start session command. A start session command returns the CCM_ADDR to use for the following commands.

Constructor Summary

Constructors

Constructor and Description
StartCommand(String database, String engine, String login, String password, boolean remoteClient, String pathName, boolean isUnix) Builds a start session command.

Method Summary

Methods

Modifier and Type	Method and Description
void	addCcmAddrToSessionMapFile(hudson.FilePath ccmSessionMapFile)
String[]	buildCommand(String ccmAddr) Return the Synergy command line to execute as an array.
boolean[]	buildMask() Build a mask of values in the command line that should not be logged.
String	getCcmAddr()
boolean	isStatusOK(int status, String result) Return true if the given return status is ok for the command.
void	parseResult(String result) Parse the command result.

Methods inherited from class java.lang.Object

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

Constructor Detail

StartCommand

public StartCommand(String database,
            String engine,
            String login,
            String password,
            boolean remoteClient,
            String pathName,
            boolean isUnix)

Builds a start session command. A start session command returns the CCM_ADDR to use for the following commands.

Parameters:

database - The database path

login - The user login

password - The user password

remoteClient - Use remote client flag

pathName - The path name

Method Detail

buildCommand

public String[] buildCommand(String ccmAddr)

Description copied from class: Command

Return the Synergy command line to execute as an array. The line must start with the ccmExe location, which is given as the first method parameter.

Specified by:

buildCommand in class Command

buildMask

public boolean[] buildMask()

Description copied from class: Command

Build a mask of values in the command line that should not be logged.

Overrides:

buildMask in class Command

parseResult

public void parseResult(String result)

Description copied from class: Command

Parse the command result.

Specified by:

parseResult in class Command

getCcmAddr

public String getCcmAddr()

isStatusOK

public boolean isStatusOK(int status,
                 String result)

Description copied from class: Command

Return true if the given return status is ok for the command. The default is to return true if the status is 0 or 1 with empty output. Testing only on 0 is not enough for "ccm query" commands as they return 1 for no result. Testing 0 or 1 is not enough for "ccm query" commands as they return 1 for failure.

Overrides:

isStatusOK in class Command

Parameters:

status - The ccm process return code

result - The ccm process output

addCcmAddrToSessionMapFile

public void addCcmAddrToSessionMapFile(hudson.FilePath ccmSessionMapFile)
                                throws IOException,
                                       InterruptedException

Throws:

IOException

InterruptedException