Property Detail

• java.lang.String configName

  Name of the configuration specified as one of the parameter values.

• java.lang.String currentProjectName

  Full name of the project we are running in

• Config currentStepConfigValues

  Values from the configuration, with name specified as one of parameters

• StepParameters currentStepParameters

  Actual parameter values

• FWLog fwLogger

• java.lang.String pluginProjectName

  Full name of the plugin's project

• java.util.Map<java.lang.String, java.lang.String> pluginValues

  #pluginValues()

• java.lang.String procedureName

  ContextFactory.procedureName

• java.lang.String runContext

  Name of the CloudBees CD context in which we are running ('pipeline', 'schedule', 'procedure')

• StepParameters runtimeParameters

  Combined values from both configuration and actual parameters

• java.lang.String stepName

  ContextFactory.stepName

Constructor Detail

• Context(java.lang.Object pluginValues, java.lang.String procedureName, java.lang.String stepName)

  Constructor.

  Parameters:

  pluginValues - pluginValues

  procedureName - name of the plugin's procedure we are running in.

  stepName - name of the procedure's step we are running in.

Method Detail

• void applyStepResult()

  Applies current StepResult

• void bailOut(java.lang.String message, java.lang.String suggestion = null, java.lang.Throwable caused = null)

  Immediately aborts current execution and exits with exit code 1. Additionally following properties will be set:

  • Pipeline summary (if running in a pipeline context)
  • JobStep outcome
  • JobStep summary
  • Job summary
  This exception can't be handled or caught.

  Parameters:

  message

  description

• java.lang.String buildPluginProjectName()

  Builds name of the project for current plugin version

  Returns:

• java.lang.String getConfigName()

  Gets name of the config specified as a value for one of the step parameters.

  Returns:

  configuration name

• Config getConfigValues()

  This method returns a Config object that represents plugin configuration.

  Parameters:

  configName

  Returns:

  Config

• java.lang.String getCurrentProcedureName()

  Retrieves name for a procedure we are running in. If retrieving fails, using plugin's procedure name.

  Returns:

  name for a procedure we are running in

• java.lang.String getCurrentProjectName()

  Returns current runtime context project name.

  Returns:

  name of the project where the procedure runs

• @org.jetbrains.annotations.NotNull java.lang.String getCurrentScheduleName()

  This method retrieves name of the current schedule we are running inside or an empty string

  Returns:

  Name of the current schedule we are running inside or an empty string

• java.lang.String getRunContext()

  Cached accessor for Context.determineRunContext

  Returns:

  name of current context (one of 'procedure', 'schedule', 'pipeline')

• StepParameters getRuntimeParameters()

  Handy shortcut for receiving the configuration and procedure parameters.

  Returns:

  combined configuration and procedure parameters in the StepParameters instance

• StepParameters getStepParameters()

  This method returns representation of current procedure parameters

  Returns:

  procedure parameters

• boolean isCheckConnectionInCreateConfiguration()

  Checking if we are running in a specific step.

  Returns:

  true if running inside 'checkConnection' step of the 'CreateConfiguration' procedure

• boolean isParameterRequired(java.lang.String parameterName)

  Checks if the parameter with a specified name is required.

  Parameters:

  parameterName - name of the parameter to check

  Returns:

  true if the parameter is required and false otherwise

• REST newRESTClient(RESTConfig restConfig = null)

  Reads configuration values and instantiates new REST client for the configuration. This method expects that configuration contains specific fields. If there is only one case for the parameter, you can specify it in the special section of the pluginValues() map.

  Returns:

  REST

• StepResult newStepResult()

  Renews a StepResult linked to the current context.

  Returns:

  clearStepResult object

• protected static java.lang.Object parseBooleanPropertyValue(java.lang.Object value, java.lang.String description)

  Internal method for parsing different boolean representations.

  Parameters:

  value - string that contains either '0', '1', 'true' or 'false'.

  description - preferably the parameter name, will be included to an error message if value is not boolean like.

  Returns:

  boolean value

• Credential readActualCredential(java.lang.String credentialName, java.lang.String parameterName = credentialName)

  Read the values of the credential in current context.

  Parameters:

  credentialName

  parameterName

  Returns:

• java.lang.String readActualParameter(java.lang.String parameterName)

  Read the value of an actual parameter in current context.

  Parameters:

  parameterName

  Returns:

  value for the specified parameter

• @org.jetbrains.annotations.Nullable Config retrieveConfigByNameAndLocation(java.lang.String configName, java.lang.String configLocation = 'ec_plugin_cfgs')

  Reads the specified property sheet and converts the properties to the Parameter or Credential objects.

  Parameters:

  configName - name of the configuration

  configLocation - property sheet containing the configurations

  Returns:

  Config object with a values stored in a configuration or null

• static java.lang.String retrieveCurrentProjectName(java.lang.String jobId)

  Retrieves name of the project where current running job was started

  Returns: