IAction (BMC AMI DevX Code Pipeline Operations Plugin 2.4.1 API)

All Known Implementing Classes:

AbstractGetAction, AbstractPostAction, AddTaskAction, BuildAssignmentAction, BuildReleaseAction, BuildTaskAction, CancelAssignmentAction, CancelDeployment, CancelReleaseAction, CloseAssignmentAction, CloseReleaseAction, CreateAssignmentAction, CreateReleaseAction, DeployAssignmentAction, DeployReleaseAction, DeployTaskAction, FallbackAssignmentAction, FallbackReleaseAction, GenerateTaskAction, GenerateTasksInAssignmentAction, GenerateTasksInReleaseAction, GenericPostAction, GetAssignmentInfoAction, GetAssignmentTaskListAction, GetContainerListAction, GetDeploymentListAction, GetReleaseInfoAction, GetReleaseTaskGenerateListingAction, GetReleaseTaskInfoAction, GetReleaseTaskListAction, GetSetInfoAction, GetSetTaskListAction, GetWorkListAction, PromoteAssignmentAction, PromoteReleaseAction, RegressAssignmentAction, RegressReleaseAction, ReleaseDeployOperation, RemoveFromReleaseAction, SetInfoPostAction, SetOperationAction, TaskLoadAction, TransferTaskAction, UpdateGenParmAction
```
public interface IAction
```
Common interface for all actions

Author:

Sam Zhou

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`action`
`static String`	`application`
`static String`	`assignmentId`
`static String`	`assignmentPrefix`
`static String`	`autoDeploy`
`static String`	`changeType`
`static String`	`checkout`
`static String`	`checkoutFromLevel`
`static String`	`containerId`
`static String`	`containerType`
`static String`	`credentials`
`static String`	`currentLevel`
`static String`	`defaultPath`
`static String`	`description`
`static String`	`dpenvlst`
`static String`	`endDate`
`static String`	`environment`
`static String`	`eventsBody`
`static String`	`eventsCredentials`
`static String`	`eventsHttpHeaders`
`static String`	`eventsMethod`
`static String`	`eventsName`
`static String`	`eventsUrl`
`static String`	`executionStatus`
`static String`	`group`
`static String`	`historical`
`static String`	`httpHeaders`
`static String`	`includeClosedContainers`
`static String`	`inProgress`
`static String`	`lastUpdatedBy`
`static String`	`level`
`static String`	`mname`
`static String`	`moduleName`
`static String`	`moduleType`
`static String`	`mtype`
`static String`	`name`
`static String`	`operation`
`static String`	`owner`
`static String`	`path`
`static String`	`priorWeek`
`static String`	`production`
`static String`	`referenceNumber`
`static String`	`refNumber`
`static String`	`releaseId`
`static String`	`releasePrefix`
`static String`	`requestId`
`static String`	`rtConfig`
`static String`	`runtimeConfiguration`
`static String`	`setId`
`static String`	`startDate`
`static String`	`startingLevel`
`static String`	`status`
`static String`	`stream`
`static String`	`subAppl`
`static String`	`system`
`static String`	`tag`
`static String`	`taskId`
`static String`	`taskName`
`static String`	`todaysDate`
`static String`	`type`
`static String`	`userId`
`static String`	`userTag`

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`Object`	`endLog(PrintStream logger, IspwRequestBean ispwRequestBean, String responseJson)`
`HttpMode`	`getHttpMode()`
`IspwRequestBean`	`getIspwRequestBean(String srid, String ispwRequestBody, WebhookToken webhookToken)`
`PrintStream`	`getLogger()`
`default String`	`getRequestBodyUsingAutomaticParms(String inputRequestBody, BuildParms buildParms)` For the case where "buildautomatically" is specified, this method replaces any parameters specified in the request body with the parameters in the BuildParms object.
`default void`	`postprocess()`
`default String`	`preprocess(String ispwRequestBody, hudson.FilePath pathToParmFile, PrintStream logger)` This method should be overridden to add "automatic" support for an action
`default String`	`preprocess(String automaticRegex, String ispwRequestBody, hudson.FilePath pathToParmFile, PrintStream logger, String operation, String pastTenseOp)` Reads the given request body to find out if the parameters of the build should taken from the request body, or if they should be read from a file.
`void`	`startLog(PrintStream logger, IspwContextPathBean ispwContextPathBean, Object jsonObject)`

- Field Detail
  - application
```
static final String application
```
    See Also:
    
    Constant Field Values
  - subAppl
```
static final String subAppl
```
    See Also:
    
    Constant Field Values
  - assignmentId
```
static final String assignmentId
```
    See Also:
    
    Constant Field Values
  - assignmentPrefix
