Package us.abstracta.jmeter.javadsl.core.postprocessors

Class DslRegexExtractor

    • Constructor Detail

      • DslRegexExtractor

        public DslRegexExtractor​(String varName,
                         String regex)

    • Method Detail

      • matchNumber

        public DslRegexExtractor matchNumber​(int matchNumber)
        Sets the match number to be extracted.

        For example, if a response looks like this: 

        user=test&user=tester
        and you use user=([^&]+) as regular expression, first match (1) would extract test and second match (2) would extract tester.

        When not specified, the first match will be used. When 0 is specified, a random match will be used. When negative, all the matches are extracted to variables with name <variableName>_<matchNumber>, the number of matches is stored in <variableName>_matchNr, and default value is assigned to <variableName>.

        Parameters:
        matchNumber - specifies the match number to use.
        Returns:
        the extractor for further configuration or usage.

      • template

        public DslRegexExtractor template​(String template)
        Specifies the final string to store in the JMeter Variable.

        The string may contain capturing groups (regular expression segments between parenthesis) references by using $<groupId>$ expressions (eg: $1$ for first group). Check JMeter Regular Expression Extractor documentation for more details.

        For example, if a response looks like this: 

        email=tester@abstracta.us
        And you use user=([^&]+) as regular expression. Then $1$-$2$ will result in storing in the specified JMeter variable the value tester-abstracta.

        When not specified $1$ will be used.

        Parameters:
        template - specifies template to use for storing in the JMeter variable.
        Returns:
        the extractor for further configuration or usage.

      • defaultValue

        public DslRegexExtractor defaultValue​(String defaultValue)
        Sets the default value to be stored in the JMeter variable when the regex does not match.

        When match number is negative then the value is always assigned to the variable name.

        A common pattern is to specify this value to a known value (e.g.: <VAR>_EXTRACTION_FAILURE) and then add some assertion on the variable to mark request as failure when the match doesn't work.

        When not specified then the variable will not be set if no match is found.

        Parameters:
        defaultValue - specifies the default value to be used.
        Returns:
        the extractor for further configuration or usage.

      • fieldToCheck

        public DslRegexExtractor fieldToCheck​(DslRegexExtractor.TargetField fieldToCheck)
        Allows specifying what part of request or response to apply the regular extractor to.

        When not specified then the regular extractor will be applied to the response body.

        Parameters:
        fieldToCheck - field to apply the regular extractor to.
        Returns:
        the extractor for further configuration or usage.
        See Also:
        DslRegexExtractor.TargetField