Package 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 Details

  • Method Details

    • 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:

    • 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