```
static final String assignmentPrefix
```
    See Also:
    
    Constant Field Values
  - autoDeploy
```
static final String autoDeploy
```
    See Also:
    
    Constant Field Values
  - changeType
```
static final String changeType
```
    See Also:
    
    Constant Field Values
  - containerId
```
static final String containerId
```
    See Also:
    
    Constant Field Values
  - containerType
```
static final String containerType
```
    See Also:
    
    Constant Field Values
  - credentials
```
static final String credentials
```
    See Also:
    
    Constant Field Values
  - currentLevel
```
static final String currentLevel
```
    See Also:
    
    Constant Field Values
  - defaultPath
```
static final String defaultPath
```
    See Also:
    
    Constant Field Values
  - description
```
static final String description
```
    See Also:
    
    Constant Field Values
  - dpenvlst
```
static final String dpenvlst
```
    See Also:
    
    Constant Field Values
  - endDate
```
static final String endDate
```
    See Also:
    
    Constant Field Values
  - environment
```
static final String environment
```
    See Also:
    
    Constant Field Values
  - eventsBody
```
static final String eventsBody
```
    See Also:
    
    Constant Field Values
  - eventsCredentials
```
static final String eventsCredentials
```
    See Also:
    
    Constant Field Values
  - eventsHttpHeaders
```
static final String eventsHttpHeaders
```
    See Also:
    
    Constant Field Values
  - eventsMethod
```
static final String eventsMethod
```
    See Also:
    
    Constant Field Values
  - eventsName
```
static final String eventsName
```
    See Also:
    
    Constant Field Values
  - eventsUrl
```
static final String eventsUrl
```
    See Also:
    
    Constant Field Values
  - executionStatus
```
static final String executionStatus
```
    See Also:
    
    Constant Field Values
  - group
```
static final String group
```
    See Also:
    
    Constant Field Values
  - historical
```
static final String historical
```
    See Also:
    
    Constant Field Values
  - httpHeaders
```
static final String httpHeaders
```
    See Also:
    
    Constant Field Values
  - includeClosedContainers
```
static final String includeClosedContainers
```
    See Also:
    
    Constant Field Values
  - inProgress
```
static final String inProgress
```
    See Also:
    
    Constant Field Values
  - lastUpdatedBy
```
static final String lastUpdatedBy
```
    See Also:
    
    Constant Field Values
  - level
```
static final String level
```
    See Also:
    
    Constant Field Values
  - mname
```
static final String mname
```
    See Also:
    
    Constant Field Values
  - moduleName
```
static final String moduleName
```
    See Also:
    
    Constant Field Values
  - moduleType
```
static final String moduleType
```
    See Also:
    
    Constant Field Values
  - mtype
```
static final String mtype
```
    See Also:
    
    Constant Field Values
  - name
```
static final String name
```
    See Also:
    
    Constant Field Values
  - operation
```
static final String operation
```
    See Also:
    
    Constant Field Values
  - owner
```
static final String owner
```
    See Also:
    
    Constant Field Values
  - path
```
static final String path
```
    See Also:
    
    Constant Field Values
  - production
```
static final String production
```
    See Also:
    
    Constant Field Values
  - referenceNumber
```
static final String referenceNumber
```
    See Also:
    
    Constant Field Values
  - refNumber
```
static final String refNumber
```
    See Also:
    
    Constant Field Values
  - releaseId
```
static final String releaseId
```
    See Also:
    
    Constant Field Values
  - releasePrefix
```
static final String releasePrefix
```
    See Also:
    
    Constant Field Values
  - requestId
```
static final String requestId
```
    See Also:
    
    Constant Field Values
  - runtimeConfiguration
```
static final String runtimeConfiguration
```
    See Also:
    
    Constant Field Values
  - setId
```
static final String setId
```
    See Also:
    
    Constant Field Values
  - startDate
```
static final String startDate
```
    See Also:
    
    Constant Field Values
  - startingLevel
```
static final String startingLevel
```
    See Also:
    
    Constant Field Values
  - stream
```
static final String stream
```
    See Also:
    
    Constant Field Values
  - system
```
static final String system
```
    See Also:
    
    Constant Field Values
  - tag
```
static final String tag
```
    See Also:
    
    Constant Field Values
  - taskId
```
static final String taskId
```
    See Also:
    
    Constant Field Values
  - userId
```
static final String userId
```
    See Also:
    
    Constant Field Values
  - userTag
```
static final String userTag
```
    See Also:
    
    Constant Field Values
  - action
```
static final String action
```
    See Also:
    
    Constant Field Values
  - checkoutFromLevel
```
static final String checkoutFromLevel
```
    See Also:
    
    Constant Field Values
  - checkout
```
static final String checkout
```
    See Also:
    
    Constant Field Values
  - taskName
