hudson.scm.api.command

Interface IAPICommand

All Known Implementing Classes:

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

public interface IAPICommand

All Jenkins Integrity API command calls must extend this interface. A command is essentially a request that makes up what is logically an Integrity API call. Commands correspond to operations the user can perform with Integrity, for example checking out a project or applying a change package etc.

Author:

asen

Field Summary

Fields

Modifier and Type	Field and Description
static String	ADD_PROJECT_LABEL_COMMAND
static String	CHECKPOINT_COMMAND
static String	CLOSE_CP_COMMAND
static String	CREATE_CP_COMMAND
static String	EDIT_ISSUE_COMMAND
static String	EDIT_RESULT_COMMAND
static String	ISSUES_COMMAND
static String	LOCK_COMMAND
static String	PROJECT_ADD_COMMAND
static String	PROJECT_CHECKIN_COMMAND
static String	PROJECT_CHECKOUT_COMMAND
static String	PROJECT_CPDIFF_COMMAND
static String	PROJECT_INFO_COMMAND
static String	RELATIONSHIPS_COMMAND
static String	REVISION_INFO_COMMAND
static String	SUBMIT_CP_COMMAND
static String	UNLOCK_COMMAND
static String	VIEW_CP_COMMAND
static String	VIEW_PROJECT_COMMAND

Method Summary

Modifier and Type	Method and 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

Field Detail

PROJECT_CHECKOUT_COMMAND

static final String PROJECT_CHECKOUT_COMMAND

See Also:

Constant Field Values

PROJECT_CHECKIN_COMMAND

static final String PROJECT_CHECKIN_COMMAND

See Also:

Constant Field Values

PROJECT_INFO_COMMAND

static final String PROJECT_INFO_COMMAND

See Also:

Constant Field Values

PROJECT_CPDIFF_COMMAND

static final String PROJECT_CPDIFF_COMMAND

See Also:

Constant Field Values

VIEW_PROJECT_COMMAND

static final String VIEW_PROJECT_COMMAND

See Also:

Constant Field Values

REVISION_INFO_COMMAND

static final String REVISION_INFO_COMMAND

See Also:

Constant Field Values

LOCK_COMMAND

static final String LOCK_COMMAND

See Also:

Constant Field Values

PROJECT_ADD_COMMAND

static final String PROJECT_ADD_COMMAND

See Also:

Constant Field Values

UNLOCK_COMMAND

static final String UNLOCK_COMMAND

See Also:

Constant Field Values

CREATE_CP_COMMAND

static final String CREATE_CP_COMMAND

See Also:

Constant Field Values

CLOSE_CP_COMMAND

static final String CLOSE_CP_COMMAND

See Also:

Constant Field Values

SUBMIT_CP_COMMAND

static final String SUBMIT_CP_COMMAND

See Also:

Constant Field Values

VIEW_CP_COMMAND

static final String VIEW_CP_COMMAND

See Also:

Constant Field Values

CHECKPOINT_COMMAND

static final String CHECKPOINT_COMMAND

See Also:

Constant Field Values

ADD_PROJECT_LABEL_COMMAND

static final String ADD_PROJECT_LABEL_COMMAND

See Also:

Constant Field Values

EDIT_ISSUE_COMMAND

static final String EDIT_ISSUE_COMMAND

See Also:

Constant Field Values

RELATIONSHIPS_COMMAND

static final String RELATIONSHIPS_COMMAND

See Also:

Constant Field Values

ISSUES_COMMAND

static final String ISSUES_COMMAND

See Also:

Constant Field Values

EDIT_RESULT_COMMAND

static final String EDIT_RESULT_COMMAND

See Also:

Constant Field Values

Method Detail

execute

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

Execute the command using Integrity Session API

Parameters:

api -

Throws:

com.mks.api.response.APIException

execute

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

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

Returns:

Throws:

APICommandException

hudson.AbortException

com.mks.api.response.APIException

doPostAction

void doPostAction()

Do actions post the Integrity API call specifically for Jenkins functionality

doPreAction

void doPreAction()

Do actions pre the Integrity API call specifically for Jenkins functionality

addAdditionalParameters

void addAdditionalParameters(String paramName,
                             Object param)

Objects required for command pre and post processing.

Parameters:

objects -

addOption

void addOption(IAPIOption option)

Parameters:

option -

addSelection

void addSelection(String param)

Parameters:

param -

terminateAPI

void terminateAPI()
           throws Exception

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

Throws:

Exception