Package io.jenkins.plugins.analysis.warnings.axivion

Class AxivionSuite.AxivionSuiteToolDescriptor

java.lang.Object

hudson.model.Descriptor<Tool>

io.jenkins.plugins.analysis.core.model.Tool.ToolDescriptor

io.jenkins.plugins.analysis.warnings.axivion.AxivionSuite.AxivionSuiteToolDescriptor

All Implemented Interfaces:

Saveable, Loadable, OnMaster

Enclosing class:

AxivionSuite

@Symbol({"axivionSuite","axivion"})
@Extension
public static class AxivionSuite.AxivionSuiteToolDescriptor
extends Tool.ToolDescriptor

Descriptor for AxivionSuite. *

Nested Class Summary

Nested classes/interfaces inherited from class hudson.model.Descriptor

Descriptor.FormException, Descriptor.PropertyType, Descriptor.Self

Field Summary

Fields inherited from class hudson.model.Descriptor

clazz

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Constructor	Description
AxivionSuiteToolDescriptor()	Creates the descriptor instance.

Method Summary

Modifier and Type	Method	Description
FormValidation	doCheckBasedir(BuildableItem project, String basedir)	Checks whether the given path is a correct os path.
FormValidation	doCheckCredentialsId(Item item, String credentialsId)	Checks whether valid credentials are given.
FormValidation	doCheckProjectUrl(BuildableItem project, String projectUrl)	Dashboard project url must be a valid url.
ListBoxModel	doFillCredentialsIdItems(Item item, String credentialsId)	Shows the user all available credential id items.
String	getDisplayName()
String	getHelp()	Returns an optional help text that can provide useful hints on how to configure the static analysis tool so that the report files could be parsed by Jenkins.
StaticAnalysisLabelProvider	getLabelProvider()	Returns a StaticAnalysisLabelProvider that will render all tool specific labels.

Methods inherited from class io.jenkins.plugins.analysis.core.model.Tool.ToolDescriptor

doCheckId, getId, getName, getSymbolName, getUrl, isPostProcessingEnabled

Methods inherited from class hudson.model.Descriptor

addHelpFileRedirect, bindJSON, calcAutoCompleteSettings, calcFillSettings, configure, configure, doHelp, find, find, findByDescribableClassName, findById, getCategory, getCheckMethod, getCheckUrl, getConfigFile, getConfigPage, getCurrentDescriptorByNameUrl, getDescriptorFullUrl, getDescriptorUrl, getGlobalConfigPage, getGlobalPropertyType, getHelpFile, getHelpFile, getHelpFile, getJsonSafeClassName, getKlass, getPlugin, getPossibleViewNames, getPropertyType, getPropertyType, getPropertyTypeOrDie, getRequiredGlobalConfigPagePermission, getStaticHelpUrl, getT, getViewPage, isInstance, isSubTypeOf, load, newInstance, newInstance, newInstancesFromHeteroList, newInstancesFromHeteroList, save, self, toArray, toList, toMap

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

AxivionSuiteToolDescriptor

public AxivionSuiteToolDescriptor()

Creates the descriptor instance.

Method Details

getDisplayName

@NonNull
public String getDisplayName()

Overrides:

getDisplayName in class Descriptor<Tool>

getHelp

public String getHelp()

Description copied from class: Tool.ToolDescriptor

Returns an optional help text that can provide useful hints on how to configure the static analysis tool so that the report files could be parsed by Jenkins. This help can be a plain text message or an HTML snippet.

Overrides:

getHelp in class Tool.ToolDescriptor

Returns:

the help

getLabelProvider

public StaticAnalysisLabelProvider getLabelProvider()

Description copied from class: Tool.ToolDescriptor

Returns a StaticAnalysisLabelProvider that will render all tool specific labels.

Overrides:

getLabelProvider in class Tool.ToolDescriptor

Returns:

a tool specific StaticAnalysisLabelProvider

doCheckProjectUrl

@POST
public FormValidation doCheckProjectUrl(@AncestorInPath
 BuildableItem project,
 @QueryParameter
 String projectUrl)

Dashboard project url must be a valid url.

Parameters:

project - the project that is configured

projectUrl - url to a project inside an Axivion dashboard

Returns:

FormValidation.ok() is a valid url

doCheckBasedir

@POST
public FormValidation doCheckBasedir(@AncestorInPath
 BuildableItem project,
 @QueryParameter
 String basedir)

Checks whether the given path is a correct os path.

Parameters:

project - the project that is configured

basedir - path to check

Returns:

FormValidation.ok() is a valid url

doCheckCredentialsId

@POST
public FormValidation doCheckCredentialsId(@AncestorInPath
 Item item,
 @QueryParameter
 String credentialsId)

Checks whether valid credentials are given.

Parameters:

item - jenkins configuration

credentialsId - id of the stored credentials pair

Returns:

FormValidation.ok() if credentials exist and are valid

doFillCredentialsIdItems

@POST
public ListBoxModel doFillCredentialsIdItems(@AncestorInPath
 Item item,
 @QueryParameter
 String credentialsId)

Shows the user all available credential id items.

Parameters:

item - jenkins configuration

credentialsId - current used credentials

Returns:

a list view of all credential ids