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
,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
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ParserConfiguration.ParserFactory
Registers all Groovy parsers as static analysis tools in theLabelProviderFactory
so that these parsers can be referenced in actions.-
Nested classes/interfaces inherited from class hudson.model.Descriptor
Descriptor.FormException, Descriptor.PropertyType, Descriptor.Self
-
Nested classes/interfaces inherited from interface hudson.ExtensionPoint
ExtensionPoint.LegacyInstancesAreScopedToHudson
-
-
Field Summary
-
Fields inherited from class hudson.model.Descriptor
clazz
-
-
Constructor Summary
Constructors Constructor Description ParserConfiguration()
Creates the Groovy parser configuration for the warnings plugins.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description ListBoxModel
asListBoxModel()
Returns all registered Groovy parsers.boolean
canEditParsers()
Returns whether the current user has the permission to edit the available Groovy parsers.protected void
clearRepeatableProperties()
boolean
contains(String id)
Returns whether a parser with the specified ID does already exist.FormValidation
doCheckConsoleLogScanningPermitted(boolean value)
Called by jelly to validate the configured value that could be passed tosetConsoleLogScanningPermitted(boolean)
.static ParserConfiguration
getInstance()
Returns the singleton instance of thisParserConfiguration
.GroovyParser
getParser(String id)
Returns the parser (wrapped into aAnalysisModelParser
instance) with the specified ID.List<GroovyParser>
getParsers()
Returns the list of available Groovy parsers.boolean
isConsoleLogScanningPermitted()
Says if the admin has permitted groovy parsers to scan a build's console log.void
setConsoleLogScanningPermitted(boolean consoleLogScanningPermitted)
Sets whether or not the admin has permitted groovy parsers to scan a build's console log.void
setParsers(List<GroovyParser> parsers)
Sets the list of available Groovy parsers to the specified elements.-
Methods inherited from class io.jenkins.plugins.util.GlobalConfigurationItem
configure, load, readResolve, save
-
Methods inherited from class jenkins.model.GlobalConfiguration
all, getDescriptor, getGlobalConfigPage
-
Methods inherited from class hudson.model.Descriptor
addHelpFileRedirect, calcAutoCompleteSettings, calcFillSettings, configure, doHelp, find, find, findByDescribableClassName, findById, getCategory, getCheckMethod, getCheckUrl, getConfigFile, getConfigPage, getCurrentDescriptorByNameUrl, getDescriptorFullUrl, getDescriptorUrl, getDisplayName, getGlobalPropertyType, getHelpFile, getHelpFile, getHelpFile, getId, getJsonSafeClassName, getKlass, getPlugin, getPossibleViewNames, getPropertyType, getPropertyType, getPropertyTypeOrDie, getRequiredGlobalConfigPagePermission, getT, getViewPage, isInstance, isSubTypeOf, newInstance, newInstance, newInstancesFromHeteroList, newInstancesFromHeteroList, self, toArray, toList, toMap
-
-
-
-
Method Detail
-
getInstance
public static ParserConfiguration getInstance()
Returns the singleton instance of thisParserConfiguration
.- Returns:
- the singleton instance
-
clearRepeatableProperties
protected void clearRepeatableProperties()
- Overrides:
clearRepeatableProperties
in classio.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
-
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 tosetConsoleLogScanningPermitted(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 aAnalysisModelParser
instance) with the specified ID.- Parameters:
id
- the ID of the parser- Returns:
- the parser
- Throws:
edu.hm.hafner.util.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 aListBoxModel
in order to show them in the list box of the config.jelly view part.- Returns:
- the model of the list box
-
-