Class BuildRunnerBean

  • All Implemented Interfaces:
    StatefulObject

    public class BuildRunnerBean
    extends RememberState
    Holds build runner properties when a build configuration is being edited on the web
    • Constructor Detail

      • BuildRunnerBean

        public BuildRunnerBean​(@NotNull
                               java.lang.String id,
                               @NotNull
                               java.lang.String runTypeInfoKey,
                               @Nullable
                               java.util.Map<java.lang.String,​java.lang.String> properties,
                               @NotNull
                               AvailableBuildRunners availableRunners)
        Constructor for new build runner
        Parameters:
        runTypeInfoKey - run type key
      • BuildRunnerBean

        public BuildRunnerBean​(@NotNull
                               SBuildRunnerDescriptor runnerDescriptor,
                               @NotNull
                               AvailableBuildRunners availableRunners,
                               java.lang.String inheritedFrom,
                               boolean isEnforced,
                               boolean overridden,
                               boolean enabled)
        Constructor for existing build runner
        Parameters:
        runnerDescriptor - build runner descriptor
        availableRunners - available runners
        enabled - enabled
    • Method Detail

      • isIdEditingFeatureEnabled

        public boolean isIdEditingFeatureEnabled()
      • isAllowIdEditing

        public boolean isAllowIdEditing()
      • getId

        @NotNull
        public java.lang.String getId()
        Returns unique identifier of this build runner bean
        Returns:
        see above
      • isNewRunner

        public boolean isNewRunner()
        Returns true if this bean represents new build runner (not yet created).
        Returns:
        see above
      • getRunTypeInfoKey

        public java.lang.String getRunTypeInfoKey()
        Returns type of the currently selected runner
        Returns:
        type of the currently selected runner
      • isRunnerTypeSelected

        public boolean isRunnerTypeSelected()
        Returns true if type of the runner is selected
        Returns:
        see above
        Since:
        6.0
      • getBuildStepName

        public java.lang.String getBuildStepName()
        Returns name of the build runner step
        Returns:
        build runner step name
      • getDisplayName

        public java.lang.String getDisplayName()
        Returns build step name if it exists, or display name of runner
        Returns:
        build step name if it exists
      • getNewRunnerId

        @NotNull
        public java.lang.String getNewRunnerId()
      • isBootstrapStep

        public boolean isBootstrapStep()
      • setBuildStepName

        public void setBuildStepName​(java.lang.String buildStepName)
        Sets name of the build runner step
      • setNewRunnerId

        public void setNewRunnerId​(@NotNull
                                   java.lang.String newRunnerId)
      • setRunTypeInfoKey

        public void setRunTypeInfoKey​(java.lang.String runTypeInfoKey)
        Selects new runner
        Parameters:
        runTypeInfoKey - new runner type
      • getUsedStepIdsString

        public java.lang.String getUsedStepIdsString()
      • getSelectedRunType

        @NotNull
        public RunTypeData getSelectedRunType()
      • getRunType

        @NotNull
        public RunType getRunType()
      • getShortDescription

        @NotNull
        public java.lang.String getShortDescription()
      • isInherited

        public boolean isInherited()
        Returns:
        true if this runner is inherited from template
      • isEnforced

        public boolean isEnforced()
        Returns:
        true if this runner is inherited from enforced template
      • getInheritedFrom

        public java.lang.String getInheritedFrom()
        Returns:
        template full name if inherited from a template, null otherwise
      • isOverridden

        public boolean isOverridden()
        Returns:
        true if this runner is inherited from template, but overridden in the configuration
        Since:
        2017.2
      • isEnabled

        public boolean isEnabled()
        Returns:
        true if this runner is enabled
        Since:
        7.0
      • getStepExecutionPolicyKey

        @NotNull
        public java.lang.String getStepExecutionPolicyKey()
        Returns:
        runner parameter name for build policy
        Since:
        7.1
      • getStepExecutionPolicyValues

        @NotNull
        public java.util.Collection<BuildRunnerBean.ExecutionPolicyValue> getStepExecutionPolicyValues()
        Returns:
        all possible values for step execution policy
        Since:
        7.1
      • getPropertiesBean

        public RunnerPropertiesBean getPropertiesBean()
        Returns bean containing properties of the currently selected build runner
        Returns:
        bean containing properties of the currently selected build runner
      • getDeprecationReason

        @NotNull
        public java.lang.String getDeprecationReason()
      • getDeprecationReference

        @NotNull
        public java.lang.String getDeprecationReference()
      • getAvailableRunnerExtensionUrls

        @NotNull
        public java.util.Collection<java.lang.String> getAvailableRunnerExtensionUrls()
      • setExistingRunners

        public void setExistingRunners​(@NotNull
                                       java.util.List<SBuildRunnerDescriptor> buildRunners)