Index

A B C D E F G H I J L M O P R S V W _ 
All Classes and Interfaces|All Packages|Serialized Form

A

AbstractXmlStream<T> - Class in io.jenkins.plugins.util
Base class that provides the basic setup to read and write entities of a given type using XStream.
AbstractXmlStream(Class<T>) - Constructor for class io.jenkins.plugins.util.AbstractXmlStream
Creates a new instance of AbstractXmlStream.
AgentFileVisitor<T extends Serializable> - Class in io.jenkins.plugins.util
Finds all files that match a specified Ant file pattern and visits these files with the processing method AgentFileVisitor.processFile(Path, Charset, FilteredLog), that has to be implemented by concrete subclasses.
AgentFileVisitor(String, String, boolean, boolean) - Constructor for class io.jenkins.plugins.util.AgentFileVisitor
Creates a new instance of AgentFileVisitor.
AgentFileVisitor.FileVisitorResult<T extends Serializable> - Class in io.jenkins.plugins.util
The results for all found files.

B

BuildAction<T> - Class in io.jenkins.plugins.util
Controls the life cycle of the results in a build.
BuildAction(Run<?, ?>, T) - Constructor for class io.jenkins.plugins.util.BuildAction
Creates a new instance of BuildAction.
BuildAction(Run<?, ?>, T, boolean) - Constructor for class io.jenkins.plugins.util.BuildAction
Creates a new instance of BuildAction.
BuildResultNavigator - Class in io.jenkins.plugins.util
Navigates from the current results to the same results of any other build of the same job.
BuildResultNavigator() - Constructor for class io.jenkins.plugins.util.BuildResultNavigator
 

C

CharsetValidation - Class in io.jenkins.plugins.util
Validates the charset configuration.
CharsetValidation() - Constructor for class io.jenkins.plugins.util.CharsetValidation
 
clearRepeatableProperties() - Method in class io.jenkins.plugins.util.GlobalConfigurationItem
Clears all model elements of a repeatable property.
configure(StaplerRequest, JSONObject) - Method in class io.jenkins.plugins.util.GlobalConfigurationItem
 
configureXStream(XStream2) - Method in class io.jenkins.plugins.util.AbstractXmlStream
Configures the XStream instance with custom converters or alias definitions.
createDefaultValue() - Method in class io.jenkins.plugins.util.AbstractXmlStream
Returns the default value that should be returned if the XML file is broken.
createProjectAction() - Method in class io.jenkins.plugins.util.BuildAction
 
createXmlStream() - Method in class io.jenkins.plugins.util.BuildAction
Creates the XML stream to read the results.

D

doIndex(StaplerRequest, StaplerResponse) - Method in class io.jenkins.plugins.util.JobAction
Redirects the index page to the last result.

E

EnvironmentResolver - Class in io.jenkins.plugins.util
Resolves environment parameters in a string value.
EnvironmentResolver() - Constructor for class io.jenkins.plugins.util.EnvironmentResolver
Creates a new instance of EnvironmentResolver.
expandEnvironmentVariables(EnvVars, String) - Method in class io.jenkins.plugins.util.EnvironmentResolver
Resolves build parameters in the specified string value to EnvironmentResolver.resolveVariablesDepth times.

F

FieldValidator_Error_DefaultEncoding(Object) - Static method in class io.jenkins.plugins.util.Messages
Key FieldValidator.Error.DefaultEncoding: Encoding must be a supported encoding of the Java platform, see: <a rel="noopener noreferrer" href="{0}">java.nio.charset.Charset</a>.

G

getAbsoluteUrl(String...) - Method in class io.jenkins.plugins.util.JenkinsFacade
Returns an absolute URL for the specified url elements: e.g., creates the sequence ${rootUrl}/element1/element2.
getAllCharsets() - Method in class io.jenkins.plugins.util.CharsetValidation
Returns all available character set names.
getAllJobNames() - Method in class io.jenkins.plugins.util.JenkinsFacade
Returns the full names of all available jobs.
getAllJobs() - Method in class io.jenkins.plugins.util.JenkinsFacade
Returns all available jobs.
getBuild(String) - Method in class io.jenkins.plugins.util.JenkinsFacade
Gets a build by the full ID.
getBuildActionClass() - Method in class io.jenkins.plugins.util.JobAction
 
