Package hudson.scm.api.command

Class BasicAPICommand

java.lang.Object

hudson.scm.api.command.BasicAPICommand

All Implemented Interfaces:

IAPICommand

Direct Known Subclasses:

AddProjectLabelCommand, CheckPointCommand, CloseCPCommand, CreateCPCommand, EditIssuesCommand, EditResultsCommand, IssuesCommand, LockCommand, ProjectAddCommand, ProjectCheckinCommand, ProjectCheckoutCommand, ProjectCPDiffCommand, ProjectInfoCommand, RelationshipsCommand, RevisionInfoCommand, SubmitCPCommand, UnlockCommand, ViewCPCommand, ViewProjectCommand

public abstract class BasicAPICommand
extends Object
implements IAPICommand

All Jenkins Integrity API Commands have to extend this class in order to execute Integrity API calls using the default method

Version:

$Revision: $

Author:

Author: asen

Field Summary

Fields

Modifier and Type	Field	Description
protected com.mks.api.Command	cmd
protected Map<String,Object>	commandHelperObjects
protected static final Logger	LOGGER
protected com.mks.api.response.Response	res
protected boolean	runCommandWithInterim
protected final IntegrityConfigurable	serverConfig

Fields inherited from interface hudson.scm.api.command.IAPICommand

ADD_PROJECT_LABEL_COMMAND, CHECKPOINT_COMMAND, CLOSE_CP_COMMAND, CREATE_CP_COMMAND, EDIT_ISSUE_COMMAND, EDIT_RESULT_COMMAND, ISSUES_COMMAND, LOCK_COMMAND, PROJECT_ADD_COMMAND, PROJECT_CHECKIN_COMMAND, PROJECT_CHECKOUT_COMMAND, PROJECT_CPDIFF_COMMAND, PROJECT_INFO_COMMAND, RELATIONSHIPS_COMMAND, REVISION_INFO_COMMAND, SUBMIT_CP_COMMAND, UNLOCK_COMMAND, VIEW_CP_COMMAND, VIEW_PROJECT_COMMAND

Constructor Summary

Constructors

Constructor	Description
BasicAPICommand()
BasicAPICommand(IntegrityConfigurable serverConfig)	Constructor initialized with serverconfig id for commands to fire to a particular Integrity server

Method Summary

Modifier and Type	Method	Description
void	addAdditionalParameters(String paramName, Object param)	Objects required for command pre and post processing.
void	addOption(IAPIOption option)
void	addSelection(String param)
void	doPostAction()	Do actions post the Integrity API call specifically for Jenkins functionality
void	doPreAction()	Do actions pre the Integrity API call specifically for Jenkins functionality
com.mks.api.response.Response	execute()	Default way to execute the command using an auto-generated Integrity Session API
com.mks.api.response.Response	execute(ISession api)	Execute the command using Integrity Session API
void	terminateAPI()	Function to explicitly terminate/return sessions to Session Pool for WITH_INTERIM commands

Methods inherited from class java.lang.Object

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

Field Details

LOGGER

protected static final Logger LOGGER

cmd

protected com.mks.api.Command cmd

commandHelperObjects

protected Map<String,Object> commandHelperObjects

res

protected com.mks.api.response.Response res

runCommandWithInterim

protected boolean runCommandWithInterim

serverConfig

protected final IntegrityConfigurable serverConfig

Constructor Details

BasicAPICommand

public BasicAPICommand(IntegrityConfigurable serverConfig)

Constructor initialized with serverconfig id for commands to fire to a particular Integrity server

Parameters:

serverConfig -

BasicAPICommand

public BasicAPICommand()

Method Details

execute

public com.mks.api.response.Response execute(ISession api)
                                      throws com.mks.api.response.APIException

Description copied from interface: IAPICommand

Execute the command using Integrity Session API

Specified by:

execute in interface IAPICommand

Parameters:

api -

Throws:

com.mks.api.response.APIException

execute

public com.mks.api.response.Response execute()
                                      throws com.mks.api.response.APIException,
hudson.AbortException

Description copied from interface: IAPICommand

Default way to execute the command using an auto-generated Integrity Session API

Specified by:

execute in interface IAPICommand

Returns:

Throws:

com.mks.api.response.APIException

hudson.AbortException

addOption

public void addOption(IAPIOption option)

Specified by:

addOption in interface IAPICommand

Parameters:

option -

addSelection

public void addSelection(String param)

Specified by:

addSelection in interface IAPICommand

Parameters:

param -

doPostAction

public void doPostAction()

Description copied from interface: IAPICommand

Do actions post the Integrity API call specifically for Jenkins functionality

Specified by:

doPostAction in interface IAPICommand

doPreAction

public void doPreAction()

Description copied from interface: IAPICommand

Do actions pre the Integrity API call specifically for Jenkins functionality

Specified by:

doPreAction in interface IAPICommand

addAdditionalParameters

public void addAdditionalParameters(String paramName,
 Object param)

Description copied from interface: IAPICommand

Objects required for command pre and post processing.

Specified by:

addAdditionalParameters in interface IAPICommand

terminateAPI

public void terminateAPI()
                  throws Exception

Description copied from interface: IAPICommand

Function to explicitly terminate/return sessions to Session Pool for WITH_INTERIM commands

Specified by:

terminateAPI in interface IAPICommand

Throws:

Exception