Package org.jenkinsci.plugins.pipeline.utility.steps.conf

Class ReadPropertiesStep

  • All Implemented Interfaces:
    ExtensionPoint, Describable<org.jenkinsci.plugins.workflow.steps.Step>
    public class ReadPropertiesStep
extends AbstractFileOrTextStep
    Reads java properties formatted files and texts into a map.
    Author:
    Robert Sandell <rsandell@cloudbees.com>.

    • Constructor Detail

      • ReadPropertiesStep

        @DataBoundConstructor
public ReadPropertiesStep()

    • Method Detail

      • start

        public org.jenkinsci.plugins.workflow.steps.StepExecution start​(org.jenkinsci.plugins.workflow.steps.StepContext context)
                                                         throws Exception
        Specified by:
        start in class org.jenkinsci.plugins.workflow.steps.Step
        Throws:
        Exception

      • getDefaults

        public Map<Object,​Object> getDefaults()
        Default key/values to populate the map with before parsing.
        Returns:
        the defaults

      • setDefaults

        @DataBoundSetter
public void setDefaults​(Map<Object,​Object> defaults)
        Default key/values to populate the map with before parsing.
        Parameters:
        defaults - the defaults

      • isInterpolate

        public Boolean isInterpolate()
        Flag to indicate if the properties should be interpolated or not. I.E. : baseUrl = http://localhost url = ${baseUrl}/resources The value of url should be evaluated to http://localhost/resources with the interpolation on.
        Returns:
        the value of interpolated

      • setInterpolate

        @DataBoundSetter
public void setInterpolate​(Boolean interpolate)
        Set the interpolated parameter.
        Parameters:
        interpolate - parameter.

      • getCharset

        public String getCharset()

      • setCharset

        @DataBoundSetter
public void setCharset​(String charset)
        The charset encoding to use when read the properties file. Defaults to ISO 8859-1 .
        Parameters:
        charset - the charset