getBuildActionFromHistoryStartingFrom(Run<?, ?>, Class<T>) - Static method in class io.jenkins.plugins.util.BuildAction
Returns a BuildAction of the specified baseline build.
getBuildResultBaseName() - Method in class io.jenkins.plugins.util.BuildAction
 
getCharset(String) - Method in class io.jenkins.plugins.util.CharsetValidation
Returns the default charset for the specified encoding string.
getDescriptor(Class<? extends Describable>) - Method in class io.jenkins.plugins.util.JenkinsFacade
Gets the Descriptor that corresponds to the given Describable type.
getDescriptorOrDie(Class<? extends Describable>) - Method in class io.jenkins.plugins.util.JenkinsFacade
Works just like JenkinsFacade.getDescriptor(Class) but don't take no for an answer.
getDescriptorsFor(Class<T>) - Method in class io.jenkins.plugins.util.JenkinsFacade
Returns the discovered instances for the given descriptor type.
getExtensionsFor(Class<T>) - Method in class io.jenkins.plugins.util.JenkinsFacade
Returns the discovered instances for the given extension type.
getFullNameOf(Job<?, ?>) - Method in class io.jenkins.plugins.util.JenkinsFacade
Returns the full name of the specified job.
getImagePath(BallColor) - Method in class io.jenkins.plugins.util.JenkinsFacade
Deprecated.
BallColor should not be used anymore, use the icon tag in jelly views or the icon class name of BallColor
getImagePath(String) - Method in class io.jenkins.plugins.util.JenkinsFacade
Returns the absolute URL for the specified icon.
getJob(String) - Method in class io.jenkins.plugins.util.JenkinsFacade
Gets a Job by its full name.
getLatestAction() - Method in class io.jenkins.plugins.util.JobAction
Returns the latest results for this job.
getLegacyInstanceId() - Method in class io.jenkins.plugins.util.JenkinsFacade
Returns the unique identifier of this Jenkins that has been historically used to identify this Jenkins to the outside world.
getLog() - Method in class io.jenkins.plugins.util.AgentFileVisitor.FileVisitorResult
 
getOwner() - Method in class io.jenkins.plugins.util.BuildAction
 
getOwner() - Method in class io.jenkins.plugins.util.JobAction
Returns the job this action belongs to.
getProjectActions() - Method in class io.jenkins.plugins.util.BuildAction
 
getResult() - Method in class io.jenkins.plugins.util.BuildAction
Returns the repository statistics.
getResults() - Method in class io.jenkins.plugins.util.AgentFileVisitor.FileVisitorResult
 
getSameUrlForOtherBuild(Run<?, ?>, String, String, Run<?, ?>) - Method in class io.jenkins.plugins.util.BuildResultNavigator
Navigates from the current results to the same results of any other build of the same job.
getSameUrlForOtherBuild(Run<?, ?>, String, String, String) - Method in class io.jenkins.plugins.util.BuildResultNavigator
Navigates from the current results to the same results of any other build of the same job.
GlobalConfigurationFacade - Class in io.jenkins.plugins.util
Facade to Jenkins GlobalConfiguration instance to prevent IO access during tests.
GlobalConfigurationFacade(GlobalConfiguration) - Constructor for class io.jenkins.plugins.util.GlobalConfigurationFacade
Creates a new facade to the specified GlobalConfiguration.
GlobalConfigurationItem - Class in io.jenkins.plugins.util
Testable base class for items of the GlobalConfiguration page.
GlobalConfigurationItem() - Constructor for class io.jenkins.plugins.util.GlobalConfigurationItem
GlobalConfigurationItem(GlobalConfigurationFacade) - Constructor for class io.jenkins.plugins.util.GlobalConfigurationItem

H

hasErrors() - Method in class io.jenkins.plugins.util.AgentFileVisitor.FileVisitorResult
Returns whether there have been error messages recorded.
hasPermission(Permission) - Method in class io.jenkins.plugins.util.JenkinsFacade
Checks if the current security principal has this permission.
hasPermission(Permission, AbstractItem) - Method in class io.jenkins.plugins.util.JenkinsFacade
Checks if the current security principal has this permission for the specified item.
hasPermission(Permission, Job<?, ?>) - Method in class io.jenkins.plugins.util.JenkinsFacade
Checks if the current security principal has this permission for the specified project.
hasPermission(Permission, View) - Method in class io.jenkins.plugins.util.JenkinsFacade
Checks if the current security principal has this permission for the specified view.
hasPermission(Permission, AccessControlled) - Method in class io.jenkins.plugins.util.JenkinsFacade
Checks if the current security principal has this permission for the specified access controlled object.

