Package io.jenkins.plugins.prism

Class PrismConfiguration

java.lang.Object

hudson.model.Descriptor<GlobalConfiguration>

jenkins.model.GlobalConfiguration

io.jenkins.plugins.util.GlobalConfigurationItem

io.jenkins.plugins.prism.PrismConfiguration

All Implemented Interfaces:

ExtensionPoint, Describable<GlobalConfiguration>, Saveable, Loadable, OnMaster

@Extension
@Symbol("prism")
public class PrismConfiguration
extends io.jenkins.plugins.util.GlobalConfigurationItem

Global system configuration for Prism. These configuration options are used globally for all jobs and require administrator permissions.

The following settings can be configured:

• Allowed source code directories: some plugins copy source code files to Jenkins' build folder so that these files can be rendered in the user interface together with build results (coverage, warnings, etc.). If these files are not part of the workspace of a build, then Jenkins will not show them by default: otherwise sensitive files could be shown by accident. You can provide a list of additional source code directories that are allowed to be shown in Jenkins user interface here. Note, that such a directory must be an absolute path on the agent that executes the build.

Author:

Ullrich Hafner

Nested Class Summary

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

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Constructor	Description
PrismConfiguration()	Creates the global configuration of source code directories and loads the initial values from the corresponding XML file.

Method Summary

Modifier and Type	Method	Description
protected void	clearRepeatableProperties()
GlobalConfigurationCategory	getCategory()
static PrismConfiguration	getInstance()	Returns the singleton instance of this PrismConfiguration.
List<PermittedSourceCodeDirectory>	getSourceDirectories()	Returns the list of allowed source code directories.
PrismTheme	getTheme()	Deprecated. use PrismAppearanceConfiguration instead
boolean	isAllowedSourceDirectory(String sourceDirectory)	Returns whether the specified director is registered as permitted source code directory.
void	setSourceDirectories(List<PermittedSourceCodeDirectory> sourceDirectories)	Sets the list of source directories 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, configure, getDescriptor, getGlobalConfigPage

Methods inherited from class hudson.model.Descriptor

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

Methods inherited from class java.lang.Object

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

Constructor Details

PrismConfiguration

public PrismConfiguration()

Creates the global configuration of source code directories and loads the initial values from the corresponding XML file.

Method Details

getCategory

@NonNull
public GlobalConfigurationCategory getCategory()

Overrides:

getCategory in class Descriptor<GlobalConfiguration>

clearRepeatableProperties

protected void clearRepeatableProperties()

Overrides:

clearRepeatableProperties in class io.jenkins.plugins.util.GlobalConfigurationItem

getInstance

public static PrismConfiguration getInstance()

Returns the singleton instance of this PrismConfiguration.

Returns:

the singleton instance

getSourceDirectories

public List<PermittedSourceCodeDirectory> getSourceDirectories()

Returns the list of allowed source code directories.

Returns:

the source root folders

setSourceDirectories

@DataBoundSetter
public void setSourceDirectories(List<PermittedSourceCodeDirectory> sourceDirectories)

Sets the list of source directories to the specified elements. Previously set directories will be removed.

Parameters:

sourceDirectories - the source directories that contain the affected files

getTheme

@Deprecated
public PrismTheme getTheme()

Deprecated.

use PrismAppearanceConfiguration instead

For maintaining compatibility after the move to PrismAppearanceConfiguration.

Returns:

a model with the currently selected theme

isAllowedSourceDirectory

public boolean isAllowedSourceDirectory(String sourceDirectory)

Returns whether the specified director is registered as permitted source code directory.

Parameters:

sourceDirectory - the source directory to check

Returns:

true if the specified director is registered, false otherwise