Index
All Classes and Interfaces|All Packages|Serialized Form
A
- allFiles(Run<?, ?>, int) - Static method in class io.jenkins.plugins.artifactexplorer.ArtifactTree
-
Lists every file (not directory) in the build's artifacts as relative paths, for client side search.
- allFiles(VirtualFile, int) - Static method in class io.jenkins.plugins.artifactexplorer.ArtifactTree
-
Lists every file (not directory) under a
VirtualFileroot as relative paths. - ArtifactExplorerAction - Class in io.jenkins.plugins.artifactexplorer
-
The explorer page for one build (or controller
/userContent/), plus the small JSON API its script uses. - ArtifactExplorerAction(Run<?, ?>) - Constructor for class io.jenkins.plugins.artifactexplorer.ArtifactExplorerAction
- ArtifactExplorerAction_DisplayName() - Static method in class io.jenkins.plugins.artifactexplorer.Messages
-
Key
ArtifactExplorerAction.DisplayName:Artifact Explorer. - ArtifactExplorerAction.UserContentExplorerAction - Class in io.jenkins.plugins.artifactexplorer
-
Root action backing the
<jenkinsurl>/userContent/directory browser replacement. - ArtifactExplorerActionFactory - Class in io.jenkins.plugins.artifactexplorer
-
Attaches an
ArtifactExplorerActionto every build the current user is permitted to read artifacts from. - ArtifactExplorerActionFactory() - Constructor for class io.jenkins.plugins.artifactexplorer.ArtifactExplorerActionFactory
- ArtifactExplorerFilter - Class in io.jenkins.plugins.artifactexplorer
-
Makes the classic
<build>/artifact/<dir>/and/userContent/<dir>/URLs show the explorer instead of the built-in directory listing. - ArtifactExplorerFilter() - Constructor for class io.jenkins.plugins.artifactexplorer.ArtifactExplorerFilter
- ArtifactSummaryDecorator - Class in io.jenkins.plugins.artifactexplorer
-
Injects client-side scripts to progressively enhance classic artifact summaries (e.g.
- ArtifactSummaryDecorator() - Constructor for class io.jenkins.plugins.artifactexplorer.ArtifactSummaryDecorator
- ArtifactTree - Class in io.jenkins.plugins.artifactexplorer
-
Read-only view of a build's archived artifacts (or controller
userContent), built onArtifactManager.root()/VirtualFileso it works for any artifact manager (local disk, S3, ...). - ArtifactTree.Entry - Record Class in io.jenkins.plugins.artifactexplorer
-
One file or directory directly under a directory.
- ArtifactTree.FilePreview - Record Class in io.jenkins.plugins.artifactexplorer
-
Preview metadata, bounded UTF-8 text content, and optional CommonMark HTML for a single artifact file.
- ArtifactTree.Listing<T> - Record Class in io.jenkins.plugins.artifactexplorer
-
Result of a (possibly truncated) listing.
- ArtifactTree.TooLargeException - Exception Class in io.jenkins.plugins.artifactexplorer
-
Thrown by
ArtifactTree.sha256(Run, String, long)when a file is larger than the allowed limit.
B
- binary() - Method in record class io.jenkins.plugins.artifactexplorer.ArtifactTree.FilePreview
-
Returns the value of the
binaryrecord component.
C
- checkAccess() - Method in class io.jenkins.plugins.artifactexplorer.ArtifactExplorerAction
- children(Run<?, ?>, String, int) - Static method in class io.jenkins.plugins.artifactexplorer.ArtifactTree
-
Lists the direct children of a directory, directories first, then by case-insensitive name.
- children(VirtualFile, String, int) - Static method in class io.jenkins.plugins.artifactexplorer.ArtifactTree
-
Lists the direct children of a directory under a
VirtualFileroot. - createFor(Run) - Method in class io.jenkins.plugins.artifactexplorer.ArtifactExplorerActionFactory
D
- directory() - Method in record class io.jenkins.plugins.artifactexplorer.ArtifactTree.Entry
-
Returns the value of the
directoryrecord component. - doPreview(String) - Method in class io.jenkins.plugins.artifactexplorer.ArtifactExplorerAction
-
GET preview?path=a/b.txt: metadata, bounded UTF-8 text preview, and optional CommonMark HTML. - doSearchIndex() - Method in class io.jenkins.plugins.artifactexplorer.ArtifactExplorerAction
-
GET searchIndex: every file path in the build, for client side search. - doSha256(String) - Method in class io.jenkins.plugins.artifactexplorer.ArtifactExplorerAction
-
GET sha256?path=a/b.txt: lowercase SHA-256 hex digest of a single file. - doTree(String) - Method in class io.jenkins.plugins.artifactexplorer.ArtifactExplorerAction
-
GET tree?path=a/b: direct children of a directory.
E
- Entry(String, String, boolean, long, long) - Constructor for record class io.jenkins.plugins.artifactexplorer.ArtifactTree.Entry
-
Creates an instance of a
Entryrecord class. - equals(Object) - Method in record class io.jenkins.plugins.artifactexplorer.ArtifactTree.Entry
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.jenkins.plugins.artifactexplorer.ArtifactTree.FilePreview
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.jenkins.plugins.artifactexplorer.ArtifactTree.Listing
-
Indicates whether some other object is "equal to" this one.
- ExplorerConfiguration - Class in io.jenkins.plugins.artifactexplorer
-
Global switches for the plugin, shown under Manage Jenkins → System.
- ExplorerConfiguration() - Constructor for class io.jenkins.plugins.artifactexplorer.ExplorerConfiguration
F
- FilePreview(String, String, long, long, boolean, boolean, String, String) - Constructor for record class io.jenkins.plugins.artifactexplorer.ArtifactTree.FilePreview
-
Creates an instance of a
FilePreviewrecord class.
G
- get() - Static method in class io.jenkins.plugins.artifactexplorer.ExplorerConfiguration
- getArtifactRootUrl() - Method in class io.jenkins.plugins.artifactexplorer.ArtifactExplorerAction
-
URL of the raw artifact / directory root (
<build>/artifact/or/userContent/). - getBuildUrl() - Method in class io.jenkins.plugins.artifactexplorer.ArtifactExplorerAction
-
URL of the build page, with a trailing slash and the context path.
- getCategory() - Method in class io.jenkins.plugins.artifactexplorer.ExplorerConfiguration
- getDisplayName() - Method in class io.jenkins.plugins.artifactexplorer.ArtifactExplorerAction
- getDisplayName() - Method in class io.jenkins.plugins.artifactexplorer.ArtifactExplorerAction.UserContentExplorerAction
- getExplorerRootUrl() - Method in class io.jenkins.plugins.artifactexplorer.ArtifactExplorerAction
-
URL of the JSON API / explorer endpoint (
<build>/artifact-explorer/or/userContent-explorer/). - getIconFileName() - Method in class io.jenkins.plugins.artifactexplorer.ArtifactExplorerAction
- getIconFileName() - Method in class io.jenkins.plugins.artifactexplorer.ArtifactExplorerAction.UserContentExplorerAction
- getInitialPath() - Method in class io.jenkins.plugins.artifactexplorer.ArtifactExplorerAction
-
Directory to show initially: set by the filter, or given as
?path=when visited directly. - getMaxEntries() - Method in class io.jenkins.plugins.artifactexplorer.ArtifactExplorerAction
- getMaxEntries() - Method in class io.jenkins.plugins.artifactexplorer.ExplorerConfiguration
- getObject() - Method in class io.jenkins.plugins.artifactexplorer.ArtifactExplorerAction
- getRun() - Method in class io.jenkins.plugins.artifactexplorer.ArtifactExplorerAction
- getUrlName() - Method in class io.jenkins.plugins.artifactexplorer.ArtifactExplorerAction
- getUrlName() - Method in class io.jenkins.plugins.artifactexplorer.ArtifactExplorerAction.UserContentExplorerAction
H
- handle(HttpServletRequest, HttpServletResponse) - Method in class io.jenkins.plugins.artifactexplorer.ArtifactExplorerFilter
- hashCode() - Method in record class io.jenkins.plugins.artifactexplorer.ArtifactTree.Entry
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.jenkins.plugins.artifactexplorer.ArtifactTree.FilePreview
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.jenkins.plugins.artifactexplorer.ArtifactTree.Listing
-
Returns a hash code value for this object.
I
- io.jenkins.plugins.artifactexplorer - package io.jenkins.plugins.artifactexplorer
- isEnabled() - Method in class io.jenkins.plugins.artifactexplorer.ArtifactSummaryDecorator
- isReplaceClassicBrowser() - Method in class io.jenkins.plugins.artifactexplorer.ExplorerConfiguration
- items() - Method in record class io.jenkins.plugins.artifactexplorer.ArtifactTree.Listing
-
Returns the value of the
itemsrecord component.
L
- lastModified() - Method in record class io.jenkins.plugins.artifactexplorer.ArtifactTree.Entry
-
Returns the value of the
lastModifiedrecord component. - lastModified() - Method in record class io.jenkins.plugins.artifactexplorer.ArtifactTree.FilePreview
-
Returns the value of the
lastModifiedrecord component. - Listing(List<T>, boolean) - Constructor for record class io.jenkins.plugins.artifactexplorer.ArtifactTree.Listing
-
Creates an instance of a
Listingrecord class.
M
- Messages - Class in io.jenkins.plugins.artifactexplorer
-
Generated localization support class.
- Messages() - Constructor for class io.jenkins.plugins.artifactexplorer.Messages
N
- name() - Method in record class io.jenkins.plugins.artifactexplorer.ArtifactTree.Entry
-
Returns the value of the
namerecord component. - name() - Method in record class io.jenkins.plugins.artifactexplorer.ArtifactTree.FilePreview
-
Returns the value of the
namerecord component.
P
- path() - Method in record class io.jenkins.plugins.artifactexplorer.ArtifactTree.Entry
-
Returns the value of the
pathrecord component. - path() - Method in record class io.jenkins.plugins.artifactexplorer.ArtifactTree.FilePreview
-
Returns the value of the
pathrecord component. - preview(Run<?, ?>, String, int) - Static method in class io.jenkins.plugins.artifactexplorer.ArtifactTree
-
Reads a bounded preview of a single artifact file.
- preview(VirtualFile, String, int) - Static method in class io.jenkins.plugins.artifactexplorer.ArtifactTree
-
Reads a bounded preview of a single file under a
VirtualFileroot.
R
- renderedHtml() - Method in record class io.jenkins.plugins.artifactexplorer.ArtifactTree.FilePreview
-
Returns the value of the
renderedHtmlrecord component. - root() - Method in class io.jenkins.plugins.artifactexplorer.ArtifactExplorerAction
S
- sanitize(String) - Static method in class io.jenkins.plugins.artifactexplorer.ArtifactTree
-
Validates and normalizes a user supplied relative path.
- setMaxEntries(int) - Method in class io.jenkins.plugins.artifactexplorer.ExplorerConfiguration
- setReplaceClassicBrowser(boolean) - Method in class io.jenkins.plugins.artifactexplorer.ExplorerConfiguration
- sha256(Run<?, ?>, String, long) - Static method in class io.jenkins.plugins.artifactexplorer.ArtifactTree
-
Computes the lowercase SHA-256 hex digest of a single artifact file.
- sha256(VirtualFile, String, long) - Static method in class io.jenkins.plugins.artifactexplorer.ArtifactTree
-
Computes the lowercase SHA-256 hex digest of a single file under a
VirtualFileroot. - size() - Method in record class io.jenkins.plugins.artifactexplorer.ArtifactTree.Entry
-
Returns the value of the
sizerecord component. - size() - Method in record class io.jenkins.plugins.artifactexplorer.ArtifactTree.FilePreview
-
Returns the value of the
sizerecord component.
T
- text() - Method in record class io.jenkins.plugins.artifactexplorer.ArtifactTree.FilePreview
-
Returns the value of the
textrecord component. - TooLargeException(long, long) - Constructor for exception class io.jenkins.plugins.artifactexplorer.ArtifactTree.TooLargeException
- toString() - Method in record class io.jenkins.plugins.artifactexplorer.ArtifactTree.Entry
-
Returns a string representation of this record class.
- toString() - Method in record class io.jenkins.plugins.artifactexplorer.ArtifactTree.FilePreview
-
Returns a string representation of this record class.
- toString() - Method in record class io.jenkins.plugins.artifactexplorer.ArtifactTree.Listing
-
Returns a string representation of this record class.
- truncated() - Method in record class io.jenkins.plugins.artifactexplorer.ArtifactTree.FilePreview
-
Returns the value of the
truncatedrecord component. - truncated() - Method in record class io.jenkins.plugins.artifactexplorer.ArtifactTree.Listing
-
Returns the value of the
truncatedrecord component. - type() - Method in class io.jenkins.plugins.artifactexplorer.ArtifactExplorerActionFactory
U
- UserContentExplorerAction() - Constructor for class io.jenkins.plugins.artifactexplorer.ArtifactExplorerAction.UserContentExplorerAction
- UserContentExplorerAction_DisplayName() - Static method in class io.jenkins.plugins.artifactexplorer.Messages
-
Key
UserContentExplorerAction.DisplayName:User Content.
_
- _ArtifactExplorerAction_DisplayName() - Static method in class io.jenkins.plugins.artifactexplorer.Messages
-
Key
ArtifactExplorerAction.DisplayName:Artifact Explorer. - _UserContentExplorerAction_DisplayName() - Static method in class io.jenkins.plugins.artifactexplorer.Messages
-
Key
UserContentExplorerAction.DisplayName:User Content.
All Classes and Interfaces|All Packages|Serialized Form