I

invoke(File, VirtualChannel) - Method in class io.jenkins.plugins.util.AgentFileVisitor
 
io.jenkins.plugins.util - package io.jenkins.plugins.util
Provides utility classes for plugins.
isPluginInstalled(String) - Method in class io.jenkins.plugins.util.JenkinsFacade
Returns whether the plugin with the specified ID (short name, artifact ID) is installed.

J

JenkinsFacade - Class in io.jenkins.plugins.util
Facade to Jenkins server.
JenkinsFacade() - Constructor for class io.jenkins.plugins.util.JenkinsFacade
 
JobAction<T extends BuildAction<?>> - Class in io.jenkins.plugins.util
A job action displays a link on the side panel of a job that refers to the last build that contains results (i.e.
JobAction(Job<?, ?>, Class<T>) - Constructor for class io.jenkins.plugins.util.JobAction
Creates a new instance of JobAction.

L

load() - Method in class io.jenkins.plugins.util.GlobalConfigurationFacade
Loads the data from the disk into this object.
load() - Method in class io.jenkins.plugins.util.GlobalConfigurationItem
 
log(FilteredLog) - Method in class io.jenkins.plugins.util.LogHandler
Log all info and error messages that are stored in the set of issues.
log(String, Object...) - Method in class io.jenkins.plugins.util.LogHandler
Logs the specified message.
log(String, Object...) - Method in class io.jenkins.plugins.util.PluginLogger
Logs the specified message.
logEachLine(Collection<String>) - Method in class io.jenkins.plugins.util.PluginLogger
Logs the specified messages.
LogHandler - Class in io.jenkins.plugins.util
Handles logging of issues log and error messages to a TaskListener instance.
LogHandler(TaskListener, String) - Constructor for class io.jenkins.plugins.util.LogHandler
Creates a new LogHandler.
LogHandler(TaskListener, String, FilteredLog) - Constructor for class io.jenkins.plugins.util.LogHandler
Creates a new LogHandler.

M

Messages - Class in io.jenkins.plugins.util
Generated localization support class.
Messages() - Constructor for class io.jenkins.plugins.util.Messages
 

O

onAttached(Run<?, ?>) - Method in class io.jenkins.plugins.util.BuildAction
 
onLoad(Run<?, ?>) - Method in class io.jenkins.plugins.util.BuildAction
 

P

PluginLogger - Class in io.jenkins.plugins.util
A simple logger that prefixes each message with the name of a plugin.
PluginLogger(PrintStream, String) - Constructor for class io.jenkins.plugins.util.PluginLogger
Creates a new PluginLogger.
plural(int, String) - Method in class io.jenkins.plugins.util.AgentFileVisitor
Creates the correct singular or plural form of the specified word depending on the size of the elements.
processFile(Path, Charset, FilteredLog) - Method in class io.jenkins.plugins.util.AgentFileVisitor
 

R

read(Path) - Method in class io.jenkins.plugins.util.AbstractXmlStream
Reads the specified file and creates a new instance of the given type.
readResolve() - Method in class io.jenkins.plugins.util.BuildAction
Called after de-serialization to improve the memory usage.
readResolve() - Method in class io.jenkins.plugins.util.GlobalConfigurationItem
Called after de-serialization to restore transient fields.

S

save() - Method in class io.jenkins.plugins.util.GlobalConfigurationFacade
Saves the configuration info to the disk.
save() - Method in class io.jenkins.plugins.util.GlobalConfigurationItem
 

V

validateCharset(String) - Method in class io.jenkins.plugins.util.CharsetValidation
Performs on-the-fly validation of the character encoding.

W

write(Path, T) - Method in class io.jenkins.plugins.util.AbstractXmlStream
Writes the specified instance to the given file.

_

_FieldValidator_Error_DefaultEncoding(Object) - Static method in class io.jenkins.plugins.util.Messages
Key FieldValidator.Error.DefaultEncoding: Encoding must be a supported encoding of the Java platform, see: <a rel="noopener noreferrer" href="{0}">java.nio.charset.Charset</a>.
A B C D E F G H I J L M O P R S V W _ 
All Classes and Interfaces|All Packages|Serialized Form