Class PipelineBranchDefaultsProjectFactory

java.lang.Object
hudson.model.AbstractDescribableImpl<jenkins.branch.BranchProjectFactory<?,?>>
jenkins.branch.BranchProjectFactory<org.jenkinsci.plugins.workflow.job.WorkflowJob, org.jenkinsci.plugins.workflow.job.WorkflowRun>
org.jenkinsci.plugins.workflow.multibranch.AbstractWorkflowBranchProjectFactory
org.jenkinsci.plugins.pipeline.multibranch.defaults.PipelineBranchDefaultsProjectFactory
All Implemented Interfaces:
ExtensionPoint, Describable<jenkins.branch.BranchProjectFactory<?,?>>, Saveable
public class PipelineBranchDefaultsProjectFactory extends org.jenkinsci.plugins.workflow.multibranch.AbstractWorkflowBranchProjectFactory
Recognizes and builds by default Jenkinsfile.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    PipelineBranchDefaultsProjectFactory.DescriptorImpl
     

    Nested classes/interfaces inherited from class org.jenkinsci.plugins.workflow.multibranch.AbstractWorkflowBranchProjectFactory

    org.jenkinsci.plugins.workflow.multibranch.AbstractWorkflowBranchProjectFactory.AbstractWorkflowBranchProjectFactoryDescriptor

    Nested classes/interfaces inherited from class jenkins.branch.BranchProjectFactory

    jenkins.branch.BranchProjectFactory.HeadByItemImpl, jenkins.branch.BranchProjectFactory.SourceByItemImpl

    Nested classes/interfaces inherited from interface ExtensionPoint

    ExtensionPoint.LegacyInstancesAreScopedToHudson

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    SCRIPT
     

    Fields inherited from interface Saveable

    NOOP

  • Constructor Summary

    Constructors
    Constructor
    Description
    PipelineBranchDefaultsProjectFactory()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected org.jenkinsci.plugins.workflow.flow.FlowDefinition
    createDefinition()
     
    protected jenkins.scm.api.SCMSourceCriteria
    getSCMSourceCriteria(jenkins.scm.api.SCMSource source)
     
    String
    getScriptId()
    Get the script ID which will be used to read the Jenkinsfile from config file management.
    boolean
    getUseSandbox()
    Get the current setting for whether or not to use a groovy sandbox.
    void
    setScriptId(String scriptId)
    Set the script ID which will be used to reference the config file management for the contents of a Jenkinsfile.
    void
    setUseSandbox(boolean useSandbox)
    Set whether or not a Jenkinsfile should run within a Groovy sandbox.

    Methods inherited from class org.jenkinsci.plugins.workflow.multibranch.AbstractWorkflowBranchProjectFactory

    getBranch, isProject, newInstance, setBranch

    Methods inherited from class jenkins.branch.BranchProjectFactory

    asProject, decorate, getDescriptor, getLastSeenRevision, getOwner, getProjectClass, getRevision, save, setLastSeenRevisionHash, setOwner, setRevisionHash

    Methods inherited from class Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

  • Constructor Details

    • PipelineBranchDefaultsProjectFactory

      @DataBoundConstructor public PipelineBranchDefaultsProjectFactory()

  • Method Details

    • setScriptId

      @DataBoundSetter public void setScriptId(String scriptId)
      Set the script ID which will be used to reference the config file management for the contents of a Jenkinsfile.
      Parameters:
      scriptId - The ID of the groovy script to read as a Jenkinsfile.

    • getScriptId

      public String getScriptId()
      Get the script ID which will be used to read the Jenkinsfile from config file management.
      Returns:
      The Jenkinsfile script ID.

    • setUseSandbox

      @DataBoundSetter public void setUseSandbox(boolean useSandbox)
      Set whether or not a Jenkinsfile should run within a Groovy sandbox.
      Parameters:
      useSandbox - Set true to enable Groovy sandbox or false to run in Jenkins master runtime.

    • getUseSandbox

      public boolean getUseSandbox()
      Get the current setting for whether or not to use a groovy sandbox.
      Returns:
      true if using a groovy sandbox is desired.

    • createDefinition

      protected org.jenkinsci.plugins.workflow.flow.FlowDefinition createDefinition()
      Specified by:
      createDefinition in class org.jenkinsci.plugins.workflow.multibranch.AbstractWorkflowBranchProjectFactory

    • getSCMSourceCriteria

      protected jenkins.scm.api.SCMSourceCriteria getSCMSourceCriteria(jenkins.scm.api.SCMSource source)
      Specified by:
      getSCMSourceCriteria in class org.jenkinsci.plugins.workflow.multibranch.AbstractWorkflowBranchProjectFactory