Package io.jenkins.plugins.analysis.warnings.groovy

Class ParserConfiguration

java.lang.Object
hudson.model.Descriptor<GlobalConfiguration>
jenkins.model.GlobalConfiguration
io.jenkins.plugins.util.GlobalConfigurationItem
io.jenkins.plugins.analysis.warnings.groovy.ParserConfiguration
All Implemented Interfaces:
ExtensionPoint, Describable<GlobalConfiguration>, Saveable, Loadable, OnMaster
@Extension @Symbol("warningsParsers") public class ParserConfiguration extends io.jenkins.plugins.util.GlobalConfigurationItem
Global configuration of Groovy based parsers. These parsers are dynamically registered.
Author:
Ullrich Hafner

  • Constructor Details

    • ParserConfiguration

      public ParserConfiguration()
      Creates the Groovy parser configuration for the warnings plugins.

  • Method Details

    • getInstance

      public static ParserConfiguration getInstance()
      Returns the singleton instance of this ParserConfiguration.
      Returns:
      the singleton instance

    • clearRepeatableProperties

      protected void clearRepeatableProperties()
      Overrides:
      clearRepeatableProperties in class io.jenkins.plugins.util.GlobalConfigurationItem

    • getParsers

      public List<GroovyParser> getParsers()
      Returns the list of available Groovy parsers.
      Returns:
      the Groovy parsers

    • setParsers

      @DataBoundSetter public void setParsers(List<GroovyParser> parsers)
      Sets the list of available Groovy parsers to the specified elements. Previously set parsers will be removed.
      Parameters:
      parsers - the new Groovy parsers

    • deleteParser

      public void deleteParser(String parserId)
      Removes a GroovyParser from the list by ID.
      Parameters:
      parserId - the ID of the Groovy parser to be deleted

    • addParser

      public void addParser(GroovyParser parser)
      Adds a GroovyParser to the list without removing other parsers.
      Parameters:
      parser - the new Groovy parser to be added

    • isConsoleLogScanningPermitted

      public boolean isConsoleLogScanningPermitted()
      Says if the admin has permitted groovy parsers to scan a build's console log.
      Returns:
      true if groovy parsers can scan the console, false if they are limited to only scanning files on the build node.

    • setConsoleLogScanningPermitted

      @DataBoundSetter public void setConsoleLogScanningPermitted(boolean consoleLogScanningPermitted)
      Sets whether or not the admin has permitted groovy parsers to scan a build's console log.
      Parameters:
      consoleLogScanningPermitted - true if groovy parsers can scan the console, false if they are limited to only scanning files on the build node.

    • doCheckConsoleLogScanningPermitted

      public FormValidation doCheckConsoleLogScanningPermitted(@QueryParameter boolean value)
      Called by jelly to validate the configured value that could be passed to setConsoleLogScanningPermitted(boolean).
      Parameters:
      value - The current value.
      Returns:
      FormValidation.ok() if all is well, else a warning or error.

    • canEditParsers

      public boolean canEditParsers()
      Returns whether the current user has the permission to edit the available Groovy parsers.
      Returns:
      true if the user has the right, false otherwise

    • getParser

      public GroovyParser getParser(String id)
      Returns the parser (wrapped into a AnalysisModelParser instance) with the specified ID.
      Parameters:
      id - the ID of the parser
      Returns:
      the parser
      Throws:
      NoSuchElementException - if there is no such parser with the given ID

    • contains

      public boolean contains(String id)
      Returns whether a parser with the specified ID does already exist. Parser IDs are unique in a Jenkins instance.
      Parameters:
      id - the ID of the parser
      Returns:
      true if there is already a parser with the ID, false otherwise

    • asListBoxModel

      public ListBoxModel asListBoxModel()
      Returns all registered Groovy parsers. These are packed into a ListBoxModel in order to show them in the list box of the config.jelly view part.
      Returns:
      the model of the list box