Package io.jenkins.plugins.prism

Klasse PrismConfiguration

java.lang.Object

hudson.model.Descriptor<GlobalConfiguration>

jenkins.model.GlobalConfiguration

io.jenkins.plugins.util.GlobalConfigurationItem

io.jenkins.plugins.prism.PrismConfiguration

Alle implementierten Schnittstellen:

ExtensionPoint, Describable<GlobalConfiguration>, Saveable, 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.

Autor:

Ullrich Hafner

Verschachtelte Klassen - Übersicht

Von Klasse geerbte verschachtelte Klassen/Schnittstellen hudson.model.Descriptor

Descriptor.FormException, Descriptor.PropertyType, Descriptor.Self

Von Schnittstelle geerbte verschachtelte Klassen/Schnittstellen hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Feldübersicht

Von Klasse geerbte Felder hudson.model.Descriptor

clazz

Von Schnittstelle geerbte Felder hudson.model.Saveable

NOOP

Konstruktorübersicht

Konstruktoren

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

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
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()	Veraltet. 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.

Von Klasse geerbte Methoden io.jenkins.plugins.util.GlobalConfigurationItem

configure, load, readResolve, save

Von Klasse geerbte Methoden jenkins.model.GlobalConfiguration

all, getDescriptor, getGlobalConfigPage

Von Klasse geerbte Methoden hudson.model.Descriptor

addHelpFileRedirect, bindJSON, calcAutoCompleteSettings, calcFillSettings, configure, 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, getT, getViewPage, isInstance, isSubTypeOf, newInstance, newInstance, newInstancesFromHeteroList, newInstancesFromHeteroList, self, toArray, toList, toMap

Von Klasse geerbte Methoden java.lang.Object

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

Konstruktordetails

PrismConfiguration

public PrismConfiguration()

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

Methodendetails

getCategory

@NonNull
public GlobalConfigurationCategory getCategory()

Setzt außer Kraft:

getCategory in Klasse Descriptor<GlobalConfiguration>

clearRepeatableProperties

protected void clearRepeatableProperties()

Setzt außer Kraft:

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

getInstance

public static PrismConfiguration getInstance()

Returns the singleton instance of this PrismConfiguration.

Gibt zurück:

the singleton instance

getSourceDirectories

public List<PermittedSourceCodeDirectory> getSourceDirectories()

Returns the list of allowed source code directories.

Gibt zurück:

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.

Parameter:

sourceDirectories - the source directories that contain the affected files

getTheme

@Deprecated
public PrismTheme getTheme()

Veraltet.

use PrismAppearanceConfiguration instead

For maintaining compatibility after the move to PrismAppearanceConfiguration.

Gibt zurück:

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.

Parameter:

sourceDirectory - the source directory to check

Gibt zurück:

true if the specified director is registered, false otherwise