Package com.bluersw

Class AgentParameterDefinition

java.lang.Object
hudson.model.ParameterDefinition
com.bluersw.AgentParameterDefinition
All Implemented Interfaces:
ExtensionPoint, Describable<ParameterDefinition>, Serializable
public class AgentParameterDefinition extends ParameterDefinition
Author:
sunweisheng Jenkins 构建参数：Agent服务器选择（Jenkins build parameters: Agent server selection）
See Also:

  • Constructor Details

    • AgentParameterDefinition

      @DataBoundConstructor public AgentParameterDefinition(String name, String defaultValue)
      构造函数在构建项目配置构建参数时调用（The constructor is called when the build project configures build parameter）
      Parameters:
      name - 构建参数名称 （Build parameter name）
      defaultValue - 该构建参数的默认值，会随着每次用户选择Agent服务器而改变（The default value of this build parameter will change each time the user selects the Agent server）

  • Method Details

    • getDefaultValue

      public String getDefaultValue()
      获取构建参数默认值 （Get default values of build parameter）
      Returns:
      构建参数默认值 （Build parameter default value）

    • setDefaultValue

      @DataBoundSetter public void setDefaultValue(String defaultValue)
      设置构建参数默认值 （Set default values for build parameter）
      Parameters:
      defaultValue - 要设置的构建参数默认值 （The default value of the build parameter to be set）

    • getDivId

      public String getDivId()
      防止项目中有多个Agent Server Parameter，为每个构建参数的DIV元素创建唯一的ID值（Prevent multiple Agent Server Parameter in the project, create a unique ID value for each DIV element of the build parameter）
      Returns:
      DIV唯一ID（DIV unique ID）

    • createValue

      @CheckForNull public ParameterValue createValue(org.kohsuke.stapler.StaplerRequest2 staplerRequest, net.sf.json.JSONObject jsonObject)
      创建Agent服务器参数的参数结果对象（Create parameter result object for Agent server parameter）
      Overrides:
      createValue in class ParameterDefinition
      Parameters:
      staplerRequest - StaplerRequest对象（StaplerRequest object）
      jsonObject - Agent服务器参数的结果对象，Json格式（Agent Server Parameter result object, Json format）
      Returns:
      参数结果对象 （Parameter result object）

    • createValue

      @CheckForNull public ParameterValue createValue(org.kohsuke.stapler.StaplerRequest2 staplerRequest)
      创建Agent服务器参数的参数结果对象（Create parameter result object for Agent server parameter）
      Overrides:
      createValue in class ParameterDefinition
      Parameters:
      staplerRequest - StaplerRequest对象（StaplerRequest object）
      Returns:
      参数结果对象 （Parameter result object）

    • createValue

      public ParameterValue createValue(CLICommand command, String value)
      创建Agent服务器参数的参数结果对象（Create parameter result object for Agent server parameter）
      Overrides:
      createValue in class ParameterDefinition
      Parameters:
      command - CLICommand Object
      value - Agent服务器参数的结果对象，字符串格式（Agent Server Parameter result object, String format）
      Returns:
      参数结果对象 （Parameter result object）

    • getDefaultParameterValue

      public ParameterValue getDefaultParameterValue()
      创建含有默认值的结果对象 （Create a result object with default values）
      Overrides:
      getDefaultParameterValue in class ParameterDefinition
      Returns:
      默认的参数结果对象 （Default parameter result object）

    • getComputerNames

      public List<String> getComputerNames()
      获取所有Agent Server的显示名称（Get the display names of all Agent Servers）
      Returns:
      Agent Server的显示名称列表（List of display names of Agent Server）

    • getDescriptor

      public AgentParameterDefinition.DescriptorImpl getDescriptor()
      获得构建参数描述对象，除了属性值绑定之外，与UI交互的动作方法在此对象内实现（Obtain the build parameter description object. In addition to the attribute value binding, the action method for interacting with the UI is implemented in this object）
      Specified by:
      getDescriptor in interface Describable<ParameterDefinition>
      Overrides:
      getDescriptor in class ParameterDefinition
      Returns:
      构建参数对象描述对象（Build parameter object description object）