de.smartics.ci.comm.hudson.command
Class HudsonGenericJobCommand

java.lang.Object
  de.smartics.ci.comm.command.AbstractCommand<T>
      de.smartics.ci.comm.command.AbstractJobCommand<T>
          de.smartics.ci.comm.command.AbstractGenericJobCommand<T>
              de.smartics.ci.comm.hudson.command.AbstractHudsonApiJob<HudsonGenericJobCommand>
                  de.smartics.ci.comm.hudson.command.HudsonGenericJobCommand

All Implemented Interfaces:

Command< HudsonGenericJobCommand>

public final class HudsonGenericJobCommand
     
     

      
      extends 
      
      AbstractHudsonApiJob<
      
      HudsonGenericJobCommand>
     
     

Check status job command.

Field Summary

Fields inherited from class de.smartics.ci.comm.hudson.command.AbstractHudsonApiJob

commandResult, properties, xmlQueryString

Fields inherited from class de.smartics.ci.comm.command.AbstractJobCommand

jobName

Fields inherited from class de.smartics.ci.comm.command.AbstractCommand

ERROR_CATEGORY_DESTINGUISHER, logLevel

Constructor Summary

HudsonGenericJobCommand()
Default constructor.

HudsonGenericJobCommand(String jobName)
Default constructor.

Method Summary

protected void	checkResponseString(String response) Check the response.
void	execute(CiSystem target) Executes the command.
void	setCiXmlJobApiUrl(String ciXmlJobApiUrl) Sets the ci xml job api URL.
void	setResponseCheckingRegexp(String regexp) Sets the regexp used to check if the response is valid.

Methods inherited from class de.smartics.ci.comm.hudson.command.AbstractHudsonApiJob

createResult, getResult, logResponse, resolve, setKeyValuePairs, setXmlQueryString

Methods inherited from class de.smartics.ci.comm.command.AbstractJobCommand

buildCiJobApiUrl, setJobName

Methods inherited from class de.smartics.ci.comm.command.AbstractCommand

addRequestHeaders, buildQueryString, checkParameterNotBlank, checkResult, checkResultRegardingRedirect, fetchDelimiter, setLogLevel

Methods inherited from class java.lang.Object

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

Constructor Detail

HudsonGenericJobCommand

public HudsonGenericJobCommand(String jobName)

Default constructor.

Parameters:

jobName - the name of the job that shall be checked.

HudsonGenericJobCommand

public HudsonGenericJobCommand()

Default constructor. Sets jobName to null. Must be set before using this command.

Method Detail

setCiXmlJobApiUrl

public void setCiXmlJobApiUrl(String ciXmlJobApiUrl)

Sets the ci xml job api URL.

Parameters:

ciXmlJobApiUrl - the ci xml job api URL.

setResponseCheckingRegexp

public void setResponseCheckingRegexp(String regexp)

Sets the regexp used to check if the response is valid. If the regexp matches the response is treated as OK (true) but only if the response code (HTTP response code) is 2xx or 3xx.

Parameters:

regexp - the regexp used to check the response.

execute

public void execute(CiSystem target)
             throws CommandException

Description copied from class: AbstractGenericJobCommand

Executes the command.

Specified by:

execute in interface Command<HudsonGenericJobCommand>

Specified by:

execute in class AbstractGenericJobCommand<HudsonGenericJobCommand>

Parameters:

target - the target to execute the command against.

Throws:

CommandException - signals problems encountered while executing the command.

checkResponseString

protected void checkResponseString(String response)
                            throws CommandException

Check the response.

Overrides:

checkResponseString in class AbstractHudsonApiJob<HudsonGenericJobCommand>

Parameters:

response - the response.

Throws:

CommandException - when command failed.