```
static final String taskName
```
    See Also:
    
    Constant Field Values
  - type
```
static final String type
```
    See Also:
    
    Constant Field Values
  - todaysDate
```
static final String todaysDate
```
    See Also:
    
    Constant Field Values
  - priorWeek
```
static final String priorWeek
```
    See Also:
    
    Constant Field Values
  - status
```
static final String status
```
    See Also:
    
    Constant Field Values
  - rtConfig
```
static final String rtConfig
```
    See Also:
    
    Constant Field Values
- Method Detail
  - getIspwRequestBean
```
IspwRequestBean getIspwRequestBean(String srid,
                                   String ispwRequestBody,
                                   WebhookToken webhookToken)
```
  - getLogger
```
PrintStream getLogger()
```
  - startLog
```
void startLog(PrintStream logger,
              IspwContextPathBean ispwContextPathBean,
              Object jsonObject)
```
  - endLog
```
Object endLog(PrintStream logger,
              IspwRequestBean ispwRequestBean,
              String responseJson)
```
  - getHttpMode
```
HttpMode getHttpMode()
```
  - preprocess
```
default String preprocess(String ispwRequestBody,
                          hudson.FilePath pathToParmFile,
                          PrintStream logger)
                   throws IOException,
                          InterruptedException
```
    This method should be overridden to add "automatic" support for an action
    
    Parameters:
    
    ispwRequestBody - - the request body entered by the user.
    
    pathToParmFile - - The file that contains the build parms. (should be something like "Jenkins\workspace\job-name\")
    
    logger - - the logger.
    
    Returns:
    
    - a String containing the request body that should be used.
    
    Throws:
    
    IOException - IO Exception
    
    InterruptedException - Interrupted Exception
  - preprocess
```
default String preprocess(String automaticRegex,
                          String ispwRequestBody,
                          hudson.FilePath pathToParmFile,
                          PrintStream logger,
                          String operation,
                          String pastTenseOp)
                   throws IOException,
                          InterruptedException
```
    Reads the given request body to find out if the parameters of the build should taken from the request body, or if they should be read from a file. If the automaticRegex parameter is specified in the given body, the REST API parameters will be read from a file in the given pathToParmFile. The given request body will not be changed if the automaticRegex parameter is not specified.
    
    Parameters:
    
    automaticRegex - the regex used to match on the relevant "automatic" string for this action.
    (for example (?i)(?m)(^(?!#)(.+)?deployautomatically.+true(.+)?$))
    
    ispwRequestBody - the request body entered by the user.
    
    pathToParmFile - The file that contains the build parms. (should be something like "Jenkins\workspace\job-name\")
    
    logger - the logger.
    
    operation - the operation to preprocess. A custom string can be passed in, or utilizing the Operation.getDescription() is preferred
    
    pastTenseOp - the past tense of the operation used for logging. A custom string can be passed in, or utilizing the Operation.getPastTenseDescription() is preferred
    
    Returns:
    
    a String containing the request body that should be used.
    
    Throws:
    
    IOException - IO exception
    
    InterruptedException - interrupted exception
  - getRequestBodyUsingAutomaticParms
```
default String getRequestBodyUsingAutomaticParms(String inputRequestBody,
                                                 BuildParms buildParms)
```
    For the case where "buildautomatically" is specified, this method replaces any parameters specified in the request body with the parameters in the BuildParms object. Any information that does not need to be replaced (i.e. comments, event data, runtimeConfiguration...) will still be part of the returned request body.
    
    Parameters:
    
    inputRequestBody - the input request body that the user provided
    
    buildParms - the build parms to use instead of the given request body
    
    Returns:
    
    a String request body to use instead of what the user specified. This will never be null.
  - postprocess
```
default void postprocess()
```

Interface IAction

Field Summary

Method Summary

Field Detail

application

subAppl

assignmentId

assignmentPrefix

autoDeploy

changeType

containerId

containerType

credentials

currentLevel

defaultPath

description

dpenvlst

endDate

environment

eventsBody

eventsCredentials

eventsHttpHeaders

eventsMethod

eventsName

eventsUrl

executionStatus

group

historical

httpHeaders

includeClosedContainers

inProgress

lastUpdatedBy

level

mname

moduleName

moduleType

mtype

name

operation

owner

path

production

referenceNumber

refNumber

releaseId

releasePrefix

requestId

runtimeConfiguration

setId

startDate

startingLevel

stream

system

tag

taskId

userId

userTag

action

checkoutFromLevel

checkout

taskName

type

todaysDate

priorWeek

status

rtConfig

Method Detail

getIspwRequestBean

getLogger

startLog

endLog

getHttpMode

preprocess

preprocess

getRequestBodyUsingAutomaticParms

postprocess