Index

A B C D E F G H I J K L M N O P Q R S T U V W X _ 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

acknowledge(String, String) - Method in class io.jenkins.plugins.batchcontrol.ops.IncidentService
OPEN -> ACKNOWLEDGED; any other current status is refused (forward-only).
ACKNOWLEDGED - Enum constant in enum class io.jenkins.plugins.batchcontrol.model.IncidentStatus
 
actionLabel(ActivationRequest.Action) - Method in class io.jenkins.plugins.batchcontrol.action.ActivationsSection
S-13-08: ACTIVATE and HOLD worded so they cannot be mistaken for each other.
actionLabel(ActivationRequest.Action) - Method in class io.jenkins.plugins.batchcontrol.action.ComputedFolderActivationAction
 
actionLabel(ActivationRequest.Action) - Method in class io.jenkins.plugins.batchcontrol.action.JobActivationForm
S-13-08: the request kind as the screens word it.
actionLabel(ActivationRequest.Action) - Method in class io.jenkins.plugins.batchcontrol.action.JobActivationNoticeAction
S-13-08: the request kind as the screens word it.
actionLabel(ActivationRequest.Action) - Static method in class io.jenkins.plugins.batchcontrol.ui.ActivationView
S-13-08: the two request kinds, worded so they cannot be mistaken for each other on any list or detail screen.
ACTIVATE - Enum constant in enum class io.jenkins.plugins.batchcontrol.model.ActivationRequest.Action
Put the job into service: timer and upstream causes may run it (subject to its settings).
activated(String, String, Instant, String) - Static method in class io.jenkins.plugins.batchcontrol.model.ActivationState
An activated state, granted by by through requestId (null for the upgrade seeding).
activated(String, String, Instant, String, String) - Static method in class io.jenkins.plugins.batchcontrol.model.ActivationState
As ActivationState.activated(String, String, Instant, String), bound to the item's directory marker.
ACTIVATED - Enum constant in enum class io.jenkins.plugins.batchcontrol.model.ChangeType
A job was put into service (SPEC item 6a, D-39): an ACTIVATE request was approved, or the job existed when this plugin version was first installed and was seeded as activated.
activation(NotificationEvent, ActivationRequest) - Static method in class io.jenkins.plugins.batchcontrol.ops.NotificationDispatcher
Event for an activation or hold request (SPEC item 6a).
activationEnded(NotificationEvent, ActivationRequest, boolean, String) - Static method in class io.jenkins.plugins.batchcontrol.ops.NotificationDispatcher
ActivationItem - Class in io.jenkins.plugins.batchcontrol.action
One activation or hold request at /batch-control/activations/<id>/ (SPEC item 6a), the URL the notifications link to: detail view plus the state-changing POST endpoints approve, reject, cancel and changeApprover, following RequestItem.
ActivationItemListener - Class in io.jenkins.plugins.batchcontrol.listener
Keeps the activation store in step with the items (SPEC item 6a): a rename or move keeps the job's activation under its new full name, a deletion removes it, and a newly created job never inherits a state left under its name; a job created while run control is off is recorded as activated (D-45).
ActivationItemListener() - Constructor for class io.jenkins.plugins.batchcontrol.listener.ActivationItemListener
 
activationLocked() - Static method in class io.jenkins.plugins.batchcontrol.config.BatchControlJobProperty
The new-job activation lock of D-34: approvalRequired, blockTimer and blockUpstream all on, and no upstream allow list — so no cause at all can start the job until somebody turns a switch off in its configuration.
ActivationRequest - Class in io.jenkins.plugins.batchcontrol.model
A request to put one job into service (ActivationRequest.Action.ACTIVATE) or to put it on hold (ActivationRequest.Action.HOLD) (SPEC item 6a, D-39).
ActivationRequest.Action - Enum Class in io.jenkins.plugins.batchcontrol.model
What the request asks for.
ActivationRequest.ApproverChange - Class in io.jenkins.plugins.batchcontrol.model
One approver change entry (D-37); same shape as GrantRequest.ApproverChange.
activationRequests() - Method in record class io.jenkins.plugins.batchcontrol.store.RetentionResult
Returns the value of the activationRequests record component.
activations() - Static method in class io.jenkins.plugins.batchcontrol.ui.SectionAccess
/batch-control/activations/**: requesters, approvers and managers hold it on Jenkins; since D-38c the section also opens for every other user admitted to the root (SectionAccess.canOpenActivations()).
ActivationSeeding - Class in io.jenkins.plugins.batchcontrol.ops
One-time upgrade seeding of activation approval (SPEC item 6a, DESIGN-ACTIVATION-APPROVAL section 6): jobs that exist when this version is first installed are recorded as activated, so installing or upgrading never stops an existing schedule.
ActivationService - Class in io.jenkins.plugins.batchcontrol.policy
Activation approval (SPEC item 6a, D-39): whether a run-controlled job may run unattended, and the single entry point for every ActivationRequest state transition and every ActivationState write.
ActivationsSection - Class in io.jenkins.plugins.batchcontrol.action
The activation request screen at /batch-control/activations/ (SPEC item 6a, D-66): the activation and hold requests the viewer may see as pending (those awaiting the viewer's decision marked), active (the request in effect for its job) and ended, each in pages of 50 (?pendingPage=N, ?activePage=N, ?endedPage=N).
ActivationsSection() - Constructor for class io.jenkins.plugins.batchcontrol.action.ActivationsSection
 
ActivationState - Class in io.jenkins.plugins.batchcontrol.model
Whether a job has been approved to run unattended (SPEC item 6a, D-39).
activationSubject(Item) - Static method in class io.jenkins.plugins.batchcontrol.policy.ActivationService
The item whose activation governs item (D-46c, D-82): the item itself, or for a computed child its nearest computed-folder ancestor, or for a job's sub-item (a matrix configuration, a Maven module) its parent job, resolved again while the item reached is itself such a child (a repository project of an organization folder is carried by the organization folder, which is the item that was created and can be requested on; a configuration of a matrix project inside a multibranch project by that project).
ActivationView - Class in io.jenkins.plugins.batchcontrol.ui
Read-only display helpers for activation state (SPEC item 6a, D-46), shared by the job page, the computed-folder page and the activation screens.
ActiveGrantsSection - Class in io.jenkins.plugins.batchcontrol.action
Routing object for /batch-control/grants/active/....
ActiveGrantsSection() - Constructor for class io.jenkins.plugins.batchcontrol.action.ActiveGrantsSection
 
ActiveGrantsSection.Item - Class in io.jenkins.plugins.batchcontrol.action
One active grant; only carries the revoke endpoint.
addApproverChange(ActivationRequest.ApproverChange) - Method in class io.jenkins.plugins.batchcontrol.model.ActivationRequest
Only the policy service records approver changes.
addApproverChange(GrantRequest.ApproverChange) - Method in class io.jenkins.plugins.batchcontrol.model.GrantRequest
Only the policy services record approver changes.
addApproverChange(RunRequest.ApproverChange) - Method in class io.jenkins.plugins.batchcontrol.model.RunRequest
 
addComment(String, String) - Method in class io.jenkins.plugins.batchcontrol.ops.IncidentService
Appends a comment to the incident history without changing the status — allowed in every status, RESOLVED included (SPEC section 4).
addRerunRequestId(String) - Method in class io.jenkins.plugins.batchcontrol.model.Incident
 
addTransition(IncidentTransition) - Method in class io.jenkins.plugins.batchcontrol.model.Incident
 
all() - Static method in class io.jenkins.plugins.batchcontrol.ops.BatchControlNotifier
All registered notifiers.
ALL - Static variable in record class io.jenkins.plugins.batchcontrol.store.Period
No bounds: every record counts toward the cap.
allowsCreateName(String) - Method in class io.jenkins.plugins.batchcontrol.model.Grant
D-40: whether this grant's Create allows a new item called itemName (the item name, not the full name).
anyPermission() - Static method in class io.jenkins.plugins.batchcontrol.ui.SectionAccess
Any Batch Control permission: without one of these the whole root action is absent.
appendChangeRecord(ChangeRecord) - Method in class io.jenkins.plugins.batchcontrol.store.FileStore
 
appendChangeRecord(ChangeRecord) - Method in interface io.jenkins.plugins.batchcontrol.store.Store
Appends one change record to the monthly JSONL bucket derived from its timestamp.
appendRunRecord(RunRecord) - Method in class io.jenkins.plugins.batchcontrol.store.FileStore
 
appendRunRecord(RunRecord) - Method in interface io.jenkins.plugins.batchcontrol.store.Store
Appends one run record to the monthly JSONL bucket derived from its start time.
applicability(Item) - Method in class io.jenkins.plugins.batchcontrol.security.ChangeControlledRelocationHandler
 
applies(Item, GrantAction) - Static method in class io.jenkins.plugins.batchcontrol.ui.GrantRequestLinks
D-71: whether a permission window carrying action can name item: it must be a top-level item (a job or a folder of any kind); CREATE applies only to a regular folder (GrantScope.createAppliesTo(hudson.model.Item)) and DELETE only to a job (GrantScope.deleteAppliesTo(hudson.model.Item)).
apply(List<ParameterDefinition>, StaplerRequest2) - Static method in class io.jenkins.plugins.batchcontrol.ui.RequestRunPrefill
definitions with each carriable one that has a "p."<name> query parameter in req replaced by a copy defaulting to that value.
applyActivationLock(Job<?, ?>, String, String) - Static method in class io.jenkins.plugins.batchcontrol.listener.ItemChangeListener
Applies the D-34 lock to job exactly as for a newly created job (approvalRequired, blockTimer and blockUpstream on, allowedUpstreamJobs emptied, jobApprovers kept), unless it is a computed child (D-32) or already locked.
applyMissedInvalidations() - Method in class io.jenkins.plugins.batchcontrol.policy.ActivationService
Ends, as INVALIDATED, every PENDING request that missed an invalidation while its file could not be read or written (ActivationService.invalidatePending(java.lang.String, boolean, java.lang.String)) and can now be, when the invalidation applies to the job it names; forgets the others.
applyMissedInvalidations() - Method in class io.jenkins.plugins.batchcontrol.policy.RunRequestService
Ends, as INVALIDATED, every request that missed a D-21 invalidation (RunRequestService.invalidateForJob(java.lang.String, java.lang.String)) and can now be read and written, when the invalidation applies to the job it names; forgets the ones it does not apply to or that are no longer open.
ApprovalPolicy - Class in io.jenkins.plugins.batchcontrol.policy
Approver eligibility rules (SPEC items 2 and 3), shared by RunRequestService and GrantRequestService.
ApprovalQueueDecisionHandler - Class in io.jenkins.plugins.batchcontrol.queue
The queue gate (SPEC item 6, D-03): every run path goes through Queue.QueueDecisionHandler, so approval-required jobs are controlled at one point.
ApprovalQueueDecisionHandler() - Constructor for class io.jenkins.plugins.batchcontrol.queue.ApprovalQueueDecisionHandler
 
ApprovalRebuildValidator - Class in io.jenkins.plugins.batchcontrol.policy
e2e-03 DEF-25 (SPEC item 6 and section 6 usability): the rebuild plugin's Rebuild and Rebuild Last entries are not offered on builds of a job whose manual runs need an approved run request (RunRequestService.requiresApprovalToRun(hudson.model.Job<?, ?>)), because the queue gate refuses every such rebuild.
ApprovalRebuildValidator() - Constructor for class io.jenkins.plugins.batchcontrol.policy.ApprovalRebuildValidator
 
ApprovalRequiredFailure - Exception Class in io.jenkins.plugins.batchcontrol.ui
The refusal of a user-originated manual run of an approval-required job (SPEC item 6, e2e-03 DEF-02), thrown by the queue gate in place of a plain Failure.
ApprovalRequiredFailure(Job<?, ?>, String) - Constructor for exception class io.jenkins.plugins.batchcontrol.ui.ApprovalRequiredFailure
 
ApprovalRequiredFailure(Job<?, ?>, String, List<ParameterValue>) - Constructor for exception class io.jenkins.plugins.batchcontrol.ui.ApprovalRequiredFailure
 
approve(String, String) - Method in class io.jenkins.plugins.batchcontrol.policy.ActivationService
Approves a PENDING request and applies it: ACTIVATE marks the job activated and writes an ChangeType.ACTIVATED record, HOLD marks it not activated and writes a ChangeType.HELD record.
approve(String, String) - Method in class io.jenkins.plugins.batchcontrol.policy.GrantRequestService
Approves a PENDING grant request and creates the grant.
approve(String, String) - Method in class io.jenkins.plugins.batchcontrol.policy.RunRequestService
Approves a PENDING request and submits the build.
APPROVE - Static variable in class io.jenkins.plugins.batchcontrol.security.BatchControlPermissions
Approve or reject requests.
APPROVED - Enum constant in enum class io.jenkins.plugins.batchcontrol.model.RequestStatus
 
APPROVED - Enum constant in enum class io.jenkins.plugins.batchcontrol.ops.NotificationEvent
A designated approver approved the request.
APPROVED_REQUEST - Enum constant in enum class io.jenkins.plugins.batchcontrol.model.CauseType
 
ApprovedCause - Class in io.jenkins.plugins.batchcontrol.queue
Cause carried by every build that runs on behalf of an approved run request (SPEC item 5): links the build to the request id, the requester and the approver.
ApprovedCause(String, String, String) - Constructor for class io.jenkins.plugins.batchcontrol.queue.ApprovedCause
 
approvedNotStarted() - Static method in class io.jenkins.plugins.batchcontrol.policy.EndReasons
An approved run request did not start within the approved-run timeout.
ApprovedRunAction - Class in io.jenkins.plugins.batchcontrol.queue
Invisible marker action that authorizes exactly one queue submission for an approved run request (D-23).
ApprovedRunAction(String) - Constructor for class io.jenkins.plugins.batchcontrol.queue.ApprovedRunAction
 
approvedRunCancelled() - Static method in class io.jenkins.plugins.batchcontrol.policy.EndReasons
D-72b (7): an approved run request whose queue item was cancelled, so it did not start within the approved-run timeout and is never submitted again.
ApprovedRunQueueListener - Class in io.jenkins.plugins.batchcontrol.queue
D-72b (7), security-35 S-35-07: when the queue item of an approved run (it carries ApprovedRunAction) is cancelled (by a user, by clearing the queue, or because its job was deleted), the request records it, so startup recovery never submits that run again and the request's files are disposed of when it ends.
ApprovedRunQueueListener() - Constructor for class io.jenkins.plugins.batchcontrol.queue.ApprovedRunQueueListener
 
ApproverChange(List<String>, List<String>, String, Instant) - Constructor for class io.jenkins.plugins.batchcontrol.model.ActivationRequest.ApproverChange
 
ApproverChange(List<String>, List<String>, String, Instant) - Constructor for class io.jenkins.plugins.batchcontrol.model.GrantRequest.ApproverChange
 
ApproverChange(List<String>, List<String>, String, Instant) - Constructor for class io.jenkins.plugins.batchcontrol.model.RunRequest.ApproverChange
 
ApproverInput - Class in io.jenkins.plugins.batchcontrol.ui
Reads the designated approver set from a submitted form (SPEC item 3, D-37).
ApproverOptions - Class in io.jenkins.plugins.batchcontrol.ui
Computes the approver candidates shown in request forms: the global approver list intersected with the job-level restriction when one is configured (SPEC items 3 and 5).
Approvers - Class in io.jenkins.plugins.batchcontrol.model
Helpers for a designated approver set (D-37): order-preserving, duplicate-free, trimmed, blank entries dropped.
APPROVERS_CHANGED - Enum constant in enum class io.jenkins.plugins.batchcontrol.ops.NotificationEvent
The requester changed the designated approver set of a pending request.
atStartup() - Static method in class io.jenkins.plugins.batchcontrol.ops.SnapshotSeeding
Startup: every item is loaded.
attach(Object) - Method in class io.jenkins.plugins.batchcontrol.ui.FormErrors
Endpoint-side data the view needs to rebuild the form (for example parsed parameters).

B

Baseline() - Constructor for class io.jenkins.plugins.batchcontrol.listener.GrantViolationGuard.Baseline
 
BatchClock - Class in io.jenkins.plugins.batchcontrol.store
Single source of time for the whole plugin.
BatchControlConfigurationLink - Class in io.jenkins.plugins.batchcontrol.config
e2e-03 DEF-10 (SPEC section 6, usability): BatchControl/Manage is enough to open and save the Batch Control configuration.
BatchControlConfigurationLink() - Constructor for class io.jenkins.plugins.batchcontrol.config.BatchControlConfigurationLink
 
BatchControlGlobalConfiguration - Class in io.jenkins.plugins.batchcontrol.config
Global plugin configuration (SPEC section 5 keys and defaults).
BatchControlGlobalConfiguration() - Constructor for class io.jenkins.plugins.batchcontrol.config.BatchControlGlobalConfiguration
 
BatchControlGlobalConfiguration_DisplayName() - Static method in class io.jenkins.plugins.batchcontrol.Messages
Key BatchControlGlobalConfiguration.DisplayName: Batch Control.
BatchControlJobProperty - Class in io.jenkins.plugins.batchcontrol.config
Per-job batch control settings (SPEC items 5 and 6): whether the job requires an approved run request, trigger-blocking policy, and an optional job-level approver restriction.
BatchControlJobProperty(boolean) - Constructor for class io.jenkins.plugins.batchcontrol.config.BatchControlJobProperty
 
BatchControlJobProperty_DisplayName() - Static method in class io.jenkins.plugins.batchcontrol.Messages
Key BatchControlJobProperty.DisplayName: Batch Control.
BatchControlJobProperty.DescriptorImpl - Class in io.jenkins.plugins.batchcontrol.config
 
BatchControlMatrixAuthorizationStrategy - Class in io.jenkins.plugins.batchcontrol.security
matrix-auth's project-based matrix with Batch Control grants layered on top (D-35a, ARCHITECTURE section 4).
BatchControlMatrixAuthorizationStrategy() - Constructor for class io.jenkins.plugins.batchcontrol.security.BatchControlMatrixAuthorizationStrategy
 
BatchControlMatrixAuthorizationStrategy_DisplayName() - Static method in class io.jenkins.plugins.batchcontrol.Messages
Key BatchControlMatrixAuthorizationStrategy.DisplayName: Batch Control: Project-based Matrix Authorization Strategy.
BatchControlMatrixAuthorizationStrategy.ConverterImpl - Class in io.jenkins.plugins.batchcontrol.security
Found by XStream through the $ConverterImpl naming convention.
BatchControlMatrixAuthorizationStrategy.DescriptorImpl - Class in io.jenkins.plugins.batchcontrol.security
Listed on the security page.
BatchControlMatrixCascConfigurator - Class in io.jenkins.plugins.batchcontrol.security
JCasC support for BatchControlMatrixAuthorizationStrategy under the symbol batchControlProjectMatrix, with the same schema as matrix-auth's projectMatrix (D-35a, PoC-5 row 8).
BatchControlMatrixCascConfigurator() - Constructor for class io.jenkins.plugins.batchcontrol.security.BatchControlMatrixCascConfigurator
 
BatchControlNotifier - Class in io.jenkins.plugins.batchcontrol.ops
Extension point receiving Batch Control request events (SPEC item 13, D-36).
BatchControlNotifier() - Constructor for class io.jenkins.plugins.batchcontrol.ops.BatchControlNotifier
 
BatchControlPermissions - Class in io.jenkins.plugins.batchcontrol.security
The five plugin permissions (SPEC item 2), exposed to Matrix/Role authorization strategies as the "Batch Control" group.
BatchControlPermissions() - Constructor for class io.jenkins.plugins.batchcontrol.security.BatchControlPermissions
 
BatchControlPermissions_ApproveDescription() - Static method in class io.jenkins.plugins.batchcontrol.Messages
Key BatchControlPermissions.ApproveDescription: Approve or reject run requests and grant requests..
BatchControlPermissions_ManageDescription() - Static method in class io.jenkins.plugins.batchcontrol.Messages
Key BatchControlPermissions.ManageDescription: Manage the Batch Control global configuration and revoke grants. Implied by Overall/Administer..
BatchControlPermissions_RequestDescription() - Static method in class io.jenkins.plugins.batchcontrol.Messages
Key BatchControlPermissions.RequestDescription: Create run requests for approval-protected jobs..
BatchControlPermissions_RequestGrantDescription() - Static method in class io.jenkins.plugins.batchcontrol.Messages
Key BatchControlPermissions.RequestGrantDescription: Request temporary change permissions (JIT grants)..
BatchControlPermissions_Title() - Static method in class io.jenkins.plugins.batchcontrol.Messages
Key BatchControlPermissions.Title: Batch Control.
BatchControlPermissions_ViewHistoryDescription() - Static method in class io.jenkins.plugins.batchcontrol.Messages
Key BatchControlPermissions.ViewHistoryDescription: View batch control history, dashboards and CSV exports..
BatchControlRoleBasedAuthorizationStrategy - Class in io.jenkins.plugins.batchcontrol.security
role-strategy's role-based strategy with Batch Control grants layered on top (D-35a, ARCHITECTURE section 4).
BatchControlRoleBasedAuthorizationStrategy(Map<String, RoleMap>, Set<PermissionTemplate>) - Constructor for class io.jenkins.plugins.batchcontrol.security.BatchControlRoleBasedAuthorizationStrategy
 
BatchControlRoleBasedAuthorizationStrategy_DisplayName() - Static method in class io.jenkins.plugins.batchcontrol.Messages
Key BatchControlRoleBasedAuthorizationStrategy.DisplayName: Batch Control: Role-Based Strategy.
BatchControlRoleBasedAuthorizationStrategy.ConverterImpl - Class in io.jenkins.plugins.batchcontrol.security
role-strategy's converter is public: the on-disk format is the same, only the type differs.
BatchControlRoleBasedAuthorizationStrategy.DescriptorImpl - Class in io.jenkins.plugins.batchcontrol.security
Listed on the security page.
BatchControlRoleBasedCascConfigurator - Class in io.jenkins.plugins.batchcontrol.security
JCasC support for BatchControlRoleBasedAuthorizationStrategy under the symbol batchControlRoleBased, with the same schema as role-strategy's roleBased (D-35a, PoC-5 row 8).
BatchControlRoleBasedCascConfigurator() - Constructor for class io.jenkins.plugins.batchcontrol.security.BatchControlRoleBasedCascConfigurator
 
BatchControlRootAction - Class in io.jenkins.plugins.batchcontrol.action
Global "Batch Control" page at /batch-control.
BatchControlRootAction() - Constructor for class io.jenkins.plugins.batchcontrol.action.BatchControlRootAction
 
BatchControlStrategyMonitor - Class in io.jenkins.plugins.batchcontrol.ops
"Change control is on, but the installed authorization strategy is not a Batch Control strategy" (D-35a, ARCHITECTURE section 4).
BatchControlStrategyMonitor() - Constructor for class io.jenkins.plugins.batchcontrol.ops.BatchControlStrategyMonitor
 
BatchControlStrategyMonitor_DisplayName() - Static method in class io.jenkins.plugins.batchcontrol.Messages
Key BatchControlStrategyMonitor.DisplayName: Batch Control: grants need a Batch Control authorization strategy.
BLOCKED_BUILD_LABEL - Static variable in class io.jenkins.plugins.batchcontrol.action.RequestRunUiDecorator
The replacement for core's "Build Now" caption.
BlockedAttemptAudit - Class in io.jenkins.plugins.batchcontrol.store
The single writer of the "an attempt was refused" audit records (ChangeType.MARKER_REUSE_BLOCKED, ChangeType.REMOTE_RUN_BLOCKED, ChangeType.TRIGGER_BLOCKED), with a bound on how often one repeated attempt may append (S-21).
buildsMayRunAsSystem() - Static method in class io.jenkins.plugins.batchcontrol.security.SystemBuildCheck
Whether, with change control on, a build of a job without its own build authorization and without a user cause would get no identity other than SYSTEM from the configured authenticators.

C

callerIsAdmin() - Static method in class io.jenkins.plugins.batchcontrol.policy.ApprovalPolicy
Whether the current caller is an administrator (Overall/Administer).
callerIsRequesterWithRequest(String, String) - Static method in class io.jenkins.plugins.batchcontrol.policy.ApprovalPolicy
D-38b: whether the current caller is requester and holds BatchControl/Request on the item fullName (inherited from a folder or from Jenkins, as Jenkins' ACL resolves it).
canCancel(ActivationRequest) - Method in class io.jenkins.plugins.batchcontrol.policy.ActivationService
D-38b: whether the current user may cancel request: its requester holding BatchControl/Request on the item, or a Manage holder.
canCancel(RunRequest) - Method in class io.jenkins.plugins.batchcontrol.policy.RunRequestService
D-38b: whether the current user may cancel request: its requester holding BatchControl/Request on the job, or a Manage holder.
cancel(String) - Method in class io.jenkins.plugins.batchcontrol.policy.ActivationService
Cancels a PENDING request; requester or a Manage holder only (SPEC item 7 rule).
cancel(String) - Method in class io.jenkins.plugins.batchcontrol.policy.GrantRequestService
Cancels a PENDING grant request; requester or a Manage holder only (SPEC item 7 rule).
cancel(String) - Method in class io.jenkins.plugins.batchcontrol.policy.RunRequestService
Cancels a PENDING request; requester or a Manage holder only (SPEC 7).
CANCELLED - Enum constant in enum class io.jenkins.plugins.batchcontrol.model.RequestStatus
 
CANCELLED - Enum constant in enum class io.jenkins.plugins.batchcontrol.ops.NotificationEvent
A pending request was cancelled (D-54).
cancelQueuedMarkers(Collection<String>, Item) - Static method in class io.jenkins.plugins.batchcontrol.listener.RequestInvalidationListener
Best effort: an invalidated approval must never execute, so drop its queued item too.
canChangeApprovers(ActivationRequest) - Method in class io.jenkins.plugins.batchcontrol.policy.ActivationService
D-38b: whether the current user may change the approvers of request: its requester holding BatchControl/Request on the item.
canChangeApprovers(RunRequest) - Method in class io.jenkins.plugins.batchcontrol.policy.RunRequestService
D-38b: whether the current user may change the approvers of request: its requester holding BatchControl/Request on the job.
canConvert(Class) - Method in class io.jenkins.plugins.batchcontrol.security.BatchControlMatrixAuthorizationStrategy.ConverterImpl
 
canConvert(Class) - Method in class io.jenkins.plugins.batchcontrol.security.BatchControlRoleBasedAuthorizationStrategy.ConverterImpl
 
canOpenActivations() - Static method in class io.jenkins.plugins.batchcontrol.ui.SectionAccess
D-38c (amends D-38b): whether the current user may open the Activations screen: every user admitted to the Batch Control root page.
canOpenRequests() - Static method in class io.jenkins.plugins.batchcontrol.ui.SectionAccess
D-38b: whether the current user may open the Run Requests screen: one of SectionAccess.requests() on Jenkins, or run requests of their own to see (Request held only on some jobs or folders).
canOpenRoot() - Static method in class io.jenkins.plugins.batchcontrol.ui.SectionAccess
D-38b: whether the Batch Control root action exists for the current user.
canRequest() - Static method in class io.jenkins.plugins.batchcontrol.ui.GrantRequestLinks
Whether the current user may open the Grants screen and submit a grant request.
canRequest(Item) - Method in class io.jenkins.plugins.batchcontrol.policy.ActivationService
D-38b: whether the current user could request an activation or hold of item: the permission checks of ActivationService.create(Item, ActivationRequest.Action, String, List), namely BatchControl/Request and Item/Read on the item.
canRequest(Job<?, ?>) - Method in class io.jenkins.plugins.batchcontrol.policy.RunRequestService
Whether the current user could submit a run request for job (e2e-03 DEF-12, SPEC section 6 usability): BatchControl/Request and Item/Read on the job (D-38a), the permission checks of RunRequestService.create(hudson.model.Job<?, ?>, java.util.List<hudson.model.ParameterValue>, java.lang.String, java.lang.String).
canRerun(Incident) - Method in class io.jenkins.plugins.batchcontrol.ops.IncidentService
Whether the current user could request a rerun of incident (e2e-03 DEF-12): the incident's job still exists and RunRequestService.canRequest(hudson.model.Job<?, ?>) holds for it, which is what IncidentService.rerun(java.lang.String, java.lang.String) and the request creation check.
canSeeActivationRequest(ActivationRequest) - Static method in class io.jenkins.plugins.batchcontrol.ui.Visibility
An activation or hold request is visible iff the caller has Manage, or is the requester or a member of the designated approver set (P-09, SPEC item 6a).
canSeeGrant(Grant) - Static method in class io.jenkins.plugins.batchcontrol.ui.Visibility
An active grant is visible iff the caller has Manage, or the grant is their own.
canSeeGrantRequest(GrantRequest) - Static method in class io.jenkins.plugins.batchcontrol.ui.Visibility
A grant request is visible iff the caller has Manage, or is the requester or a member of the designated approver set (D-37).
canSeeRunRequest(RunRequest) - Static method in class io.jenkins.plugins.batchcontrol.ui.Visibility
A run request is visible iff the caller has Manage (or Overall/Administer), OR is the requester, OR is a member of the designated approver set (D-37), OR holds Item/Read on the target job.
carriedValues(Job<?, ?>, List<ParameterValue>) - Static method in class io.jenkins.plugins.batchcontrol.ui.RequestRunPrefill
The values of submitted that may be carried to the Request Run form of job, by parameter name, in the job's definition order.
carrierOf(Item) - Static method in class io.jenkins.plugins.batchcontrol.ui.ActivationView
The item that carries the activation of a computed child (D-46c, ActivationService.activationSubject(hudson.model.Item)), or null when the item carries its own.
carrierState(Item) - Method in class io.jenkins.plugins.batchcontrol.action.ComputedFolderActivationAction
 
carrierState(Item) - Method in class io.jenkins.plugins.batchcontrol.action.JobActivationNoticeAction
"activated", "on hold" or "not activated" for the carrying folder.
carrierUrl(Item) - Method in class io.jenkins.plugins.batchcontrol.action.ComputedFolderActivationAction
 
carrierUrl(Item) - Method in class io.jenkins.plugins.batchcontrol.action.JobActivationNoticeAction
The carrying folder's URL when the viewer may read it, else null (plain text).
CauseType - Enum Class in io.jenkins.plugins.batchcontrol.model
Classification of what caused a build, stored in a RunRecord.
changeApprover(String, String) - Method in class io.jenkins.plugins.batchcontrol.policy.RunRequestService
changeApprovers(String, List<String>) - Method in class io.jenkins.plugins.batchcontrol.policy.ActivationService
Replaces the designated approver set of a PENDING request; requester only (D-26, D-37).
changeApprovers(String, List<String>) - Method in class io.jenkins.plugins.batchcontrol.policy.GrantRequestService
Replaces the designated approver set of a PENDING grant request; requester only (SPEC item 3 rules reused, D-26, D-37).
changeApprovers(String, List<String>) - Method in class io.jenkins.plugins.batchcontrol.policy.RunRequestService
Replaces the designated approver set of a PENDING request; requester only (SPEC item 3, D-26, D-37).
ChangeControlledRelocationHandler - Class in io.jenkins.plugins.batchcontrol.security
D-59: puts MoveGuard in front of every move the folders plugin performs.
ChangeControlledRelocationHandler() - Constructor for class io.jenkins.plugins.batchcontrol.security.ChangeControlledRelocationHandler
 
changedUnder(String) - Static method in class io.jenkins.plugins.batchcontrol.ui.GuardInfo
The window that recorded a change to the item or a folder above it, or null when the item is not in the "changed under a grant" state or the grant cannot be read.
changedUnderGrant(String) - Method in class io.jenkins.plugins.batchcontrol.action.BatchControlRootAction
For the batch-control-strategy monitor's view: the permission window that recorded a change to the item (or a folder above it), or null.
ChangeRecord - Class in io.jenkins.plugins.batchcontrol.model
Audit record of a change event (SPEC section 3).
CHANGES_TITLE - Static variable in class io.jenkins.plugins.batchcontrol.ui.SectionTabs
The page title of the Changes section, its tab's tooltip.
ChangesSection - Class in io.jenkins.plugins.batchcontrol.action
The change record list at /batch-control/changes/ (SPEC item 9).
ChangesSection() - Constructor for class io.jenkins.plugins.batchcontrol.action.ChangesSection
 
ChangeType - Enum Class in io.jenkins.plugins.batchcontrol.model
Kind of event captured by a ChangeRecord.
check(CNode, ConfigurationContext) - Method in class io.jenkins.plugins.batchcontrol.security.BatchControlMatrixCascConfigurator
 
check(CNode, ConfigurationContext) - Method in class io.jenkins.plugins.batchcontrol.security.BatchControlRoleBasedCascConfigurator
 
checkDecision(RunRequest) - Static method in class io.jenkins.plugins.batchcontrol.policy.ApprovalPolicy
Checks that the current caller may decide (approve/reject) the given request (SPEC item 3: list membership AND the Approve permission at decision time, SPEC item 2: admin self-approval policy, D-37: any member of the designated set).
checkDecision(String, String, List<String>) - Static method in class io.jenkins.plugins.batchcontrol.policy.ApprovalPolicy
Request-type-agnostic decision check, shared by run requests and grant requests (SPEC item 8 reuses the SPEC item 3 approver rules).
checkDesignation(String, String, Job<?, ?>) - Static method in class io.jenkins.plugins.batchcontrol.policy.ApprovalPolicy
Validates a single-approver designation (pre D-37 form).
checkDesignation(String, List<String>, Job<?, ?>) - Static method in class io.jenkins.plugins.batchcontrol.policy.ApprovalPolicy
Validates an approver-set designation at creation / change time (SPEC item 3, D-37): at least one approver, and every member is on the global list, allowed by the job-level restriction and not the requester (administrator exception per the self-approval policy).
checkDialogPermission() - Method in class io.jenkins.plugins.batchcontrol.action.JobRequestAction
D-66: the check of the dialog view (dialog.jelly, rendered without a layout): the permission of JobRequestAction.getViewPermissions(), on the job.
checked(String, String) - Method in class io.jenkins.plugins.batchcontrol.ui.FormErrors
Whether value was among the submitted values of the repeated field.
checkJobDecision(String, String, List<String>, String) - Static method in class io.jenkins.plugins.batchcontrol.policy.ApprovalPolicy
The decision check of a request whose subject is one job (run and activation requests, SPEC items 3 and 6a): ApprovalPolicy.checkDecision(String, String, List) plus the job's own approver list in force at decision time.
checkKept(List<? extends ParameterValue>, Map<String, Long>) - Static method in class io.jenkins.plugins.batchcontrol.policy.RequestBodyLimit
claimExpiringNotifications(Duration) - Method in class io.jenkins.plugins.batchcontrol.security.GrantService
D-36: marks and returns every active grant whose window ends within lead and whose GRANT_EXPIRING notification was not sent yet.
clearRefresh() - Static method in class io.jenkins.plugins.batchcontrol.listener.ConfigSnapshotListener
Drops any refresh: a new Jenkins session starts, and a refresh belongs to one session.
clearStaleEntry(String) - Method in class io.jenkins.plugins.batchcontrol.security.GrantService
S-29-04: an administrator clears a listed entry whose item no longer resolves (a stale entry).
CliCreateContext - Class in io.jenkins.plugins.batchcontrol.security
D-40: remembers, on the thread that runs it, the target of a create-job or copy-job CLI command, for NewItemName.
CliCreateContext() - Constructor for class io.jenkins.plugins.batchcontrol.security.CliCreateContext
 
clock() - Static method in class io.jenkins.plugins.batchcontrol.store.BatchClock
The current clock (system default zone unless a test installed another one).
ComputedFolderActivationAction - Class in io.jenkins.plugins.batchcontrol.action
Activation on a computed folder (multibranch project, organization folder), which carries the activation of the jobs it generates (D-46c, SPEC item 6a).
ComputedFolderActivationAction(ComputedFolder<?>) - Constructor for class io.jenkins.plugins.batchcontrol.action.ComputedFolderActivationAction
 
ComputedFolderActivationActionFactory - Class in io.jenkins.plugins.batchcontrol.action
Attaches ComputedFolderActivationAction to every computed folder (D-46c).
ComputedFolderActivationActionFactory() - Constructor for class io.jenkins.plugins.batchcontrol.action.ComputedFolderActivationActionFactory
 
CONFIG_CHANGE - Enum constant in enum class io.jenkins.plugins.batchcontrol.model.ChangeType
A save of the Batch Control configuration changed something besides the two switches (D-52).
CONFIG_CHANGE_TARGET - Static variable in class io.jenkins.plugins.batchcontrol.config.BatchControlGlobalConfiguration
The target of a ChangeType.CONFIG_CHANGE record (D-52).
CONFIG_TOGGLE - Enum constant in enum class io.jenkins.plugins.batchcontrol.model.ChangeType
 
ConfigSnapshotListener - Class in io.jenkins.plugins.batchcontrol.listener
Records CONFIGURE changes with a unified diff (SPEC item 9) and maintains the per-item config snapshots (snapshots/<encoded fullName>.xml, latest only — ARCHITECTURE section 5).
ConfigSnapshotListener() - Constructor for class io.jenkins.plugins.batchcontrol.listener.ConfigSnapshotListener
 
ConfigSnapshotListener.CreationAnnounced - Class in io.jenkins.plugins.batchcontrol.listener
Marks the item whose creation (or copy) is being announced on this thread (ConfigSnapshotListener.ANNOUNCED) before any other item listener runs, so ConfigSnapshotListener.isCreationSave(hudson.model.Item) can tell a save of the new item from a save of another item made by a listener of that announcement.
ConfigSnapshotListener.CreationAnnouncedEnd - Class in io.jenkins.plugins.batchcontrol.listener
Clears the mark of ConfigSnapshotListener.CreationAnnounced after every other item listener has run (core calls each listener whatever the previous ones threw).
ConfigSnapshotListener.Refresh - Class in io.jenkins.plugins.batchcontrol.listener
The refresh of every snapshot after change recording was turned on (SnapshotSeeding).
ConfigSnapshotListener.SaveStart - Class in io.jenkins.plugins.batchcontrol.listener
Marks the save of an item as being reported (ConfigSnapshotListener.SAVING) before any other save listener runs, so seeding never takes a baseline from a configuration whose save has not reached ConfigSnapshotListener yet.
ConfigSnapshotListener.Seeding - Enum Class in io.jenkins.plugins.batchcontrol.listener
configure(CNode, ConfigurationContext) - Method in class io.jenkins.plugins.batchcontrol.security.BatchControlMatrixCascConfigurator
 
configure(CNode, ConfigurationContext) - Method in class io.jenkins.plugins.batchcontrol.security.BatchControlRoleBasedCascConfigurator
 
configure(StaplerRequest2, JSONObject) - Method in class io.jenkins.plugins.batchcontrol.config.BatchControlGlobalConfiguration
 
CONFIGURE - Enum constant in enum class io.jenkins.plugins.batchcontrol.model.ChangeType
 
CONFIGURE - Enum constant in enum class io.jenkins.plugins.batchcontrol.model.GrantAction
 
ConfigureWithoutGrantMonitor - Class in io.jenkins.plugins.batchcontrol.ops
Warns administrators when change control cannot actually control changes (SPEC item 8): change control is on, but either the global authorization strategy is not a Batch Control strategy (so grants can never apply, D-35a), or some known non-admin user holds Item/Configure, Item/Create, Item/Delete or Item/Move (D-59) directly from the strategy — a standing change permission that bypasses the JIT grant process.
ConfigureWithoutGrantMonitor() - Constructor for class io.jenkins.plugins.batchcontrol.ops.ConfigureWithoutGrantMonitor
 
ConfigureWithoutGrantMonitor_DisplayName() - Static method in class io.jenkins.plugins.batchcontrol.Messages
Key ConfigureWithoutGrantMonitor.DisplayName: Batch Control: standing change permissions bypass change control.
ConfigureWithoutGrantMonitor.StandingHolder - Class in io.jenkins.plugins.batchcontrol.ops
One user or group that holds Item/Configure, Item/Create or Item/Delete from the authorization strategy itself, outside any grant (e2e-03 DEF-07).
consumeMarker(String, String) - Method in class io.jenkins.plugins.batchcontrol.policy.RunRequestService
Atomically claims the single consumption ticket of an approved request (D-23), including the D-20 check-at-submit expiry re-check.
contains(List<String>, String) - Static method in class io.jenkins.plugins.batchcontrol.model.Approvers
Whether userId is a member of ids under the user id strategy.
ConverterImpl() - Constructor for class io.jenkins.plugins.batchcontrol.security.BatchControlMatrixAuthorizationStrategy.ConverterImpl
 
ConverterImpl() - Constructor for class io.jenkins.plugins.batchcontrol.security.BatchControlRoleBasedAuthorizationStrategy.ConverterImpl
 
copyFor(String) - Method in class io.jenkins.plugins.batchcontrol.model.ActivationState
The same state under another full name (rename or move keeps the activation).
countPendingFor(Authentication) - Method in class io.jenkins.plugins.batchcontrol.policy.ActivationService
D-61: the PENDING activation and hold requests that concern auth, read from the open-request index only (no history scan): those awaiting their decision as a designated approver holding Jenkins-level BatchControl/Approve, else their own.
countPendingFor(Authentication) - Method in class io.jenkins.plugins.batchcontrol.policy.GrantRequestService
D-61: the PENDING grant requests that concern auth, read from the open-request index only (no history scan): those awaiting their decision as a designated approver holding Jenkins-level BatchControl/Approve, else their own.
countPendingFor(Authentication) - Method in class io.jenkins.plugins.batchcontrol.policy.RunRequestService
D-61: the PENDING run requests that concern auth, read from the open-request index only (no history scan): those awaiting their decision as a designated approver holding Jenkins-level BatchControl/Approve, else their own.
create() - Method in class io.jenkins.plugins.batchcontrol.security.BatchControlMatrixAuthorizationStrategy.DescriptorImpl
 
create(Item, ActivationRequest.Action, String, List<String>) - Method in class io.jenkins.plugins.batchcontrol.policy.ActivationService
Creates a PENDING activation or hold request for the job.
create(Job<?, ?>, ActivationRequest.Action, String, List<String>) - Method in class io.jenkins.plugins.batchcontrol.policy.ActivationService
create(Job<?, ?>, List<ParameterValue>, String, String) - Method in class io.jenkins.plugins.batchcontrol.policy.RunRequestService
Single-approver form of RunRequestService.create(Job, List, String, List, String), without an incident.
create(Job<?, ?>, List<ParameterValue>, String, List<String>, String) - Method in class io.jenkins.plugins.batchcontrol.policy.RunRequestService
Creates a PENDING run request holding the submitted typed values (D-72), linked to an incident when incidentId is given (SPEC item 11: the run listener links a successful rerun back to the incident).
create(Job<?, ?>, List<ParameterValue>, Map<String, Long>, String, List<String>, String) - Method in class io.jenkins.plugins.batchcontrol.policy.RunRequestService
As RunRequestService.create(Job, List, String, List, String) for a web submission: uploaded maps a parameter name to the size of the uploaded parts its value was created from (RequestBodyLimit.uploadedSize(org.kohsuke.stapler.StaplerRequest2, java.util.Collection<java.lang.String>)), which the kept-size check counts for a value whose own size cannot be read (D-74 (2)).
create(Job<?, ?>, Map<String, String>, String, String) - Method in class io.jenkins.plugins.batchcontrol.policy.RunRequestService
Creates a PENDING run request from string values, designating a single approver: each value becomes a typed value through the job's parameter definition (SimpleParameterDefinition.createValue(String)), or a StringParameterValue where the job defines no such simple parameter, and the request is created as by RunRequestService.create(Job, List, String, List, String).
create(ChangeType, String, String, String) - Static method in class io.jenkins.plugins.batchcontrol.model.ChangeRecord
Creates a record with a fresh id and the current BatchClock time.
create(GrantScope, ItemKind, List<GrantAction>, int, String, String, List<String>, String) - Static method in class io.jenkins.plugins.batchcontrol.model.GrantRequest
Creates a new PENDING grant request with a random UUID id (D-68) and its creation time from BatchClock, recording the kind of the scope item (D-71).
create(GrantScope, List<GrantAction>, int, String, String) - Method in class io.jenkins.plugins.batchcontrol.policy.GrantRequestService
Creates a PENDING grant request.
create(GrantScope, List<GrantAction>, int, String, String, String) - Static method in class io.jenkins.plugins.batchcontrol.model.GrantRequest
Single-approver form without a name restriction, kept for callers written before D-37.
create(GrantScope, List<GrantAction>, int, String, String, List<String>, String) - Static method in class io.jenkins.plugins.batchcontrol.model.GrantRequest
create(GrantScope, List<GrantAction>, int, String, List<String>) - Method in class io.jenkins.plugins.batchcontrol.policy.GrantRequestService
Approver-set form without a name restriction (D-37).
create(GrantScope, List<GrantAction>, int, String, List<String>, String) - Method in class io.jenkins.plugins.batchcontrol.policy.GrantRequestService
Creates a PENDING grant request designating an approver set (D-37) and, for CREATE, an optional name restriction (D-40): an exact item name or a /regex/ matched against the whole name of the new item.
create(String, ActivationRequest.Action, String, String, List<String>) - Static method in class io.jenkins.plugins.batchcontrol.model.ActivationRequest
Creates a new PENDING request with a fresh id and the BatchClock time.
create(String, Map<String, String>, String, String, String) - Static method in class io.jenkins.plugins.batchcontrol.model.RunRequest
create(String, Map<String, String>, String, String, List<String>) - Static method in class io.jenkins.plugins.batchcontrol.model.RunRequest
Creates a new PENDING request with a random UUID id (D-68) and its creation time from BatchClock, holding the masked display map parameters (D-72).
CREATE - Enum constant in enum class io.jenkins.plugins.batchcontrol.model.ChangeType
 
CREATE - Enum constant in enum class io.jenkins.plugins.batchcontrol.model.GrantAction
 
createAppliesTo(Item) - Static method in class io.jenkins.plugins.batchcontrol.model.GrantScope
D-71: whether a window's CREATE can apply to item: a modifiable item group that is neither a job nor a computed folder (a regular folder; not a multibranch project or an organization folder, whose children are created by indexing).
createdAt() - Method in record class io.jenkins.plugins.batchcontrol.store.IncidentSummary
Returns the value of the createdAt record component.
createdAt() - Method in record class io.jenkins.plugins.batchcontrol.store.RequestSummary
Returns the value of the createdAt record component.
createdAt(Incident) - Method in class io.jenkins.plugins.batchcontrol.action.IncidentsSection
Creation timestamp of an incident (Jelly helper for the list column).
CreatedItemGrantListener - Class in io.jenkins.plugins.batchcontrol.listener
D-35c: records in the grant an item that its holder could only create because of the grant's Create.
CreatedItemGrantListener() - Constructor for class io.jenkins.plugins.batchcontrol.listener.CreatedItemGrantListener
 
createFor(AbstractFolder) - Method in class io.jenkins.plugins.batchcontrol.action.FolderCreateWindowActionFactory
 
createFor(ComputedFolder) - Method in class io.jenkins.plugins.batchcontrol.action.ComputedFolderActivationActionFactory
 
createFor(Job) - Method in class io.jenkins.plugins.batchcontrol.action.JobNoticesWidget.FactoryImpl
 
createFor(Job) - Method in class io.jenkins.plugins.batchcontrol.action.JobRequestActionFactory
 
createFor(Run) - Method in class io.jenkins.plugins.batchcontrol.action.RunApprovalNoticeActionFactory
 
createFor(GrantRequest, Instant) - Static method in class io.jenkins.plugins.batchcontrol.model.Grant
Creates the grant for an approved request: the grantee is the requester, the window is [grantedAt, grantedAt + durationMinutes), and the id equals the request id.
createIncident(Incident) - Method in class io.jenkins.plugins.batchcontrol.store.FileStore
 
createIncident(Incident) - Method in interface io.jenkins.plugins.batchcontrol.store.Store
Persists a freshly opened incident: writes incidents/<id>.xml and appends the monthly index line (incidents/index/YYYY-MM.jsonl, bucket derived from the incident's creation time).
createNameLabel(GrantsSection.Row) - Method in class io.jenkins.plugins.batchcontrol.action.GrantsSection
The CREATE name restriction of a row in words (DEF-19): the pattern, "any name" for an unrestricted CREATE, empty when the row does not include CREATE.
CreateNamePattern - Class in io.jenkins.plugins.batchcontrol.model
The optional name restriction of a CREATE grant (D-40): either an exact item name, or a Java regular expression written as /regex/ that must match the whole item name.
CreationAnnounced() - Constructor for class io.jenkins.plugins.batchcontrol.listener.ConfigSnapshotListener.CreationAnnounced
 
CreationAnnouncedEnd() - Constructor for class io.jenkins.plugins.batchcontrol.listener.ConfigSnapshotListener.CreationAnnouncedEnd
 
csv(List<String>) - Static method in class io.jenkins.plugins.batchcontrol.model.Approvers
Members joined by ";", the CSV form of the approver column (D-37).
CsvWriter - Class in io.jenkins.plugins.batchcontrol.ui
Minimal CSV emitter for the audit export endpoints (SPEC item 12).
current() - Static method in class io.jenkins.plugins.batchcontrol.ui.FormErrors
The refusal attached to this request, whatever form it is for, or an empty one.
current() - Static method in class io.jenkins.plugins.batchcontrol.ui.SectionTabs
The tabs the current user may open (Jelly reaches it through BatchControlRootAction#getTabs).
current(String) - Static method in class io.jenkins.plugins.batchcontrol.ui.FormErrors
The refusal of form form on this request, or an empty one.
currentPage() - Static method in class io.jenkins.plugins.batchcontrol.ui.Paging
The 1-based page from the page query parameter; 1 on absence or garbage.
currentPage(String) - Static method in class io.jenkins.plugins.batchcontrol.ui.Paging
The 1-based page from the named query parameter; 1 on absence, garbage or a value below 1.
currentRefresh() - Static method in class io.jenkins.plugins.batchcontrol.listener.ConfigSnapshotListener
The refresh of the running Jenkins session that is still current, or null.

D

D-60: a refused parameterized build leads to the Request Run form - Search tag in exception class io.jenkins.plugins.batchcontrol.ui.ApprovalRequiredFailure
Section
DashboardSection - Class in io.jenkins.plugins.batchcontrol.action
The run record dashboard at /batch-control/dashboard/ (SPEC item 10): the most recent builds of every job with cause, user, parameters, result, duration, who aborted it, and — for APPROVED_REQUEST builds — a link to the originating run request.
DashboardSection() - Constructor for class io.jenkins.plugins.batchcontrol.action.DashboardSection
 
Dates - Class in io.jenkins.plugins.batchcontrol.ui
The plugin's only time-rendering vocabulary (U-07).
decidedAt() - Method in record class io.jenkins.plugins.batchcontrol.store.RequestSummary
Returns the value of the decidedAt record component.
decode(String) - Static method in class io.jenkins.plugins.batchcontrol.store.PathCodec
Decodes an encoded file-name segment back to the original job full name.
DEFAULT_MAX_BYTES - Static variable in class io.jenkins.plugins.batchcontrol.policy.RequestBodyLimit
Default cap: 100 MB.
DEFAULT_RANGE_DAYS - Static variable in class io.jenkins.plugins.batchcontrol.ui.FilterParser
Default range length in days (inclusive of today) when no dates are given.
DELETE - Enum constant in enum class io.jenkins.plugins.batchcontrol.model.ChangeType
 
DELETE - Enum constant in enum class io.jenkins.plugins.batchcontrol.model.GrantAction
 
deleteActivationState(String) - Method in class io.jenkins.plugins.batchcontrol.store.FileStore
 
deleteActivationState(String) - Method in interface io.jenkins.plugins.batchcontrol.store.Store
Removes the activation state of a job; true if one existed.
deleteAppliesTo(Item) - Static method in class io.jenkins.plugins.batchcontrol.model.GrantScope
D-71: whether a window's DELETE can apply to item: a Job only, including multi-configuration and Maven projects, whose sub-items are part of the job.
deleteClosedEntitiesBefore(Instant) - Method in class io.jenkins.plugins.batchcontrol.store.FileStore
 
deleteClosedEntitiesBefore(Instant) - Method in interface io.jenkins.plugins.batchcontrol.store.Store
Retention of the XML entities: deletes closed run requests (not PENDING or APPROVED) and closed grant requests (not PENDING) whose last activity lies before cutoff, and grants that stopped conferring anything (expiry or revocation) before it.
deleteConfigSnapshot(String) - Method in class io.jenkins.plugins.batchcontrol.store.FileStore
 
deleteConfigSnapshot(String) - Method in interface io.jenkins.plugins.batchcontrol.store.Store
Removes the config snapshot of a job (after deletion, rename or move).
deleteMonth(YearMonth) - Method in class io.jenkins.plugins.batchcontrol.store.FileStore
Deletes one month bucket file by file: every incident XML, patch and bucket file is deleted under its own lock stripe, and the lock is released before the next one, so no writer waits behind more than a single deletion.
deleteMonth(YearMonth) - Method in interface io.jenkins.plugins.batchcontrol.store.Store
Deletes every record bucket of the given month: the runs and changes JSONL files, the diff patches of that month's change records, the incident XMLs listed in that month's index and the index file itself.
deleteRunRequestValues(String) - Method in class io.jenkins.plugins.batchcontrol.store.FileStore
 
deleteRunRequestValues(String) - Method in interface io.jenkins.plugins.batchcontrol.store.Store
Deletes the typed values of request id (<id>.values.xml), when the approved run starts or the request ends (D-72b (5), D-74); nothing happens when there are none.
DeleteVetoListener - Class in io.jenkins.plugins.batchcontrol.listener
Delete veto (SPEC item 8, ARCHITECTURE section 2): with change control on, deleting an item requires an active DELETE grant — even when the underlying authorization strategy grants Item/Delete directly.
DeleteVetoListener() - Constructor for class io.jenkins.plugins.batchcontrol.listener.DeleteVetoListener
 
deletingUser(Item) - Static method in class io.jenkins.plugins.batchcontrol.security.DeletionAttribution
Who deleted item: the current user, or, when core deletes it as SYSTEM because a folder above it is being deleted on this thread, the user who started that folder's deletion.
DeletionAttribution - Class in io.jenkins.plugins.batchcontrol.security
Who deleted an item (SPEC 6: the history names who did what).
describe() - Method in class io.jenkins.plugins.batchcontrol.security.BatchControlMatrixCascConfigurator
 
describe() - Method in class io.jenkins.plugins.batchcontrol.security.BatchControlRoleBasedCascConfigurator
 
describe(BatchControlMatrixAuthorizationStrategy, ConfigurationContext) - Method in class io.jenkins.plugins.batchcontrol.security.BatchControlMatrixCascConfigurator
 
describe(BatchControlRoleBasedAuthorizationStrategy, ConfigurationContext) - Method in class io.jenkins.plugins.batchcontrol.security.BatchControlRoleBasedCascConfigurator
 
describe(CharSequence, int) - Static method in class io.jenkins.plugins.batchcontrol.store.XmlChars
The character at index of text as U+XXXX, for a refusal message.
describe(String) - Static method in class io.jenkins.plugins.batchcontrol.model.CreateNamePattern
Plain-text description of a stored restriction for an explanation to the holder (e2e-03 DEF-19), for example names matching the pattern /app-[0-9]+/ or the name 'app-2'.
DescriptorImpl() - Constructor for class io.jenkins.plugins.batchcontrol.config.BatchControlJobProperty.DescriptorImpl
 
DescriptorImpl() - Constructor for class io.jenkins.plugins.batchcontrol.security.BatchControlMatrixAuthorizationStrategy.DescriptorImpl
 
DescriptorImpl() - Constructor for class io.jenkins.plugins.batchcontrol.security.BatchControlRoleBasedAuthorizationStrategy.DescriptorImpl
 
DIALOG_VIEW - Static variable in class io.jenkins.plugins.batchcontrol.ui.Dialogs
View name of the dialog form of a screen.
Dialogs - Class in io.jenkins.plugins.batchcontrol.ui
D-66: request forms opened in core's dialog (data-type="dialog-opener" with data-dialog-url, the mechanism of core's "Create User" and build-parameters dialogs).
diff(String, String) - Static method in class io.jenkins.plugins.batchcontrol.store.UnifiedDiff
Computes the unified diff between two texts.
diffSummary(String) - Method in class io.jenkins.plugins.batchcontrol.action.ChangesSection
Jelly helper: +12 / -3 lines for a record's diff, shown next to the disclosure control so the size of a configuration change is readable without opening it (U-07).
DiffSummary - Class in io.jenkins.plugins.batchcontrol.ui
One-line size summary of a stored unified diff, for the change-records screen (U-07).
display(List<String>) - Static method in class io.jenkins.plugins.batchcontrol.model.Approvers
Members joined by ", " for display; empty string for an empty set.
displayable(String) - Static method in class io.jenkins.plugins.batchcontrol.ui.FormErrors
D-72b: text with each character XML 1.0 cannot hold (U+0000, a lone surrogate, ...) replaced by U+FFFD, as a browser shows it.
dispose(List<? extends ParameterValue>, String) - Static method in class io.jenkins.plugins.batchcontrol.policy.ParameterFiles
Disposes of the temporary files held by values, which must never be (or have been) handed to the queue.
disposeCancelled(Queue.LeftItem) - Static method in class io.jenkins.plugins.batchcontrol.store.FileParametersSupport
Hands the cancelled queue item cancelled to the plugin's own listener for cancelled items, StashedFileParameterValue.CancelledQueueListener.
doAcknowledge(StaplerRequest2, StaplerResponse2, String) - Method in class io.jenkins.plugins.batchcontrol.action.IncidentItem
POST acknowledge?comment=... — OPEN → ACKNOWLEDGED.
doApprove(StaplerRequest2, StaplerResponse2, String) - Method in class io.jenkins.plugins.batchcontrol.action.ActivationItem
POST approve with an optional comment.
doApprove(StaplerRequest2, StaplerResponse2, String) - Method in class io.jenkins.plugins.batchcontrol.action.GrantRequestItem
POST approve?comment=... — approver decision (comment optional).
doApprove(StaplerRequest2, StaplerResponse2, String) - Method in class io.jenkins.plugins.batchcontrol.action.RequestItem
POST approve?comment=... — approver decision (comment optional).
doCancel(StaplerRequest2, StaplerResponse2) - Method in class io.jenkins.plugins.batchcontrol.action.ActivationItem
POST cancel; Request on the request's item (D-38b) or Manage, and the service enforces requester-or-Manage.
doCancel(StaplerRequest2, StaplerResponse2) - Method in class io.jenkins.plugins.batchcontrol.action.GrantRequestItem
POST cancel — authenticated users only; service enforces requester-or-Manage.
doCancel(StaplerRequest2, StaplerResponse2) - Method in class io.jenkins.plugins.batchcontrol.action.RequestItem
POST cancel — authenticated users only; service enforces requester-or-Manage.
doChangeApprover(StaplerRequest2, StaplerResponse2) - Method in class io.jenkins.plugins.batchcontrol.action.ActivationItem
POST changeApprover with the repeated approvers field (D-26, D-37).
doChangeApprover(StaplerRequest2, StaplerResponse2) - Method in class io.jenkins.plugins.batchcontrol.action.GrantRequestItem
POST changeApprover with the repeated approvers field — replaces the designated set of a PENDING grant request (D-26, D-37).
doChangeApprover(StaplerRequest2, StaplerResponse2) - Method in class io.jenkins.plugins.batchcontrol.action.RequestItem
POST changeApprover with the repeated approvers field — replaces the designated set (D-26, D-37); the service enforces requester-only, PENDING and eligibility.
doCheckApprovedRunTimeoutMinutes(String) - Method in class io.jenkins.plugins.batchcontrol.config.BatchControlGlobalConfiguration
Stapler form validation (read-only).
doCheckApproversText(String) - Method in class io.jenkins.plugins.batchcontrol.config.BatchControlGlobalConfiguration
Stapler form validation of the approver list (read-only, D-53).
doCheckGrantDurationOptions(String, String) - Method in class io.jenkins.plugins.batchcontrol.config.BatchControlGlobalConfiguration
Stapler form validation of the field named by its SPEC key (read-only).
doCheckGrantDurationOptionsText(String, String) - Method in class io.jenkins.plugins.batchcontrol.config.BatchControlGlobalConfiguration
Stapler form validation (read-only); re-run when the maximum changes.
doCheckIncidentResults(String) - Method in class io.jenkins.plugins.batchcontrol.config.BatchControlGlobalConfiguration
Stapler form validation of the field named by its SPEC key (read-only).
doCheckIncidentResultsText(String) - Method in class io.jenkins.plugins.batchcontrol.config.BatchControlGlobalConfiguration
Stapler form validation (read-only).
doCheckMaxGrantMinutes(String) - Method in class io.jenkins.plugins.batchcontrol.config.BatchControlGlobalConfiguration
Stapler form validation (read-only).
doCheckNotifyBeforeExpiryMinutes(String) - Method in class io.jenkins.plugins.batchcontrol.config.BatchControlGlobalConfiguration
Stapler form validation (read-only).
doCheckPattern(String) - Method in class io.jenkins.plugins.batchcontrol.security.BatchControlRoleBasedAuthorizationStrategy.DescriptorImpl
Manage Roles (role-strategy 927 manage-roles.jelly): validates a role pattern.
doCheckPendingTimeoutHours(String) - Method in class io.jenkins.plugins.batchcontrol.config.BatchControlGlobalConfiguration
Stapler form validation (read-only).
doCheckRetentionMonths(String) - Method in class io.jenkins.plugins.batchcontrol.config.BatchControlGlobalConfiguration
Stapler form validation (read-only).
doCheckScopeFullName(String) - Method in class io.jenkins.plugins.batchcontrol.action.GrantsSection
POST /batch-control/grants/checkScopeFullName — the request form's check of the item name (D-71): the kind of the job or folder the window would name, for example Pipeline 'team/nightly', so the requester sees what they are asking for before submitting.
doCheckSidName(String, String) - Method in class io.jenkins.plugins.batchcontrol.security.BatchControlRoleBasedAuthorizationStrategy.DescriptorImpl
Assign Roles (role-strategy 927 index.jelly): resolves the sid typed in the add dialog as a user or group (type USER or GROUP).
doComment(StaplerRequest2, StaplerResponse2, String) - Method in class io.jenkins.plugins.batchcontrol.action.IncidentItem
POST comment?comment=... — adds a comment without a status change.
doConfigSubmit(StaplerRequest2, StaplerResponse2) - Method in class io.jenkins.plugins.batchcontrol.config.BatchControlConfigurationLink
POST configSubmit: saves the form.
doContextMenu(StaplerRequest2, StaplerResponse2) - Method in class io.jenkins.plugins.batchcontrol.action.BatchControlRootAction
The breadcrumb dropdown: the same tabs, in the same order and with the same badges, as the tab bar (SectionTabs.current(), permission-filtered by SectionAccess), plus the configuration page for a BatchControl/Manage holder.
doCreate(StaplerRequest2, StaplerResponse2) - Method in class io.jenkins.plugins.batchcontrol.action.GrantsSection
POST /batch-control/grants/create — submits a new grant request.
doDynamic(StaplerRequest2, StaplerResponse2) - Method in class io.jenkins.plugins.batchcontrol.action.HistorySection
Serves the four CSV export URLs (runs.csv, incidents.csv, changes.csv, requests.csv); anything else under this section is a 404.
doFilter(ServletRequest, ServletResponse, FilterChain) - Method in class io.jenkins.plugins.batchcontrol.listener.SelfGrantRevertFilter
 
doMarkReviewed() - Method in class io.jenkins.plugins.batchcontrol.action.JobRequestAction
POST markReviewed (D-58b (3)): the deliberate review of this job after changes made under a permission window.
doMarkReviewed(String) - Method in class io.jenkins.plugins.batchcontrol.ops.BatchControlStrategyMonitor
D-58b (3): "Mark as reviewed" for one listed item.
doMigrate() - Method in class io.jenkins.plugins.batchcontrol.ops.BatchControlStrategyMonitor
Installs the Batch Control subclass of the current plain matrix-auth (project or global) or role-strategy strategy with every entry kept, and saves.
doReject(StaplerRequest2, StaplerResponse2, String) - Method in class io.jenkins.plugins.batchcontrol.action.ActivationItem
POST reject with a comment (the service refuses an empty one).
doReject(StaplerRequest2, StaplerResponse2, String) - Method in class io.jenkins.plugins.batchcontrol.action.GrantRequestItem
POST reject?comment=... — approver decision (service enforces non-empty comment).
doReject(StaplerRequest2, StaplerResponse2, String) - Method in class io.jenkins.plugins.batchcontrol.action.RequestItem
POST reject?comment=... — approver decision (service enforces non-empty comment).
doRerun(StaplerRequest2, StaplerResponse2) - Method in class io.jenkins.plugins.batchcontrol.action.IncidentItem
POST rerun with the repeated approvers field (the single approver field the rerun form posts is read too) — creates a rerun RunRequest carrying the failed run's own parameter values and linked back to this incident, then redirects to the new request's detail page.
doResolve(StaplerRequest2, StaplerResponse2, String) - Method in class io.jenkins.plugins.batchcontrol.action.IncidentItem
POST resolve?comment=... — ACKNOWLEDGED → RESOLVED.
doRevert() - Method in class io.jenkins.plugins.batchcontrol.ops.BatchControlStrategyMonitor
Installs the plain parent strategy of the current Batch Control strategy with every entry kept, and saves (the uninstall path).
doRevoke(StaplerRequest2, StaplerResponse2) - Method in class io.jenkins.plugins.batchcontrol.action.ActiveGrantsSection.Item
POST /batch-control/grants/active/<grantId>/revoke — immediately revokes the grant.
doRevoke(StaplerRequest2, StaplerResponse2) - Method in class io.jenkins.plugins.batchcontrol.action.GrantRequestItem
POST revoke — R4-12: revokes this request's open window from its own page, with the permission rule of the Grants list's Revoke (BatchControl/Manage, SPEC item 8).
doRun() - Method in class io.jenkins.plugins.batchcontrol.ops.ExpiryPeriodicWork
 
doRun() - Method in class io.jenkins.plugins.batchcontrol.ops.RetentionPeriodicWork
 
doSubmit(StaplerRequest2, StaplerResponse2) - Method in class io.jenkins.plugins.batchcontrol.action.JobActivationForm
POST submit with action (ACTIVATE|HOLD), reason and the repeated approvers field; redirects to the request at /batch-control/activations/<id>/.
doSubmit(StaplerRequest2, StaplerResponse2) - Method in class io.jenkins.plugins.batchcontrol.action.JobRequestAction
POST submit — creates the run request and redirects to its detail page at /batch-control/requests/<id>/.
doSummary(StaplerRequest2, StaplerResponse2, String) - Method in class io.jenkins.plugins.batchcontrol.action.HistorySection
GET summary?month=YYYY-MM — the monthly aggregate as JSON (T-12-04).
DurableFiles - Class in io.jenkins.plugins.batchcontrol.store
#34: the forced writes every store write goes through, as core's AtomicFileWriter does them.
duration(long) - Method in class io.jenkins.plugins.batchcontrol.action.DashboardSection
Human-readable duration.
duration(long) - Method in class io.jenkins.plugins.batchcontrol.action.HistorySection
Human-readable duration.

E

encode(String) - Static method in class io.jenkins.plugins.batchcontrol.store.PathCodec
Encodes a job full name into a safe, deterministic, collision-free file-name segment.
endedAt(GrantsSection.Row) - Method in class io.jenkins.plugins.batchcontrol.action.GrantsSection
When a row ended: its window's end, else the request's decision (or creation).
endedAt(Grant) - Method in class io.jenkins.plugins.batchcontrol.action.GrantsSection
When a grant ended: its revocation time, else its expiry.
endedLabel(ActivationRequest) - Method in class io.jenkins.plugins.batchcontrol.action.ActivationsSection
How an ended request ended, in words: a superseded approval says so.
endedLabel(Grant) - Static method in class io.jenkins.plugins.batchcontrol.action.GrantRequestItem
How a window ended, in words: "Expired", "Revoked by admin", or for a revocation by the change control switch "Revoked (change control turned off) by admin".
endedLabel(Grant) - Method in class io.jenkins.plugins.batchcontrol.action.GrantsSection
How a grant ended, in words: "Expired", "Revoked by admin", or for a revocation by the change control switch "Revoked (change control turned off) by admin".
endedLabelOf(Grant) - Method in class io.jenkins.plugins.batchcontrol.action.GrantRequestItem
EndReasons - Class in io.jenkins.plugins.batchcontrol.policy
The reason texts of requests that end without a decision (e2e-04 FD-05, D-54).
endRefresh(ConfigSnapshotListener.Refresh) - Static method in class io.jenkins.plugins.batchcontrol.listener.ConfigSnapshotListener
Drops refresh if it is still the current one, because recording was switched off: the next switch-on starts a new one.
endWindowsOf(Item, String) - Method in class io.jenkins.plugins.batchcontrol.security.GrantService
D-74: the item fullName was deleted; every active window naming it, or an item below it, ends: it is revoked by user, with Grant.REVOKED_ITEM_DELETED as the reason and a GRANT_REVOKE record, so it keeps its history.
endWindowsOfMissingItems(Predicate<String>) - Method in class io.jenkins.plugins.batchcontrol.security.GrantService
D-74: after all items are loaded at startup, ends every active window whose item no longer exists (exists is false for its full name): it was deleted while Jenkins was down, or Jenkins stopped between deleting it and handling the deletion.
endWindowsOnNewItem(Item) - Method in class io.jenkins.plugins.batchcontrol.security.GrantService
D-74: a new item was created (or copied) under fullName.
ensure(File) - Static method in class io.jenkins.plugins.batchcontrol.security.ItemIdentity
The identity of rootDir, writing a marker with a new random id first when there is no readable one (a missing or malformed marker is replaced).
equals(Object) - Method in class io.jenkins.plugins.batchcontrol.model.GrantScope
 
equals(Object) - Method in class io.jenkins.plugins.batchcontrol.model.ItemKind
 
equals(Object) - Method in class io.jenkins.plugins.batchcontrol.model.PendingCount
 
equals(Object) - Method in class io.jenkins.plugins.batchcontrol.queue.ApprovedCause
 
equals(Object) - Method in record class io.jenkins.plugins.batchcontrol.store.IncidentSummary
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.jenkins.plugins.batchcontrol.store.Period
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.jenkins.plugins.batchcontrol.store.RequestSummary
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.jenkins.plugins.batchcontrol.store.RetentionResult
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.jenkins.plugins.batchcontrol.store.RunMonthStats
Indicates whether some other object is "equal to" this one.
exceeds(HttpServletRequest) - Static method in class io.jenkins.plugins.batchcontrol.policy.RequestBodyLimit
Stage 1: whether the declared Content-Length of the run request submission req is over the cap, from the header alone, for any content type; nothing of the body is read.
EXECUTED - Enum constant in enum class io.jenkins.plugins.batchcontrol.model.RequestStatus
 
EXPIRED - Enum constant in enum class io.jenkins.plugins.batchcontrol.model.RequestStatus
 
EXPIRED - Enum constant in enum class io.jenkins.plugins.batchcontrol.ops.NotificationEvent
A request expired (D-54): pending past its timeout, or approved but not started in time.
expireOverdue(Set<String>, Instant) - Method in class io.jenkins.plugins.batchcontrol.policy.RunRequestService
Expires overdue requests: PENDING past pendingTimeoutHours and APPROVED, never-executed requests past approvedRunTimeoutMinutes whose submission is not sitting in the queue right now.
expireOverduePending() - Method in class io.jenkins.plugins.batchcontrol.policy.ActivationService
Expires PENDING requests past pendingTimeoutHours, the run-request timeout.
expireOverduePending() - Method in class io.jenkins.plugins.batchcontrol.policy.GrantRequestService
Expires PENDING grant requests past pendingTimeoutHours.
EXPIRING - Enum constant in enum class io.jenkins.plugins.batchcontrol.ops.NotificationEvent
A pending run or change request reaches its pending timeout soon.
ExpiryPeriodicWork - Class in io.jenkins.plugins.batchcontrol.ops
Periodic status refresh for expiry (SPEC items 7 and 8).
ExpiryPeriodicWork() - Constructor for class io.jenkins.plugins.batchcontrol.ops.ExpiryPeriodicWork
 

F

FactoryImpl() - Constructor for class io.jenkins.plugins.batchcontrol.action.JobNoticesWidget.FactoryImpl
 
FAILED - Enum constant in enum class io.jenkins.plugins.batchcontrol.listener.ConfigSnapshotListener.Seeding
The configuration could not be read or the snapshot could not be written.
failure() - Method in record class io.jenkins.plugins.batchcontrol.store.RunMonthStats
Returns the value of the failure record component.
field(String, String) - Method in class io.jenkins.plugins.batchcontrol.ui.FormErrors
Adds a message shown next to field; the first message for a field wins.
FIELD - Static variable in class io.jenkins.plugins.batchcontrol.ui.ApproverInput
Field name of the repeated approver field.
FILE_PREFIX - Static variable in class io.jenkins.plugins.batchcontrol.store.ParameterDisplay
Display prefix of a file value (D-72).
fileName(ParameterValue) - Static method in class io.jenkins.plugins.batchcontrol.store.FileParametersSupport
The original file name of one of the plugin's file values, as AbstractFileParameterValue#getFilename() returns it; null for any other value.
FileParametersSupport - Class in io.jenkins.plugins.batchcontrol.store
The only place where Batch Control uses the optional file-parameters plugin (stashedFile, base64File).
FileStore - Class in io.jenkins.plugins.batchcontrol.store
File-based Store rooted at $JENKINS_HOME/batch-control/.
FilterParser - Class in io.jenkins.plugins.batchcontrol.ui
Parses and validates the history filter query parameters (SPEC item 12): from, to (ISO dates, inclusive), job (case-insensitive substring of the full name), user (exact id), result and status (enum-name tokens).
FilterParser.Filter - Class in io.jenkins.plugins.batchcontrol.ui
The validated filter.
find(String) - Method in class io.jenkins.plugins.batchcontrol.security.GrantService
The grant id as the permission checks see it (see GrantService.listAll()), or null.
find(String, String, Function<String, T>, Function<? super T, String>, Predicate<? super T>) - Static method in class io.jenkins.plugins.batchcontrol.ui.RecordLookup
The record id names if the current user may see it, else null (rendered as 404), whatever the reason.
findActiveCreateGrant(String, ItemGroup<?>, String) - Method in class io.jenkins.plugins.batchcontrol.security.GrantService
D-40: the first active Create grant of user on the item group group (named exactly) whose name restriction (if any) allows itemName, or null.
findActiveDeleteGrant(String, Item) - Method in class io.jenkins.plugins.batchcontrol.security.GrantService
D-71: the active DELETE window of user on item, or null.
findActiveDeleteGrant(String, Item, String) - Method in class io.jenkins.plugins.batchcontrol.security.GrantService
As GrantService.findActiveDeleteGrant(String, Item) for the item under the name itemFullName (its name before a move, for example).
findActiveGrant(String, Item, GrantAction) - Method in class io.jenkins.plugins.batchcontrol.security.GrantService
The first active grant of user naming exactly item's full name and including action (null: any action), or null.
findActiveGrant(String, String, Item, GrantAction) - Method in class io.jenkins.plugins.batchcontrol.security.GrantService
As GrantService.findActiveGrant(String, Item, GrantAction) for a window naming itemFullName rather than the item's current full name: its name before a rename or move, whose window was the one in use (change records; item events update the window's name only after those are written, WindowItemListener).
findActiveGrant(String, String, GrantAction) - Method in class io.jenkins.plugins.batchcontrol.security.GrantService
The first active grant of user whose scope is the item itemFullName (an item the caller can see must be at that name) and that includes action, or null.
findActiveGrants(String, Item, GrantAction) - Method in class io.jenkins.plugins.batchcontrol.security.GrantService
Every active grant of user naming exactly item's full name and including action (D-40: the CREATE check has to see all of them, since each may carry a different name restriction).
findConfigureGrant(String, Item) - Method in class io.jenkins.plugins.batchcontrol.security.GrantService
The active grant that gives user Item/Configure on item: a grant with the CONFIGURE action naming the item, or a Create grant through which the user created it (D-35c).
findCreatingGrant(String, Item) - Method in class io.jenkins.plugins.batchcontrol.security.GrantService
D-35c: the active grant of user through whose Create item was created, or null.
findCreatingGrant(String, String, Item) - Method in class io.jenkins.plugins.batchcontrol.security.GrantService
As GrantService.findCreatingGrant(String, Item) for the record under the name itemFullName (its name before a rename, whose record was the one in use); the parent is item's.
findScopeItem(String) - Static method in class io.jenkins.plugins.batchcontrol.policy.GrantRequestService
D-71: the item a window would name, as the current user sees it, or null when no item exists at fullName or the user may not read it (an item visible only through Item/Discover counts as not visible).
findVisibleItem(String) - Static method in class io.jenkins.plugins.batchcontrol.ui.Visibility
The Item form of Visibility.findVisibleJob(java.lang.String), for call sites that accept folders too.
findVisibleJob(String) - Static method in class io.jenkins.plugins.batchcontrol.ui.Visibility
Resolves a job by full name for display purposes, treating "the caller may not see it" exactly like "it does not exist" (S-16).
finishCopiesOfCurrentThread() - Static method in class io.jenkins.plugins.batchcontrol.listener.GrantViolationGuard.Baseline
Finishes the watched copies of the current thread that did not complete: called when the HTTP request that made them ends (SelfGrantRevertFilter).
finishStaleCopies() - Static method in class io.jenkins.plugins.batchcontrol.listener.GrantViolationGuard.Baseline
Finishes the watched copies of other paths (a script, the CLI over WebSocket) that did not complete: those whose thread has ended or that started more than GrantViolationGuard.Baseline.STALE_COPY ago.
firstInvalid(CharSequence) - Static method in class io.jenkins.plugins.batchcontrol.store.XmlChars
The index of the first character of text that XML 1.0 cannot store, or -1 when there is none (null has none).
flushAtShutdown() - Static method in class io.jenkins.plugins.batchcontrol.store.BlockedAttemptAudit
S-22-03: writes the closing count record of every open summary before Jenkins stops, so no summary is left promising a count that never follows.
flushPersonSummaries() - Method in class io.jenkins.plugins.batchcontrol.store.BlockedAttemptAudit
The per-minute work (S-22-03, S-22-04): collects, under this object's lock, the closing count records of every summary whose window has ended and removes idle budgets, then appends the records outside the lock, so a queue thread refusing something meanwhile never waits behind these appends.
flushUnsavedEnds() - Method in class io.jenkins.plugins.batchcontrol.security.GrantService
D-74: writes the ends (and, S-39-02, the created-item records, and, D-75 (2), the changed-item lists) that could not be written so far (called by the periodic work; every grant write and every item event does the same first).
FolderCreateWindowAction - Class in io.jenkins.plugins.batchcontrol.action
e2e-03 DEF-19 (SPEC item 8, D-40): the folder page tells the holder of a Create window which new job names the window allows.
FolderCreateWindowAction(AbstractFolder<?>) - Constructor for class io.jenkins.plugins.batchcontrol.action.FolderCreateWindowAction
 
FolderCreateWindowActionFactory - Class in io.jenkins.plugins.batchcontrol.action
Attaches FolderCreateWindowAction (e2e-03 DEF-19) and FolderGrantRequestAction (R4-14) to every folder.
FolderCreateWindowActionFactory() - Constructor for class io.jenkins.plugins.batchcontrol.action.FolderCreateWindowActionFactory
 
FolderGrantRequestAction - Class in io.jenkins.plugins.batchcontrol.action
R4-14 (D-66): the folder counterpart of JobGrantRequestAction, a "Request Change Permission" entry on a folder that opens the grant request form prefilled for the folder (scopeFullName=<folder>).
FolderGrantRequestAction(AbstractFolder<?>) - Constructor for class io.jenkins.plugins.batchcontrol.action.FolderGrantRequestAction
 
followItem(Item, String, String) - Method in class io.jenkins.plugins.batchcontrol.security.GrantService
D-74: the item moved was renamed or moved from oldFullName to newFullName; every active window naming exactly oldFullName now names newFullName.
followItem(String) - Method in class io.jenkins.plugins.batchcontrol.model.Grant
D-74: the window follows its item, renamed or moved to newFullName.
forceDirectory(Path) - Static method in class io.jenkins.plugins.batchcontrol.store.DurableFiles
Forces the directory entries of dir (a rename into it, a file created in it) to disk.
forgetChanged(String) - Method in class io.jenkins.plugins.batchcontrol.security.GrantService
D-58a: a deleted item (and what was below it) leaves the "changed under a grant" state.
forgetCreatedItem(String) - Method in class io.jenkins.plugins.batchcontrol.security.GrantService
D-35c: an item recorded as created through an active grant was deleted.
forgetDeleted(Collection<String>) - Method in class io.jenkins.plugins.batchcontrol.security.GrantService
Drops grants that retention has deleted from the store.
forgetStaleCreatedItem(Item) - Method in class io.jenkins.plugins.batchcontrol.security.GrantService
D-35c, D-74: a new item was created under fullName; a created-item record under that name belongs to an item that disappeared without a deletion event (deleted on disk and reloaded) and is dropped, so it never applies to the new item.
forJob(Job<?, ?>) - Static method in class io.jenkins.plugins.batchcontrol.ui.ApproverOptions
 
format(Instant) - Method in class io.jenkins.plugins.batchcontrol.action.ActivationItem
Jelly helper: human-readable timestamp.
format(Instant) - Method in class io.jenkins.plugins.batchcontrol.action.ActivationsSection
Jelly helper: human-readable timestamp.
format(Instant) - Method in class io.jenkins.plugins.batchcontrol.action.ChangesSection
Jelly helper: human-readable timestamp.
format(Instant) - Method in class io.jenkins.plugins.batchcontrol.action.DashboardSection
Human-readable timestamp.
format(Instant) - Method in class io.jenkins.plugins.batchcontrol.action.FolderCreateWindowAction
 
format(Instant) - Method in class io.jenkins.plugins.batchcontrol.action.GrantRequestItem
Jelly helper: human-readable timestamp.
format(Instant) - Method in class io.jenkins.plugins.batchcontrol.action.HistorySection
Human-readable timestamp.
format(Instant) - Method in class io.jenkins.plugins.batchcontrol.action.IncidentItem
Jelly helper: human-readable timestamp.
format(Instant) - Method in class io.jenkins.plugins.batchcontrol.action.IncidentsSection
Human-readable timestamp.
format(Instant) - Method in class io.jenkins.plugins.batchcontrol.action.JobActivationForm
Jelly helper: human-readable timestamp.
format(Instant) - Method in class io.jenkins.plugins.batchcontrol.action.RequestItem
Jelly helper: human-readable timestamp.
format(Instant) - Method in class io.jenkins.plugins.batchcontrol.action.RequestsSection
Jelly helper: human-readable timestamp.
format(Instant) - Static method in class io.jenkins.plugins.batchcontrol.ui.Dates
 
formatDuration(long) - Static method in class io.jenkins.plugins.batchcontrol.ui.RunLinks
Human-readable duration (3 min 20 sec); empty for non-positive values.
formatParameters(Map<String, String>) - Static method in class io.jenkins.plugins.batchcontrol.ui.RunLinks
One-line name=value rendering of a parameter map for table cells and CSV.
formatParts(Instant) - Method in class io.jenkins.plugins.batchcontrol.action.GrantsSection
e2e-09 DEF-01: a timestamp as its date and its time-with-zone, for the grant tables, which render each part unbroken so that a narrow window breaks a cell only between them (never inside a date) and the page does not scroll sideways at 1280 px.
formErrors(String) - Method in class io.jenkins.plugins.batchcontrol.action.ActivationItem
The refusal of form form on this request, or an empty one (DEF-09, Jelly).
formErrors(String) - Method in class io.jenkins.plugins.batchcontrol.action.GrantRequestItem
The refusal of form form on this request, or an empty one (DEF-09, Jelly).
formErrors(String) - Method in class io.jenkins.plugins.batchcontrol.action.IncidentItem
The refusal of form form on this request, or an empty one (DEF-09, Jelly).
formErrors(String) - Method in class io.jenkins.plugins.batchcontrol.action.RequestItem
The refusal of form form on this request, or an empty one (DEF-09, Jelly).
FormErrors - Class in io.jenkins.plugins.batchcontrol.ui
The refusal of a submitted form, rendered on the form itself (SPEC section 6 usability line, e2e-03 DEF-09): the message sits next to the field it is about and what the user typed is kept.
FormErrors(String) - Constructor for class io.jenkins.plugins.batchcontrol.ui.FormErrors
 
forStored(String) - Static method in class io.jenkins.plugins.batchcontrol.model.CreateNamePattern
Compiles a stored restriction for matching; a stored value that no longer parses matches nothing (fail-safe), represented by a pattern that never matches.
from() - Method in record class io.jenkins.plugins.batchcontrol.store.Period
Returns the value of the from record component.
FROM_RERUN - Static variable in class io.jenkins.plugins.batchcontrol.ui.RequestRunPrefill
D-72: query parameter naming the incident whose rerun continues on the Request Run form because a value of the failed run could not be recovered.
fromDialog(StaplerRequest2) - Static method in class io.jenkins.plugins.batchcontrol.ui.Dialogs
Whether req was submitted from a dialog form.
fromDialogQuery(HttpServletRequest) - Static method in class io.jenkins.plugins.batchcontrol.ui.Dialogs
Whether the query string of req (never its body) marks a dialog submission (dialog=true).
fromInstant() - Method in class io.jenkins.plugins.batchcontrol.ui.FilterParser.Filter
Start of the range (inclusive), in the controller zone.
fromPermission(Permission) - Static method in enum class io.jenkins.plugins.batchcontrol.model.GrantAction
The action corresponding to a Jenkins permission, or null when the permission is not one of the three grantable item permissions (the grant machinery must never touch any other permission).
fromService(String, String...) - Method in class io.jenkins.plugins.batchcontrol.ui.FormErrors
Files a service refusal next to the field its text is about, or above the form when no keyword matches.
fromServiceStartingWith(String, String...) - Method in class io.jenkins.plugins.batchcontrol.ui.FormErrors
As FormErrors.fromService(java.lang.String, java.lang.String...), but a keyword counts only at the start of the message (case-insensitive).

G

generateResponse(StaplerRequest2, StaplerResponse2, Object) - Method in exception class io.jenkins.plugins.batchcontrol.security.MoveRefusal
 
generateResponse(StaplerRequest2, StaplerResponse2, Object) - Method in exception class io.jenkins.plugins.batchcontrol.ui.ApprovalRequiredFailure
 
generateResponse(StaplerRequest2, StaplerResponse2, Object) - Method in exception class io.jenkins.plugins.batchcontrol.ui.GrantRequiredFailure
 
generateResponse(StaplerRequest2, StaplerResponse2, Object) - Method in exception class io.jenkins.plugins.batchcontrol.ui.SelfGrantRevertedFailure
 
generateResponse(StaplerRequest2, StaplerResponse2, Object, Throwable) - Method in exception class io.jenkins.plugins.batchcontrol.security.MoveRefusal
 
generateResponse(StaplerRequest2, StaplerResponse2, Object, Throwable) - Method in exception class io.jenkins.plugins.batchcontrol.ui.ApprovalRequiredFailure
 
generateResponse(StaplerRequest2, StaplerResponse2, Object, Throwable) - Method in exception class io.jenkins.plugins.batchcontrol.ui.GrantRequiredFailure
 
generateResponse(StaplerRequest2, StaplerResponse2, Object, Throwable) - Method in exception class io.jenkins.plugins.batchcontrol.ui.SelfGrantRevertedFailure
 
get() - Static method in class io.jenkins.plugins.batchcontrol.config.BatchControlGlobalConfiguration
 
get() - Static method in class io.jenkins.plugins.batchcontrol.ops.IncidentService
 
get() - Static method in class io.jenkins.plugins.batchcontrol.policy.ActivationService
 
get() - Static method in class io.jenkins.plugins.batchcontrol.policy.GrantRequestService
 
get() - Static method in class io.jenkins.plugins.batchcontrol.policy.RunRequestService
 
get() - Static method in class io.jenkins.plugins.batchcontrol.security.GrantService
 
get() - Static method in class io.jenkins.plugins.batchcontrol.store.BlockedAttemptAudit
 
get() - Static method in class io.jenkins.plugins.batchcontrol.store.FileStore
The file store instance.
get() - Static method in interface io.jenkins.plugins.batchcontrol.store.Store
The store every caller uses (D-44).
get(String) - Method in class io.jenkins.plugins.batchcontrol.ui.FormErrors
The message next to field, or null.
getAbortedBy() - Method in class io.jenkins.plugins.batchcontrol.model.RunRecord
 
getACL(AbstractItem) - Method in class io.jenkins.plugins.batchcontrol.security.BatchControlMatrixAuthorizationStrategy
 
getACL(AbstractItem) - Method in class io.jenkins.plugins.batchcontrol.security.BatchControlRoleBasedAuthorizationStrategy
 
getACL(Computer) - Method in class io.jenkins.plugins.batchcontrol.security.BatchControlRoleBasedAuthorizationStrategy
 
getACL(Job<?, ?>) - Method in class io.jenkins.plugins.batchcontrol.security.BatchControlMatrixAuthorizationStrategy
 
getACL(Job<?, ?>) - Method in class io.jenkins.plugins.batchcontrol.security.BatchControlRoleBasedAuthorizationStrategy
 
getACL(Node) - Method in class io.jenkins.plugins.batchcontrol.security.BatchControlMatrixAuthorizationStrategy
 
getACL(Node) - Method in class io.jenkins.plugins.batchcontrol.security.BatchControlRoleBasedAuthorizationStrategy
 
getAction() - Method in class io.jenkins.plugins.batchcontrol.model.ActivationRequest
 
getAction() - Method in class io.jenkins.plugins.batchcontrol.ops.Notification
ACTIVATE or HOLD for an activation request; null for other kinds.
getActionLabel() - Method in class io.jenkins.plugins.batchcontrol.action.ActivationItem
S-13-08: ACTIVATE and HOLD worded so they cannot be mistaken for each other.
getActionLabel() - Method in exception class io.jenkins.plugins.batchcontrol.ui.GrantRequiredFailure
"Delete", "Configure" or "Create", for the page.
getActions() - Method in class io.jenkins.plugins.batchcontrol.action.GrantsSection.Row
 
getActions() - Method in class io.jenkins.plugins.batchcontrol.model.Grant
A defensive copy; the granted actions never change after creation.
getActions() - Method in class io.jenkins.plugins.batchcontrol.model.GrantRequest
A defensive copy; the requested actions never change after creation.
getActivatedAt() - Method in class io.jenkins.plugins.batchcontrol.model.ActivationState
 
getActivatedBy() - Method in class io.jenkins.plugins.batchcontrol.model.ActivationState
The approver who activated the job, or ActivationState.UPGRADE; null if it never was.
getActivationNotice() - Method in class io.jenkins.plugins.batchcontrol.action.JobNoticesWidget
 
getActivations() - Method in class io.jenkins.plugins.batchcontrol.action.BatchControlRootAction
Stapler: serves /batch-control/activations/....
getActive() - Method in class io.jenkins.plugins.batchcontrol.action.GrantsSection
Stapler: serves /batch-control/grants/active/... (revoke endpoints).
getActiveItems() - Method in class io.jenkins.plugins.batchcontrol.action.ActivationsSection
Approved requests still in effect: the request that set its job's current activation state (ActivationState.getRequestId()), newest first.
getActiveItems() - Method in class io.jenkins.plugins.batchcontrol.action.GrantsSection
Open permission windows on the current page, most recently granted first.
getActiveItems() - Method in class io.jenkins.plugins.batchcontrol.action.RequestsSection
Approved requests whose run has not started yet, on the current page, newest first.
getActivePage() - Method in class io.jenkins.plugins.batchcontrol.action.ActivationsSection
 
getActivePage() - Method in class io.jenkins.plugins.batchcontrol.action.GrantsSection
 
getActivePage() - Method in class io.jenkins.plugins.batchcontrol.action.RequestsSection
 
getActiveTotal() - Method in class io.jenkins.plugins.batchcontrol.action.ActivationsSection
 
getActiveTotal() - Method in class io.jenkins.plugins.batchcontrol.action.GrantsSection
 
getActiveTotal() - Method in class io.jenkins.plugins.batchcontrol.action.RequestsSection
 
getActiveWindow() - Method in class io.jenkins.plugins.batchcontrol.ui.GuardInfo.Outcome
An active window that covers the item, or null.
getAllowedUpstreamJobs() - Method in class io.jenkins.plugins.batchcontrol.config.BatchControlJobProperty
 
getAllowedUpstreamJobsText() - Method in class io.jenkins.plugins.batchcontrol.config.BatchControlJobProperty
 
getAppendedAt() - Method in class io.jenkins.plugins.batchcontrol.model.RunRecord
D-81: when the record was appended, or null for a line written before D-81.
getApprovedRunTimeoutMinutes() - Method in class io.jenkins.plugins.batchcontrol.action.RequestItem
The approved-but-not-run timeout, for the disabled-job and cancelled-run notices.
getApprovedRunTimeoutMinutes() - Method in class io.jenkins.plugins.batchcontrol.config.BatchControlGlobalConfiguration
 
getApprover() - Method in class io.jenkins.plugins.batchcontrol.model.GrantRequest
Compatibility view (D-37): the first designated approver, or null with none.
getApprover() - Method in class io.jenkins.plugins.batchcontrol.model.RunRequest
Compatibility view (D-37): the first designated approver, or null with none.
getApprover() - Method in class io.jenkins.plugins.batchcontrol.queue.ApprovedCause
 
getApproverChanges() - Method in class io.jenkins.plugins.batchcontrol.model.ActivationRequest
 
getApproverChanges() - Method in class io.jenkins.plugins.batchcontrol.model.GrantRequest
 
getApproverChanges() - Method in class io.jenkins.plugins.batchcontrol.model.RunRequest
 
getApproverOptions() - Method in class io.jenkins.plugins.batchcontrol.action.ActivationItem
Approver candidates for the change-approver form (global list ∩ job restriction).
getApproverOptions() - Method in class io.jenkins.plugins.batchcontrol.action.GrantRequestItem
Approver candidates for the change-approver form (global list, self excluded).
getApproverOptions() - Method in class io.jenkins.plugins.batchcontrol.action.GrantsSection
Approver candidates (global list minus the current user, per the self-approval policy).
getApproverOptions() - Method in class io.jenkins.plugins.batchcontrol.action.IncidentItem
Approver candidates for the rerun request form (global list ∩ job restriction).
getApproverOptions() - Method in class io.jenkins.plugins.batchcontrol.action.JobActivationForm
Approver candidates: global approver list ∩ job-level restriction (if configured).
getApproverOptions() - Method in class io.jenkins.plugins.batchcontrol.action.JobRequestAction
Approver candidates: global approver list ∩ job-level restriction (if configured).
getApproverOptions() - Method in class io.jenkins.plugins.batchcontrol.action.RequestItem
Approver candidates for the change-approver form (global list ∩ job restriction).
getApprovers() - Method in class io.jenkins.plugins.batchcontrol.config.BatchControlGlobalConfiguration
 
getApprovers() - Method in class io.jenkins.plugins.batchcontrol.model.ActivationRequest
The designated approver set (D-37), in designation order.
getApprovers() - Method in class io.jenkins.plugins.batchcontrol.model.GrantRequest
The designated approver set (D-37), in designation order.
getApprovers() - Method in class io.jenkins.plugins.batchcontrol.model.RunRequest
The designated approver set (D-37), in designation order.
getApproversText() - Method in class io.jenkins.plugins.batchcontrol.config.BatchControlGlobalConfiguration
 
getAt() - Method in class io.jenkins.plugins.batchcontrol.model.ActivationRequest.ApproverChange
 
getAt() - Method in class io.jenkins.plugins.batchcontrol.model.ChangeRecord
 
getAt() - Method in class io.jenkins.plugins.batchcontrol.model.GrantRequest.ApproverChange
 
getAt() - Method in class io.jenkins.plugins.batchcontrol.model.IncidentTransition
 
getAt() - Method in class io.jenkins.plugins.batchcontrol.model.RunRequest.ApproverChange
 
getAttachment() - Method in class io.jenkins.plugins.batchcontrol.ui.FormErrors
 
getAwaitingDecision() - Method in class io.jenkins.plugins.batchcontrol.model.PendingCount
PENDING requests on which the viewer is a designated approver holding BatchControl/Approve.
getBadge() - Method in class io.jenkins.plugins.batchcontrol.ui.SectionTabs.Tab
Count of open items the viewer can act on, or null when there are none.
getBaseQuery() - Method in class io.jenkins.plugins.batchcontrol.action.HistorySection
The filter as a query fragment (no kind, no page) for CSV links.
getBlockingSwitches() - Method in class io.jenkins.plugins.batchcontrol.action.JobTriggerLockAction
The switches that refuse unattended runs of this job right now, for a viewer holding Item/Read, whether or not the job requires approval for manual runs; empty when run control is off, both switches are off, or the viewer may not read the job (the notice is then not rendered).
getBlockingSwitches() - Method in class io.jenkins.plugins.batchcontrol.config.BatchControlJobProperty
The trigger switches that are refusing unattended runs of this job right now, in the order blockTimer, blockUpstream (job-page notice).
getBy() - Method in class io.jenkins.plugins.batchcontrol.model.ActivationRequest.ApproverChange
 
getBy() - Method in class io.jenkins.plugins.batchcontrol.model.GrantRequest.ApproverChange
 
getBy() - Method in class io.jenkins.plugins.batchcontrol.model.IncidentTransition
 
getBy() - Method in class io.jenkins.plugins.batchcontrol.model.RunRequest.ApproverChange
 
getCarrier() - Method in class io.jenkins.plugins.batchcontrol.action.ComputedFolderActivationAction
A computed folder generated by another computed folder (a repository project of an organization folder) is carried by that folder (D-46c, ActivationService.activationSubject(hudson.model.Item)); the summary then names it.
getCarrier() - Method in class io.jenkins.plugins.batchcontrol.action.JobActivationForm
A computed child carries no activation of its own: the item returned here does (D-46c).
getCarrier() - Method in class io.jenkins.plugins.batchcontrol.action.JobActivationNoticeAction
The computed folder that carries this job's activation when the job is a computed child (D-46c), else null.
getCategory() - Method in class io.jenkins.plugins.batchcontrol.config.BatchControlConfigurationLink
 
getCauseType() - Method in class io.jenkins.plugins.batchcontrol.model.RunRecord
 
getChangedFolder() - Method in class io.jenkins.plugins.batchcontrol.ui.GuardInfo.Outcome
A folder above the item that is still listed as changed under a window, or null.
getChangedItems() - Method in class io.jenkins.plugins.batchcontrol.model.Grant
D-58a: the items changed under this grant and not reviewed since (a copy; never null).
getChanges() - Method in class io.jenkins.plugins.batchcontrol.action.BatchControlRootAction
Stapler: serves /batch-control/changes/....
getComment() - Method in class io.jenkins.plugins.batchcontrol.model.IncidentTransition
 
getConfiguration() - Method in class io.jenkins.plugins.batchcontrol.config.BatchControlConfigurationLink
The configuration the page edits (Jelly binds its fields to it).
getConfigurationLink() - Method in class io.jenkins.plugins.batchcontrol.action.BatchControlRootAction
e2e-03 DEF-10: the Batch Control configuration page for a BatchControl/Manage holder, who may not reach Manage Jenkins; null (no link) for anyone else, or while the page is not shipped.
getCount() - Method in class io.jenkins.plugins.batchcontrol.model.PendingCount
The number to display: decisions when there are any, else own requests; 0 when nothing is pending.
getCreatedAt() - Method in class io.jenkins.plugins.batchcontrol.action.IncidentItem
Incident creation time (first transition).
getCreatedAt() - Method in class io.jenkins.plugins.batchcontrol.model.ActivationRequest
 
getCreatedAt() - Method in class io.jenkins.plugins.batchcontrol.model.GrantRequest
 
getCreatedAt() - Method in class io.jenkins.plugins.batchcontrol.model.Incident
 
getCreatedAt() - Method in class io.jenkins.plugins.batchcontrol.model.RunRequest
 
getCreatedItems() - Method in class io.jenkins.plugins.batchcontrol.model.Grant
D-35c: the items created through this grant's Create (a copy; never null).
getCreateNamePattern() - Method in class io.jenkins.plugins.batchcontrol.model.Grant
D-40: the CREATE name restriction (/regex/ or exact name), or null.
getCreateNamePattern() - Method in class io.jenkins.plugins.batchcontrol.model.GrantRequest
D-40: the CREATE name restriction as written (/regex/ or exact name), or null.
getCreateNamePatternMaxLength() - Method in class io.jenkins.plugins.batchcontrol.action.GrantsSection
Maximum length of the CREATE name restriction, for the form's maxlength.
getCsvUrl() - Method in class io.jenkins.plugins.batchcontrol.action.ChangesSection
The complete CSV export of what this screen lists (S-03), relative to this section.
getCsvUrl() - Method in class io.jenkins.plugins.batchcontrol.action.HistorySection
The complete CSV export of what this screen lists (S-03), relative to this section.
getCsvUrl() - Method in class io.jenkins.plugins.batchcontrol.action.IncidentsSection
The complete CSV export of what this screen lists (S-03), relative to this section.
getDashboard() - Method in class io.jenkins.plugins.batchcontrol.action.BatchControlRootAction
Stapler: serves /batch-control/dashboard/....
getDeactivatedAt() - Method in class io.jenkins.plugins.batchcontrol.model.ActivationState
 
getDeactivatedBy() - Method in class io.jenkins.plugins.batchcontrol.model.ActivationState
The approver of the hold, or null if the job is not on hold.
getDecidedAt() - Method in class io.jenkins.plugins.batchcontrol.model.ActivationRequest
 
getDecidedAt() - Method in class io.jenkins.plugins.batchcontrol.model.GrantRequest
 
getDecidedAt() - Method in class io.jenkins.plugins.batchcontrol.model.RunRequest
 
getDecidedBy() - Method in class io.jenkins.plugins.batchcontrol.model.ActivationRequest
The user who closed the request: the approver who approved or rejected it, or the user who cancelled it (e2e-03 DEF-13); null while undecided.
getDecidedBy() - Method in class io.jenkins.plugins.batchcontrol.model.GrantRequest
The user who closed the request: the approver who approved or rejected it, or the user who cancelled it (e2e-03 DEF-13); null while undecided.
getDecidedBy() - Method in class io.jenkins.plugins.batchcontrol.model.RunRequest
The user who closed the request: the approver who approved or rejected it, or the user who cancelled it (e2e-03 DEF-13); null while undecided.
getDecisionComment() - Method in class io.jenkins.plugins.batchcontrol.model.ActivationRequest
 
getDecisionComment() - Method in class io.jenkins.plugins.batchcontrol.model.GrantRequest
 
getDecisionComment() - Method in class io.jenkins.plugins.batchcontrol.model.RunRequest
 
getDescription() - Method in class io.jenkins.plugins.batchcontrol.config.BatchControlConfigurationLink
 
getDescriptorId() - Method in class io.jenkins.plugins.batchcontrol.model.ItemKind
The descriptor id, for example org.jenkinsci.plugins.workflow.job.WorkflowJob, hudson.model.FreeStyleProject or com.cloudbees.hudson.plugins.folder.Folder.
getDestinationFullName() - Method in exception class io.jenkins.plugins.batchcontrol.security.MoveRefusal
Full name of the group the item was to be moved into, or the empty string for the Jenkins root (which no permission window can cover).
getDetail() - Method in class io.jenkins.plugins.batchcontrol.model.ChangeRecord
 
getDetails() - Method in class io.jenkins.plugins.batchcontrol.ops.Notification
Plain-text Label: value lines describing what the request asks for (for a change request: actions, duration and name restriction); never null, possibly empty.
getDialogUrl() - Method in class io.jenkins.plugins.batchcontrol.action.FolderGrantRequestAction
Root-relative URL of the dialog form, prefilled for this folder.
getDialogUrl() - Method in class io.jenkins.plugins.batchcontrol.action.JobGrantRequestAction
D-66: root-relative URL of the dialog form, prefilled for this job (one query parameter, see JobGrantRequestAction.getUrlName()).
getDialogUrl() - Method in class io.jenkins.plugins.batchcontrol.action.JobRequestAction
D-66: root-relative URL of the dialog form (dialog.jelly), which the classic sidebar entry (action.jelly) opens in core's dialog.
getDiff() - Method in class io.jenkins.plugins.batchcontrol.model.ChangeRecord
 
getDisplayName() - Method in class io.jenkins.plugins.batchcontrol.action.ActivationItem
 
getDisplayName() - Method in class io.jenkins.plugins.batchcontrol.action.ActivationsSection
 
getDisplayName() - Method in class io.jenkins.plugins.batchcontrol.action.BatchControlRootAction
 
getDisplayName() - Method in class io.jenkins.plugins.batchcontrol.action.ChangesSection
 
getDisplayName() - Method in class io.jenkins.plugins.batchcontrol.action.ComputedFolderActivationAction
 
getDisplayName() - Method in class io.jenkins.plugins.batchcontrol.action.DashboardSection
 
getDisplayName() - Method in class io.jenkins.plugins.batchcontrol.action.FolderCreateWindowAction
 
getDisplayName() - Method in class io.jenkins.plugins.batchcontrol.action.FolderGrantRequestAction
 
getDisplayName() - Method in class io.jenkins.plugins.batchcontrol.action.GrantRequestItem
 
getDisplayName() - Method in class io.jenkins.plugins.batchcontrol.action.GrantsSection
 
getDisplayName() - Method in class io.jenkins.plugins.batchcontrol.action.HistorySection
 
getDisplayName() - Method in class io.jenkins.plugins.batchcontrol.action.IncidentItem
 
getDisplayName() - Method in class io.jenkins.plugins.batchcontrol.action.IncidentsSection
 
getDisplayName() - Method in class io.jenkins.plugins.batchcontrol.action.JobActivationForm
 
getDisplayName() - Method in class io.jenkins.plugins.batchcontrol.action.JobActivationNoticeAction
 
getDisplayName() - Method in class io.jenkins.plugins.batchcontrol.action.JobGrantRequestAction
 
getDisplayName() - Method in class io.jenkins.plugins.batchcontrol.action.JobRequestAction
The one sidebar entry on a controlled job that reads "Request Run" (U-02): core's relabeled build link is named RequestRunUiDecorator.BLOCKED_BUILD_LABEL so the two cannot be confused.
getDisplayName() - Method in class io.jenkins.plugins.batchcontrol.action.JobTriggerLockAction
 
getDisplayName() - Method in class io.jenkins.plugins.batchcontrol.action.RequestItem
 
getDisplayName() - Method in class io.jenkins.plugins.batchcontrol.action.RequestsSection
 
getDisplayName() - Method in class io.jenkins.plugins.batchcontrol.action.RunApprovalNoticeAction
 
getDisplayName() - Method in class io.jenkins.plugins.batchcontrol.config.BatchControlConfigurationLink
 
getDisplayName() - Method in class io.jenkins.plugins.batchcontrol.config.BatchControlGlobalConfiguration
 
getDisplayName() - Method in class io.jenkins.plugins.batchcontrol.config.BatchControlJobProperty.DescriptorImpl
 
getDisplayName() - Method in class io.jenkins.plugins.batchcontrol.model.ItemKind
The descriptor display name when recorded, for example "Pipeline", "Freestyle project" or "Folder".
getDisplayName() - Method in class io.jenkins.plugins.batchcontrol.ops.BatchControlStrategyMonitor
 
getDisplayName() - Method in class io.jenkins.plugins.batchcontrol.ops.ConfigureWithoutGrantMonitor
 
getDisplayName() - Method in class io.jenkins.plugins.batchcontrol.ops.ConfigureWithoutGrantMonitor.StandingHolder
The user's display name when Jenkins knows the user, otherwise the sid.
getDisplayName() - Method in class io.jenkins.plugins.batchcontrol.queue.ApprovedRunAction
 
getDisplayName() - Method in class io.jenkins.plugins.batchcontrol.security.BatchControlMatrixAuthorizationStrategy.DescriptorImpl
 
getDisplayName() - Method in class io.jenkins.plugins.batchcontrol.security.BatchControlRoleBasedAuthorizationStrategy.DescriptorImpl
 
getDisplayName() - Method in class io.jenkins.plugins.batchcontrol.ui.SectionTabs.Tab
 
getDuration() - Method in class io.jenkins.plugins.batchcontrol.action.RequestItem.RecentRun
 
getDurationMinutes() - Method in class io.jenkins.plugins.batchcontrol.model.GrantRequest
 
getDurationMs() - Method in class io.jenkins.plugins.batchcontrol.model.RunRecord
 
getDurationOptions() - Method in class io.jenkins.plugins.batchcontrol.action.GrantsSection
Preset duration choices from the global configuration.
getDynamic(String) - Method in class io.jenkins.plugins.batchcontrol.action.ActivationsSection
Stapler: serves /batch-control/activations/<id>/; null renders a 404.
getDynamic(String) - Method in class io.jenkins.plugins.batchcontrol.action.ActiveGrantsSection
Stapler: serves /batch-control/grants/active/<grantId>/...; null renders a 404 when GrantService knows no grant with that id, for a malformed id and for any other failed lookup (S-39-01, RecordLookup).
getDynamic(String) - Method in class io.jenkins.plugins.batchcontrol.action.GrantsSection
Stapler: serves /batch-control/grants/<id>/; null renders a 404.
getDynamic(String) - Method in class io.jenkins.plugins.batchcontrol.action.IncidentsSection
Stapler: serves /batch-control/incidents/<id>/; null renders a 404, also for every failed lookup (S-39-01, RecordLookup).
getDynamic(String) - Method in class io.jenkins.plugins.batchcontrol.action.RequestsSection
Stapler: serves /batch-control/requests/<id>/; null renders a 404.
getEndedItems() - Method in class io.jenkins.plugins.batchcontrol.action.ActivationsSection
Superseded, rejected, cancelled, expired and invalidated requests, newest first.
getEndedItems() - Method in class io.jenkins.plugins.batchcontrol.action.GrantsSection
Ended windows and requests that never became one (rejected, cancelled, expired), on the current page, most recently ended first.
getEndedItems() - Method in class io.jenkins.plugins.batchcontrol.action.RequestsSection
Executed, rejected, cancelled, expired and invalidated requests, newest first.
getEndedPage() - Method in class io.jenkins.plugins.batchcontrol.action.ActivationsSection
 
getEndedPage() - Method in class io.jenkins.plugins.batchcontrol.action.GrantsSection
 
getEndedPage() - Method in class io.jenkins.plugins.batchcontrol.action.RequestsSection
 
getEndedTotal() - Method in class io.jenkins.plugins.batchcontrol.action.ActivationsSection
 
getEndedTotal() - Method in class io.jenkins.plugins.batchcontrol.action.GrantsSection
 
getEndedTotal() - Method in class io.jenkins.plugins.batchcontrol.action.RequestsSection
 
getEvent() - Method in class io.jenkins.plugins.batchcontrol.action.FolderGrantRequestAction
As JobGrantRequestAction.getEvent(): the dialog, on pages that render events.
getEvent() - Method in class io.jenkins.plugins.batchcontrol.action.JobGrantRequestAction
D-66: on the new job page the entry opens the dialog form, as core's own "Build with Parameters" does (DialogEvent); the URL is relative to the job's URL.
getEvent() - Method in class io.jenkins.plugins.batchcontrol.action.JobRequestAction
D-66: on the new job page the entry opens the request form in core's dialog, as core's own "Build with Parameters" does (DialogEvent); relative to the job's URL.
getExecutedAt() - Method in class io.jenkins.plugins.batchcontrol.model.RunRequest
The instant the approved build started, or null if not executed (or stored before).
getExecutedRunId() - Method in class io.jenkins.plugins.batchcontrol.model.RunRequest
 
getExecutedRunUrl() - Method in class io.jenkins.plugins.batchcontrol.action.RequestItem
Root-relative URL of the build this request produced.
getExpiresAt() - Method in class io.jenkins.plugins.batchcontrol.model.Grant
 
getExpiryBase() - Method in class io.jenkins.plugins.batchcontrol.model.RunRequest
Base instant for the approved-run timeout; falls back to RunRequest.getDecidedAt().
getFileParameterNames() - Method in class io.jenkins.plugins.batchcontrol.action.JobRequestAction
getFilter() - Method in class io.jenkins.plugins.batchcontrol.action.HistorySection
The validated filter for the current request (parsed once).
getFolder() - Method in class io.jenkins.plugins.batchcontrol.action.ComputedFolderActivationAction
 
getForm() - Method in class io.jenkins.plugins.batchcontrol.ui.FormErrors
 
getFormErrors() - Method in class io.jenkins.plugins.batchcontrol.action.GrantsSection
The refusal of the new-request form on this request, or an empty one (DEF-09, Jelly).
getFormErrors() - Method in class io.jenkins.plugins.batchcontrol.action.JobActivationForm
The refusal of the last submission on this request, or an empty one (DEF-09).
getFormErrors() - Method in class io.jenkins.plugins.batchcontrol.action.JobRequestAction
The refusal of the last submission on this request, or an empty one (DEF-09).
getFrom() - Method in class io.jenkins.plugins.batchcontrol.model.GrantRequest.ApproverChange
Compatibility view: the first member of the previous set, or null.
getFrom() - Method in class io.jenkins.plugins.batchcontrol.model.RunRequest.ApproverChange
Compatibility view: the first member of the previous set, or null.
getFromApprovers() - Method in class io.jenkins.plugins.batchcontrol.model.ActivationRequest.ApproverChange
The previous designated set.
getFromApprovers() - Method in class io.jenkins.plugins.batchcontrol.model.GrantRequest.ApproverChange
The previous designated set.
getFromApprovers() - Method in class io.jenkins.plugins.batchcontrol.model.RunRequest.ApproverChange
The previous designated set.
getFromError() - Method in class io.jenkins.plugins.batchcontrol.ui.FilterParser.Filter
e2e-04 FD-11: the refusal of the from date, or null.
getFromInput() - Method in class io.jenkins.plugins.batchcontrol.ui.FilterParser.Filter
The from field's value for redisplay: what the user entered after a refusal.
getFromValue() - Method in class io.jenkins.plugins.batchcontrol.ui.FilterParser.Filter
 
getFullName() - Method in class io.jenkins.plugins.batchcontrol.model.GrantScope
 
getFullName() - Method in class io.jenkins.plugins.batchcontrol.ui.ScopeDisplay
The full name to show: the window's current one when it did not change or the viewer may read the item, otherwise the approved one.
getGrant() - Method in class io.jenkins.plugins.batchcontrol.action.GrantRequestItem
The permission window of this request once approved (it carries the request's id), or null.
getGrant() - Method in class io.jenkins.plugins.batchcontrol.action.GrantsSection.Row
 
getGrantDurationOptions() - Method in class io.jenkins.plugins.batchcontrol.config.BatchControlGlobalConfiguration
 
getGrantDurationOptionsText() - Method in class io.jenkins.plugins.batchcontrol.config.BatchControlGlobalConfiguration
 
getGrantedAt() - Method in class io.jenkins.plugins.batchcontrol.model.Grant
 
getGrantId() - Method in class io.jenkins.plugins.batchcontrol.model.ChangeRecord
 
getGrantId() - Method in class io.jenkins.plugins.batchcontrol.queue.ReplayUnderGrantAction
 
getGrantId() - Method in class io.jenkins.plugins.batchcontrol.ui.GuardInfo.Changed
 
getGrantRequestId() - Method in class io.jenkins.plugins.batchcontrol.model.Grant
The id of the request this grant came from.
getGrants() - Method in class io.jenkins.plugins.batchcontrol.action.BatchControlRootAction
Stapler: serves /batch-control/grants/....
getGroup() - Method in class io.jenkins.plugins.batchcontrol.action.JobRequestAction
Hosting review 2026-10-02: on the new job page the run request is the job's build button, so it sits first in the app bar rather than in the overflow menu.
getGroups(String) - Method in class io.jenkins.plugins.batchcontrol.security.BatchControlRoleBasedAuthorizationStrategy.DescriptorImpl
The permission groups shown for a role type.
getHistory() - Method in class io.jenkins.plugins.batchcontrol.action.BatchControlRootAction
Stapler: serves /batch-control/history/....
getIconClassName() - Method in class io.jenkins.plugins.batchcontrol.model.ItemKind
The descriptor's icon class name, or null when it has none.
getIconFileName() - Method in class io.jenkins.plugins.batchcontrol.action.BatchControlRootAction
 
getIconFileName() - Method in class io.jenkins.plugins.batchcontrol.action.ComputedFolderActivationAction
 
getIconFileName() - Method in class io.jenkins.plugins.batchcontrol.action.FolderCreateWindowAction
 
getIconFileName() - Method in class io.jenkins.plugins.batchcontrol.action.FolderGrantRequestAction
 
getIconFileName() - Method in class io.jenkins.plugins.batchcontrol.action.JobActivationForm
No sidebar entry: the job and folder pages link the form from their activation notice.
getIconFileName() - Method in class io.jenkins.plugins.batchcontrol.action.JobActivationNoticeAction
 
getIconFileName() - Method in class io.jenkins.plugins.batchcontrol.action.JobGrantRequestAction
 
getIconFileName() - Method in class io.jenkins.plugins.batchcontrol.action.JobRequestAction
 
getIconFileName() - Method in class io.jenkins.plugins.batchcontrol.action.JobTriggerLockAction
 
getIconFileName() - Method in class io.jenkins.plugins.batchcontrol.action.RunApprovalNoticeAction
 
getIconFileName() - Method in class io.jenkins.plugins.batchcontrol.config.BatchControlConfigurationLink
The entry is listed only once its page (index.jelly) is shipped, so the link can never lead to a 404 (SPEC section 6).
getIconFileName() - Method in class io.jenkins.plugins.batchcontrol.queue.ApprovedRunAction
 
getIconFileName() - Method in class io.jenkins.plugins.batchcontrol.ui.SectionTabs.Tab
 
getId() - Method in class io.jenkins.plugins.batchcontrol.action.ActivationItem
 
getId() - Method in class io.jenkins.plugins.batchcontrol.action.GrantRequestItem
 
getId() - Method in class io.jenkins.plugins.batchcontrol.action.GrantsSection.Row
 
getId() - Method in class io.jenkins.plugins.batchcontrol.action.IncidentItem
 
getId() - Method in class io.jenkins.plugins.batchcontrol.action.RequestItem
 
getId() - Method in class io.jenkins.plugins.batchcontrol.model.ActivationRequest
 
getId() - Method in class io.jenkins.plugins.batchcontrol.model.ChangeRecord
 
getId() - Method in class io.jenkins.plugins.batchcontrol.model.Grant
 
getId() - Method in class io.jenkins.plugins.batchcontrol.model.GrantRequest
 
getId() - Method in class io.jenkins.plugins.batchcontrol.model.Incident
 
getId() - Method in class io.jenkins.plugins.batchcontrol.model.RunRequest
 
getId() - Method in class io.jenkins.plugins.batchcontrol.ui.ReplayedRuns.Row
 
getId() - Method in class io.jenkins.plugins.batchcontrol.ui.SectionTabs.Tab
Key a page names as its active tab (bc:tabs active="...").
getImplementedAPI() - Method in class io.jenkins.plugins.batchcontrol.security.BatchControlMatrixCascConfigurator
 
getImplementedAPI() - Method in class io.jenkins.plugins.batchcontrol.security.BatchControlRoleBasedCascConfigurator
 
getIncident() - Method in class io.jenkins.plugins.batchcontrol.action.IncidentItem
 
getIncidentId() - Method in class io.jenkins.plugins.batchcontrol.model.RunRequest
 
getIncidentResults() - Method in class io.jenkins.plugins.batchcontrol.config.BatchControlGlobalConfiguration
 
getIncidentResultsText() - Method in class io.jenkins.plugins.batchcontrol.config.BatchControlGlobalConfiguration
 
getIncidents() - Method in class io.jenkins.plugins.batchcontrol.action.BatchControlRootAction
Stapler: serves /batch-control/incidents/....
getInheritedFrom() - Method in class io.jenkins.plugins.batchcontrol.queue.ReplayUnderGrantAction
 
getInstalledStrategyName() - Method in class io.jenkins.plugins.batchcontrol.ops.BatchControlStrategyMonitor
The display name of the installed strategy (for the view).
getInvalidationReason() - Method in class io.jenkins.plugins.batchcontrol.model.RunRequest
 
getItem() - Method in class io.jenkins.plugins.batchcontrol.action.JobActivationForm
 
getItemFullName() - Method in exception class io.jenkins.plugins.batchcontrol.security.MoveRefusal
Full name of the item whose move was refused.
getItemFullName() - Method in exception class io.jenkins.plugins.batchcontrol.ui.GrantRequiredFailure
 
getItemFullName() - Method in class io.jenkins.plugins.batchcontrol.ui.GuardInfo.Outcome
 
getItemFullName() - Method in exception class io.jenkins.plugins.batchcontrol.ui.SelfGrantRevertedFailure
 
getItemIdentity() - Method in class io.jenkins.plugins.batchcontrol.model.ActivationState
The directory marker this state is bound to, or null (S-13-09).
getItemKind() - Method in class io.jenkins.plugins.batchcontrol.action.GrantsSection.Row
D-71: the kind of the item the row names (icon and display name), or null.
getItemKind() - Method in class io.jenkins.plugins.batchcontrol.model.Grant
D-71: the kind of the scope item, copied from the request (null if it recorded none).
getItemKind() - Method in class io.jenkins.plugins.batchcontrol.model.GrantRequest
D-71: the kind of the scope item recorded at creation, or null when none was recorded.
getItemKindName() - Method in exception class io.jenkins.plugins.batchcontrol.ui.GrantRequiredFailure
The kind of the item in words, for example "Folder" or "Multibranch Pipeline".
getItems() - Method in class io.jenkins.plugins.batchcontrol.action.DashboardSection
The most recent runs, newest first, at most DashboardSection.LIMIT.
getItems() - Method in class io.jenkins.plugins.batchcontrol.store.RecordPage
The rows of this page, newest first.
getItemsChangedUnderGrant() - Method in class io.jenkins.plugins.batchcontrol.ops.BatchControlStrategyMonitor
D-58a: the items in the "changed under a grant" state (saved or created under a grant and not reviewed since by an administrator or a native Configure holder through the web), sorted, at most 50.
getItemUrl() - Method in exception class io.jenkins.plugins.batchcontrol.security.MoveRefusal
For the refusal page's link back to the item: the item's URL relative to the Jenkins root (for example job/prod/job/x/), or null when the current user may not open it.
getItemUrl() - Method in class io.jenkins.plugins.batchcontrol.ui.GuardInfo.Outcome
The item's URL relative to the Jenkins root.
getJob() - Method in class io.jenkins.plugins.batchcontrol.action.JobActivationNoticeAction
 
getJob() - Method in class io.jenkins.plugins.batchcontrol.action.JobGrantRequestAction
 
getJob() - Method in class io.jenkins.plugins.batchcontrol.action.JobNoticesWidget
 
getJob() - Method in class io.jenkins.plugins.batchcontrol.action.JobRequestAction
 
getJob() - Method in class io.jenkins.plugins.batchcontrol.action.JobTriggerLockAction
 
getJob() - Method in class io.jenkins.plugins.batchcontrol.action.RunApprovalNoticeAction
 
getJob() - Method in exception class io.jenkins.plugins.batchcontrol.ui.ApprovalRequiredFailure
The refused job as the viewer sees it, or null when the viewer cannot read it.
getJob() - Method in class io.jenkins.plugins.batchcontrol.ui.FilterParser.Filter
 
getJobApprovers() - Method in class io.jenkins.plugins.batchcontrol.config.BatchControlJobProperty
 
getJobApproversText() - Method in class io.jenkins.plugins.batchcontrol.config.BatchControlJobProperty
 
getJobFullName() - Method in class io.jenkins.plugins.batchcontrol.model.ActivationRequest
 
getJobFullName() - Method in class io.jenkins.plugins.batchcontrol.model.ActivationState
 
getJobFullName() - Method in class io.jenkins.plugins.batchcontrol.model.Incident
 
getJobFullName() - Method in class io.jenkins.plugins.batchcontrol.model.RunRecord
 
getJobFullName() - Method in class io.jenkins.plugins.batchcontrol.model.RunRequest
 
getJobFullName() - Method in exception class io.jenkins.plugins.batchcontrol.ui.ApprovalRequiredFailure
 
getJobUrl() - Method in class io.jenkins.plugins.batchcontrol.action.ActivationItem
Root-relative URL of the job or computed folder (D-46c) when the viewer may read it, else null (plain text).
getJobUrl() - Method in class io.jenkins.plugins.batchcontrol.action.IncidentItem
e2e-04 UX-19: the job's URL for a viewer who may read it (P-09, IncidentItem.findJob()), else null.
getJobUrl() - Method in class io.jenkins.plugins.batchcontrol.action.RequestItem
Job URL relative to the Jenkins root if the job exists and the user may see it, else null.
getKind() - Method in class io.jenkins.plugins.batchcontrol.action.HistorySection
The selected table, from ?kind=; runs on absence or garbage.
getKind() - Method in class io.jenkins.plugins.batchcontrol.ops.Notification
"RUN" for a run request, "GRANT" for a change request or window, "ACTIVATION" for an activation or hold request.
getLegacyFormQuery() - Method in class io.jenkins.plugins.batchcontrol.action.GrantsSection
D-66: the query string to carry from an old prefill link of the list page (/batch-control/grants/?scopeFullName=... or ?from=...) to the form page, or null when the list page was opened without one.
getLimit() - Method in class io.jenkins.plugins.batchcontrol.action.DashboardSection
Most runs listed, for the page text.
getLimit() - Method in exception class io.jenkins.plugins.batchcontrol.policy.RequestTooLargeException
The cap in bytes the request was measured against.
getLinks() - Method in class io.jenkins.plugins.batchcontrol.action.BatchControlRootAction
Link predicates of the overview: each entry is shown only if it can be opened.
getLinks() - Method in class io.jenkins.plugins.batchcontrol.action.ChangesSection
Link predicates: a link to another screen is rendered only if the user may open it.
getLinks() - Method in class io.jenkins.plugins.batchcontrol.action.DashboardSection
Link predicates: a link to another screen is rendered only if the user may open it.
getLinks() - Method in class io.jenkins.plugins.batchcontrol.action.HistorySection
Link predicates: a link to another screen is rendered only if the user may open it.
getLinks() - Method in class io.jenkins.plugins.batchcontrol.action.IncidentItem
Link predicates: a link to another screen is rendered only if the user may open it.
getLinks() - Method in class io.jenkins.plugins.batchcontrol.action.JobTriggerLockAction
Link predicates: the Grants screen is linked only for a user who may open it.
getLogTail() - Method in class io.jenkins.plugins.batchcontrol.model.Incident
The masked console log excerpt (at most 100 lines, D-19).
getLogTailText() - Method in class io.jenkins.plugins.batchcontrol.action.IncidentItem
The stored console log excerpt as one string for the <pre> block.
getMarkedRuns() - Method in class io.jenkins.plugins.batchcontrol.action.JobRequestAction
D-58c: the runs of this job replayed under a permission window, for the review section.
getMarkerReuseAlertItems() - Method in class io.jenkins.plugins.batchcontrol.action.HistorySection
The re-use rows the alert actually lists: the newest HistorySection.REUSE_ALERT_LIMIT.
getMarkerReuseCount() - Method in class io.jenkins.plugins.batchcontrol.action.HistorySection
How many blocked re-use attempts match the filter (a lower bound when truncated).
getMarkerReuseItems() - Method in class io.jenkins.plugins.batchcontrol.action.HistorySection
The blocked approval-marker re-use records matching the filter, newest first, at most HistorySection.REUSE_ALERT_LIMIT of them (D-30).
getMarkerReuseOverflow() - Method in class io.jenkins.plugins.batchcontrol.action.HistorySection
How many matching re-use records the alert does not list; 0 when it lists them all.
getMatched() - Method in class io.jenkins.plugins.batchcontrol.store.RecordPage
Matching records among those read (exact when not RecordPage.isTruncated()).
getMaxGrantMinutes() - Method in class io.jenkins.plugins.batchcontrol.action.GrantsSection
Upper bound in minutes for a grant request (client-side cap; the service re-checks).
getMaxGrantMinutes() - Method in class io.jenkins.plugins.batchcontrol.config.BatchControlGlobalConfiguration
 
getMessage() - Method in class io.jenkins.plugins.batchcontrol.ui.FormErrors
The message above the form, or null.
getMonth() - Method in class io.jenkins.plugins.batchcontrol.action.ChangesSection
The selected month, from ?month=YYYY-MM; current month on absence or garbage.
getMonth() - Method in class io.jenkins.plugins.batchcontrol.action.IncidentsSection
The selected month, from ?month=YYYY-MM; current month on absence or garbage.
getMonthlyMonth() - Method in class io.jenkins.plugins.batchcontrol.action.HistorySection
The month of the monthly summary screen (e2e-03 DEF-22, T-12-12), from ?month=YYYY-MM; anything else (absent, malformed) falls back to HistorySection.getSummaryMonth(), so the query string never reaches the page unparsed.
getMonthlySummary() - Method in class io.jenkins.plugins.batchcontrol.action.HistorySection
The rows of the monthly summary screen for HistorySection.getMonthlyMonth().
getMonthValue() - Method in class io.jenkins.plugins.batchcontrol.action.ChangesSection
Selected month as YYYY-MM (value of the month input and the query parameter).
getMonthValue() - Method in class io.jenkins.plugins.batchcontrol.action.IncidentsSection
Selected month as YYYY-MM (value of the month input and the query parameter).
getName() - Method in class io.jenkins.plugins.batchcontrol.security.BatchControlMatrixCascConfigurator
 
getName() - Method in class io.jenkins.plugins.batchcontrol.security.BatchControlRoleBasedCascConfigurator
 
getNames() - Method in class io.jenkins.plugins.batchcontrol.security.BatchControlMatrixCascConfigurator
 
getNames() - Method in class io.jenkins.plugins.batchcontrol.security.BatchControlRoleBasedCascConfigurator
 
getNextAction() - Method in class io.jenkins.plugins.batchcontrol.action.JobActivationForm
The action a new request would ask for: HOLD when activated, else ACTIVATE.
getNextMonth() - Method in class io.jenkins.plugins.batchcontrol.action.ChangesSection
Next month as YYYY-MM (for the navigation link).
getNextMonth() - Method in class io.jenkins.plugins.batchcontrol.action.IncidentsSection
Next month as YYYY-MM (for the navigation link).
getNotices() - Method in class io.jenkins.plugins.batchcontrol.ops.Notification
Plain-text sentences the recipient must notice, for example "The requester does not have Build permission on this job." (D-38a, run requests, REQUEST_CREATED and APPROVERS_CHANGED); never null, possibly empty.
getNotifyBeforeExpiryMinutes() - Method in class io.jenkins.plugins.batchcontrol.config.BatchControlGlobalConfiguration
 
getNumber() - Method in class io.jenkins.plugins.batchcontrol.action.RequestItem.RecentRun
 
getNumber() - Method in class io.jenkins.plugins.batchcontrol.model.RunRecord
 
getObject() - Method in class io.jenkins.plugins.batchcontrol.action.JobActivationForm
The job, under the name core's l:job-subpage reads (it.object), so the form renders as a sub-page of the job on the new job page (e2e-14 DEF-08); null for a computed folder, which the view keeps on the classic layout.
getObject() - Method in class io.jenkins.plugins.batchcontrol.action.JobRequestAction
The job, under the name core's l:job-subpage reads (it.object), so the request form renders as a sub-page of the job in both the classic and the new job page.
getOversized() - Method in class io.jenkins.plugins.batchcontrol.action.ChangesSection
Over-long lines (over 1 MiB) skipped while reading this page (security-11 N-02); the CSV export skips the same lines, so the screen says so rather than look complete.
getOversized() - Method in class io.jenkins.plugins.batchcontrol.action.DashboardSection
Over-long lines (over 1 MiB) skipped while reading (security-11 N-02); the CSV export skips the same lines, so the screen says so rather than look complete.
getOversized() - Method in class io.jenkins.plugins.batchcontrol.action.HistorySection
Over-long lines (over 1 MiB) skipped while reading this table (security-11 N-02); the CSV export skips the same lines, so the screen says so rather than look complete.
getOversized() - Method in class io.jenkins.plugins.batchcontrol.action.IncidentsSection
Over-long lines (over 1 MiB) skipped while reading this page (security-11 N-02); the CSV export skips the same lines, so the screen says so rather than look complete.
getOversized() - Method in class io.jenkins.plugins.batchcontrol.store.RecordPage
Lines of the months read that were longer than ReverseLineReader.MAX_LINE_BYTES and therefore skipped (security-11 N-02).
getOwn() - Method in class io.jenkins.plugins.batchcontrol.model.PendingCount
The viewer's own PENDING requests that are not already counted as awaiting their decision.
getPage() - Method in class io.jenkins.plugins.batchcontrol.action.ChangesSection
Current 1-based page, from the page query parameter (Paging).
getPage() - Method in class io.jenkins.plugins.batchcontrol.action.HistorySection
Current 1-based page, from the page query parameter (Paging).
getPage() - Method in class io.jenkins.plugins.batchcontrol.action.IncidentsSection
Current 1-based page, from the page query parameter (Paging).
getPageItems() - Method in class io.jenkins.plugins.batchcontrol.action.ChangesSection
The change records shown on the current page, newest first.
getPageItems() - Method in class io.jenkins.plugins.batchcontrol.action.HistorySection
The rows of the selected kind shown on the current page, newest first.
getPageItems() - Method in class io.jenkins.plugins.batchcontrol.action.IncidentsSection
The incidents shown on the current page, newest first.
getParameterDefinitions() - Method in class io.jenkins.plugins.batchcontrol.action.JobRequestAction
The job's parameter definitions, rendered by each definition's own index.jelly.
getParameters() - Method in class io.jenkins.plugins.batchcontrol.model.Incident
The failed build's parameters, sensitive values already masked.
getParameters() - Method in class io.jenkins.plugins.batchcontrol.model.RunRecord
 
getParameters() - Method in class io.jenkins.plugins.batchcontrol.model.RunRequest
The masked display map (D-72): a sensitive value is ********, a file value [file] <original file name>.
getParentJob() - Method in class io.jenkins.plugins.batchcontrol.action.JobActivationNoticeAction
D-82: the job whose activation and run approval a sub-item follows (its topmost parent job).
getPendingItems() - Method in class io.jenkins.plugins.batchcontrol.action.ActivationsSection
Pending requests on the current page, oldest first (closest to its timeout on top).
getPendingItems() - Method in class io.jenkins.plugins.batchcontrol.action.GrantsSection
Pending grant requests on the current page, oldest first (closest to its timeout on top).
getPendingItems() - Method in class io.jenkins.plugins.batchcontrol.action.RequestsSection
Pending requests on the current page, oldest first (closest to its timeout on top).
getPendingPage() - Method in class io.jenkins.plugins.batchcontrol.action.ActivationsSection
 
getPendingPage() - Method in class io.jenkins.plugins.batchcontrol.action.GrantsSection
 
getPendingPage() - Method in class io.jenkins.plugins.batchcontrol.action.RequestsSection
 
getPendingRequests() - Method in class io.jenkins.plugins.batchcontrol.action.ComputedFolderActivationAction
The PENDING requests of this folder the viewer may see (P-09).
getPendingRequests() - Method in class io.jenkins.plugins.batchcontrol.action.JobActivationForm
The PENDING requests of this job the viewer may see (P-09), oldest first.
getPendingRequests() - Method in class io.jenkins.plugins.batchcontrol.action.JobActivationNoticeAction
The PENDING requests of this job the viewer may see (P-09).
getPendingTimeoutHours() - Method in class io.jenkins.plugins.batchcontrol.config.BatchControlGlobalConfiguration
 
getPendingTotal() - Method in class io.jenkins.plugins.batchcontrol.action.ActivationsSection
 
getPendingTotal() - Method in class io.jenkins.plugins.batchcontrol.action.GrantsSection
 
getPendingTotal() - Method in class io.jenkins.plugins.batchcontrol.action.RequestsSection
 
getPermissions() - Method in class io.jenkins.plugins.batchcontrol.ops.ConfigureWithoutGrantMonitor.StandingHolder
The standing change permissions held, e.g.
getPrefill() - Method in exception class io.jenkins.plugins.batchcontrol.ops.RerunNeedsFormException
The recoverable non-sensitive, non-file values of the failed run as text, by parameter name in the run's order; possibly empty.
getPrefillCreateNamePattern() - Method in class io.jenkins.plugins.batchcontrol.action.GrantsSection
The renewed grant's CREATE name restriction, or empty.
getPrefillScopeFullName() - Method in class io.jenkins.plugins.batchcontrol.action.GrantsSection
Full name the new-request form starts with: the renewed grant's scope (D-33), else ?scopeFullName= — how JobGrantRequestAction hands the job over, so a user who arrives from a job page does not have to retype its path (U-01).
getPreviousMonth() - Method in class io.jenkins.plugins.batchcontrol.action.ChangesSection
Previous month as YYYY-MM (for the navigation link).
getPreviousMonth() - Method in class io.jenkins.plugins.batchcontrol.action.IncidentsSection
Previous month as YYYY-MM (for the navigation link).
getQueueCancelledAt() - Method in class io.jenkins.plugins.batchcontrol.model.RunRequest
D-72b (7): when the queue item of the approved run was cancelled, or null.
getQueuedAt() - Method in class io.jenkins.plugins.batchcontrol.model.RunRequest
The instant the consumption ticket was claimed, or null if still unused.
getReason() - Method in class io.jenkins.plugins.batchcontrol.model.ActivationRequest
 
getReason() - Method in class io.jenkins.plugins.batchcontrol.model.GrantRequest
 
getReason() - Method in class io.jenkins.plugins.batchcontrol.model.RunRequest
 
getReason() - Method in class io.jenkins.plugins.batchcontrol.ops.Notification
 
getRecentRunCount() - Method in class io.jenkins.plugins.batchcontrol.action.RequestItem
How many recent-run rows were actually found (at most RequestItem.getRecentRunLimit()).
getRecentRunLimit() - Method in class io.jenkins.plugins.batchcontrol.action.RequestItem
How many recent runs this rendering shows, from the runs query parameter (?runs=20) and defaulting to 5.
getRecentRunLimitOptions() - Method in class io.jenkins.plugins.batchcontrol.action.RequestItem
The sizes offered by the ?runs= links below the recent-run table.
getRecentRuns() - Method in class io.jenkins.plugins.batchcontrol.action.RequestItem
The most recent runs of the requested job, newest first, so an approver can see how the job behaved last time without opening a second tab (T-E2E-05).
getRecipients() - Method in class io.jenkins.plugins.batchcontrol.ops.Notification
Jenkins user ids to notify; never null.
getRecurrencePeriod() - Method in class io.jenkins.plugins.batchcontrol.ops.ExpiryPeriodicWork
 
getRecurrencePeriod() - Method in class io.jenkins.plugins.batchcontrol.ops.RetentionPeriodicWork
 
getReenterParameterNames() - Method in class io.jenkins.plugins.batchcontrol.action.JobRequestAction
The names of the job's parameters whose values the form never fills in, so the user provides them again (D-72, D-60): file parameters (RequestRunPrefill.isFileDefinition(hudson.model.ParameterDefinition)) and password parameters.
getRenewScope() - Method in class io.jenkins.plugins.batchcontrol.action.GrantsSection
D-75 (1), security-39 S-39-04: the name the form's prefill note shows for the renewed grant's item (tags/scopeItem.jelly), or null when the form renews nothing.
getRenewSource() - Method in class io.jenkins.plugins.batchcontrol.action.GrantsSection
The ended grant the form renews (?from=<grantId>), or null.
getRequest() - Method in class io.jenkins.plugins.batchcontrol.action.ActivationItem
 
getRequest() - Method in class io.jenkins.plugins.batchcontrol.action.GrantRequestItem
 
getRequest() - Method in class io.jenkins.plugins.batchcontrol.action.GrantsSection.Row
 
getRequest() - Method in class io.jenkins.plugins.batchcontrol.action.RequestItem
 
getRequester() - Method in class io.jenkins.plugins.batchcontrol.model.ActivationRequest
 
getRequester() - Method in class io.jenkins.plugins.batchcontrol.model.GrantRequest
 
getRequester() - Method in class io.jenkins.plugins.batchcontrol.model.RunRequest
 
getRequester() - Method in class io.jenkins.plugins.batchcontrol.ops.Notification
 
getRequester() - Method in class io.jenkins.plugins.batchcontrol.queue.ApprovedCause
 
getRequesterLacksBuildNotice() - Method in class io.jenkins.plugins.batchcontrol.action.RequestItem
D-38a: the frozen sentence shown when RequestItem.isRequesterLacksBuild() holds.
getRequestId() - Method in class io.jenkins.plugins.batchcontrol.model.ActivationState
The request that set this state last, or null for the upgrade seeding.
getRequestId() - Method in class io.jenkins.plugins.batchcontrol.ops.Notification
The request id (for a window, the id of the change request it came from).
getRequestId() - Method in class io.jenkins.plugins.batchcontrol.queue.ApprovedCause
 
getRequestId() - Method in class io.jenkins.plugins.batchcontrol.queue.ApprovedRunAction
 
getRequests() - Method in class io.jenkins.plugins.batchcontrol.action.BatchControlRootAction
Stapler: serves /batch-control/requests/....
getRequestUrl() - Method in exception class io.jenkins.plugins.batchcontrol.ui.GrantRequiredFailure
Root-relative URL of the new-request form prefilled for the item and action (batch-control/grants/new?scopeFullName=<item>&actions=<ACTION>), or null when no window can allow the change.
getRequiredGlobalConfigPagePermission() - Method in class io.jenkins.plugins.batchcontrol.config.BatchControlGlobalConfiguration
e2e-03 DEF-10: this section is shown and saved for BatchControl/Manage holders (implied by Overall/Administer) rather than for administrators only.
getRequiredPermission() - Method in class io.jenkins.plugins.batchcontrol.config.BatchControlConfigurationLink
 
getRerunIncidentId() - Method in class io.jenkins.plugins.batchcontrol.action.JobRequestAction
D-72, D-72a (SPEC item 11): the id of the incident whose rerun continues on this form, or null.
getRerunReason() - Method in class io.jenkins.plugins.batchcontrol.action.JobRequestAction
The reason the form starts with on a rerun that continues here (JobRequestAction.getRerunIncidentId()): the reason the rerun would have generated, editable; otherwise empty.
getRerunRequestIds() - Method in class io.jenkins.plugins.batchcontrol.model.Incident
 
getResolvedByRunId() - Method in class io.jenkins.plugins.batchcontrol.model.Incident
 
getResolvedByRunUrl() - Method in class io.jenkins.plugins.batchcontrol.action.IncidentItem
Root-relative build URL for the resolving run, or null (same rule as IncidentItem.getRunUrl()).
getResult() - Method in class io.jenkins.plugins.batchcontrol.action.RequestItem.RecentRun
 
getResult() - Method in class io.jenkins.plugins.batchcontrol.model.Incident
 
getResult() - Method in class io.jenkins.plugins.batchcontrol.model.RunRecord
 
getResult() - Method in class io.jenkins.plugins.batchcontrol.ui.FilterParser.Filter
 
getRetentionMonths() - Method in class io.jenkins.plugins.batchcontrol.config.BatchControlGlobalConfiguration
 
getReviewPageUrl() - Method in exception class io.jenkins.plugins.batchcontrol.ui.SelfGrantRevertedFailure
DEF-39: the root-relative URL of the job's Batch Control page, where "Mark as reviewed" is offered, when the viewer may open it (the page exists only for a job, and only for a BatchControl/Request holder who may read the job); else null.
getRevokedAt() - Method in class io.jenkins.plugins.batchcontrol.model.Grant
 
getRevokedBy() - Method in class io.jenkins.plugins.batchcontrol.model.Grant
 
getRevokedReason() - Method in class io.jenkins.plugins.batchcontrol.model.Grant
The revocation reason of a mass revocation, or null; see Grant.REVOKED_CHANGE_CONTROL_OFF.
getRootACL() - Method in class io.jenkins.plugins.batchcontrol.security.BatchControlMatrixAuthorizationStrategy
 
getRunId() - Method in class io.jenkins.plugins.batchcontrol.model.Incident
 
getRunId() - Method in class io.jenkins.plugins.batchcontrol.model.RunRecord
 
getRunRequestId() - Method in class io.jenkins.plugins.batchcontrol.model.RunRecord
 
getRunTimestampMillis() - Method in class io.jenkins.plugins.batchcontrol.model.Incident
D-72b (6): the failed build's own timestamp in epoch milliseconds, or null when the incident was stored before it was recorded.
getRunUrl() - Method in class io.jenkins.plugins.batchcontrol.action.IncidentItem
Root-relative build URL for the originating run; null (plain text) when the id is malformed or the viewer lacks Item/Read on the job (D-44, Visibility.runUrlFromRunId(java.lang.String)).
getSaveError() - Method in class io.jenkins.plugins.batchcontrol.config.BatchControlConfigurationLink
The refusal message of the submission being answered, or null (for the view).
getScope() - Method in class io.jenkins.plugins.batchcontrol.model.Grant
 
getScope() - Method in class io.jenkins.plugins.batchcontrol.model.GrantRequest
 
getScopeFullName() - Method in class io.jenkins.plugins.batchcontrol.ui.GuardInfo.Changed
Full name of the job or folder the window was requested for.
getSemantic() - Method in class io.jenkins.plugins.batchcontrol.action.JobRequestAction
Rendered as a build action (the build colour) on the new job page; see JobRequestAction.getGroup().
getShortDescription() - Method in class io.jenkins.plugins.batchcontrol.queue.ApprovedCause
 
getShownScope() - Method in class io.jenkins.plugins.batchcontrol.action.GrantRequestItem
D-75 (1), security-39 S-39-04: the name the Scope row shows (tags/scopeItem.jelly).
getShownScope() - Method in class io.jenkins.plugins.batchcontrol.action.GrantsSection.Row
D-75 (1), security-39 S-39-04: the name the Scope cell shows (tags/scopeItem.jelly): a window's followed name only to a viewer who may read the item now (or an administrator), otherwise the approved name with the fixed "moved" note; unchanged when the name did not change.
getSid() - Method in class io.jenkins.plugins.batchcontrol.ops.ConfigureWithoutGrantMonitor.StandingHolder
The user id or group name as written in the authorization strategy.
getStandingGroups() - Method in class io.jenkins.plugins.batchcontrol.ops.ConfigureWithoutGrantMonitor
The groups of ConfigureWithoutGrantMonitor.getStandingHolders() (including authenticated).
getStandingHolders() - Method in class io.jenkins.plugins.batchcontrol.ops.ConfigureWithoutGrantMonitor
Every user and group found holding a standing change permission (users first, then groups), from the same TTL-cached scan as ConfigureWithoutGrantMonitor.isActivated().
getStandingUsers() - Method in class io.jenkins.plugins.batchcontrol.ops.ConfigureWithoutGrantMonitor
getStarted() - Method in class io.jenkins.plugins.batchcontrol.action.RequestItem.RecentRun
 
getStartedAt() - Method in class io.jenkins.plugins.batchcontrol.model.RunRecord
 
getState() - Method in class io.jenkins.plugins.batchcontrol.action.JobActivationForm
 
getState(Item) - Method in class io.jenkins.plugins.batchcontrol.policy.ActivationService
The stored activation state of an item (a job or a computed folder), or null.
getState(Item) - Static method in class io.jenkins.plugins.batchcontrol.ui.ActivationView
The stored state, or null; a state that cannot be read is shown as none.
getState(Job<?, ?>) - Method in class io.jenkins.plugins.batchcontrol.policy.ActivationService
getState(String) - Method in class io.jenkins.plugins.batchcontrol.policy.ActivationService
The stored activation state of an item, or null if none is stored.
getStatus() - Method in class io.jenkins.plugins.batchcontrol.action.GrantsSection.Row
The request status name, or null for a window without a stored request.
getStatus() - Method in class io.jenkins.plugins.batchcontrol.model.ActivationRequest
 
getStatus() - Method in class io.jenkins.plugins.batchcontrol.model.GrantRequest
 
getStatus() - Method in class io.jenkins.plugins.batchcontrol.model.Incident
 
getStatus() - Method in class io.jenkins.plugins.batchcontrol.model.IncidentTransition
 
getStatus() - Method in class io.jenkins.plugins.batchcontrol.model.RunRequest
 
getStatus() - Method in class io.jenkins.plugins.batchcontrol.ui.FilterParser.Filter
 
getSubItemNoun() - Method in class io.jenkins.plugins.batchcontrol.action.JobActivationNoticeAction
D-82: what the sub-item is called, from its own pronoun ("configuration" for a matrix configuration, "module" for a Maven module).
getSubject() - Method in class io.jenkins.plugins.batchcontrol.ops.Notification
The job full name (run, activation) or the scope full name (grant).
getSummary() - Method in class io.jenkins.plugins.batchcontrol.action.HistorySection
The on-page monthly aggregate rows for HistorySection.getSummaryMonth().
getSummaryMonth() - Method in class io.jenkins.plugins.batchcontrol.action.HistorySection
The month shown in the on-page summary block and the JSON link: month of the filter end.
getTabs() - Method in class io.jenkins.plugins.batchcontrol.action.BatchControlRootAction
The tabs the viewer may open, with their open-item badges (overview page).
getTarget() - Method in class io.jenkins.plugins.batchcontrol.action.ActivationsSection
 
getTarget() - Method in class io.jenkins.plugins.batchcontrol.action.ChangesSection
 
getTarget() - Method in class io.jenkins.plugins.batchcontrol.action.DashboardSection
 
getTarget() - Method in class io.jenkins.plugins.batchcontrol.action.GrantsSection
 
getTarget() - Method in class io.jenkins.plugins.batchcontrol.action.HistorySection
 
getTarget() - Method in class io.jenkins.plugins.batchcontrol.action.IncidentsSection
 
getTarget() - Method in class io.jenkins.plugins.batchcontrol.action.RequestsSection
 
getTarget() - Method in class io.jenkins.plugins.batchcontrol.model.ChangeRecord
 
getTarget() - Method in class io.jenkins.plugins.batchcontrol.security.BatchControlMatrixCascConfigurator
 
getTarget() - Method in class io.jenkins.plugins.batchcontrol.security.BatchControlRoleBasedCascConfigurator
 
getText(AlternativeUiTextProvider.Message<T>, T) - Method in class io.jenkins.plugins.batchcontrol.action.RequestRunUiDecorator
 
getTitle() - Method in enum class io.jenkins.plugins.batchcontrol.ops.NotificationEvent
Short human-readable title used in plain-text messages.
getTitle() - Method in class io.jenkins.plugins.batchcontrol.ui.SectionTabs.Tab
The section's page title, the tab's tooltip when it differs from the short label ("Changes" opens "Change Records"), or null when it is the label.
getTo() - Method in class io.jenkins.plugins.batchcontrol.model.GrantRequest.ApproverChange
Compatibility view: the first member of the new set, or null.
getTo() - Method in class io.jenkins.plugins.batchcontrol.model.RunRequest.ApproverChange
Compatibility view: the first member of the new set, or null.
getToApprovers() - Method in class io.jenkins.plugins.batchcontrol.model.ActivationRequest.ApproverChange
The new designated set.
getToApprovers() - Method in class io.jenkins.plugins.batchcontrol.model.GrantRequest.ApproverChange
The new designated set.
getToApprovers() - Method in class io.jenkins.plugins.batchcontrol.model.RunRequest.ApproverChange
The new designated set.
getToError() - Method in class io.jenkins.plugins.batchcontrol.ui.FilterParser.Filter
e2e-04 FD-11: the refusal of the to date (or of a reversed range), or null.
getToInput() - Method in class io.jenkins.plugins.batchcontrol.ui.FilterParser.Filter
The to field's value for redisplay: what the user entered after a refusal.
getTotal() - Method in class io.jenkins.plugins.batchcontrol.action.ActivationsSection
Every visible request, for the empty state.
getTotal() - Method in class io.jenkins.plugins.batchcontrol.action.ChangesSection
Matching records read (a lower bound when ChangesSection.isTruncated()).
getTotal() - Method in class io.jenkins.plugins.batchcontrol.action.HistorySection
Matching records read (a lower bound when HistorySection.isTruncated()).
getTotal() - Method in class io.jenkins.plugins.batchcontrol.action.IncidentsSection
Matching incidents read (a lower bound when IncidentsSection.isTruncated()).
getToValue() - Method in class io.jenkins.plugins.batchcontrol.ui.FilterParser.Filter
 
getTransitions() - Method in class io.jenkins.plugins.batchcontrol.model.Incident
A defensive copy of the handling history, in append order.
getTriggerLock() - Method in class io.jenkins.plugins.batchcontrol.action.JobNoticesWidget
 
getType() - Method in class io.jenkins.plugins.batchcontrol.model.ChangeRecord
 
getType() - Method in class io.jenkins.plugins.batchcontrol.model.GrantScope
 
getUnreadable() - Method in class io.jenkins.plugins.batchcontrol.store.RecordPage
Lines among those read that could not be parsed (a torn or damaged line) and were therefore skipped.
getUrl() - Method in class io.jenkins.plugins.batchcontrol.action.RequestItem.RecentRun
Root-relative build URL (job/a/12/).
getUrl() - Method in class io.jenkins.plugins.batchcontrol.ops.Notification
Absolute link to the request page from the configured Jenkins URL, or null when none is configured.
getUrl() - Method in class io.jenkins.plugins.batchcontrol.ui.ReplayedRuns.Row
 
getUrlName() - Method in class io.jenkins.plugins.batchcontrol.action.BatchControlRootAction
null without any Batch Control permission: per Action.getUrlName() that makes the action unreachable, so the URL space answers 404 instead of disclosing it.
getUrlName() - Method in class io.jenkins.plugins.batchcontrol.action.ComputedFolderActivationAction
No URL of its own: the summary is rendered on the folder page, and the activation request form is its own action, JobActivationForm at <folder>/batch-control-activation/ (D-64).
getUrlName() - Method in class io.jenkins.plugins.batchcontrol.action.FolderCreateWindowAction
 
getUrlName() - Method in class io.jenkins.plugins.batchcontrol.action.FolderGrantRequestAction
The full-page form, relative to the folder's URL (see JobGrantRequestAction.getUrlName() for why it is relative and carries a single query parameter).
getUrlName() - Method in class io.jenkins.plugins.batchcontrol.action.JobActivationForm
null without BatchControl/Request: the form exposes the approver list, so its URL space is absent (404) rather than refused, the same rule as before D-64 (on a job BatchControl/Request; on a computed folder the service's predicate, Request and Item/Read).
getUrlName() - Method in class io.jenkins.plugins.batchcontrol.action.JobActivationNoticeAction
 
getUrlName() - Method in class io.jenkins.plugins.batchcontrol.action.JobGrantRequestAction
A link to the grant screen rather than a sub-URL of the job, written relative to the job's own URL (../../batch-control/grants/?... for job/<name>/).
getUrlName() - Method in class io.jenkins.plugins.batchcontrol.action.JobNoticesWidget
Core routes <job>/<urlName> to a widget before the job's actions, so the name must not be batch-control (the run request form).
getUrlName() - Method in class io.jenkins.plugins.batchcontrol.action.JobRequestAction
null without BatchControl/Request: per Action.getUrlName() that makes the action unreachable, so its whole URL space answers 404 (absent, not refused).
getUrlName() - Method in class io.jenkins.plugins.batchcontrol.action.JobTriggerLockAction
 
getUrlName() - Method in class io.jenkins.plugins.batchcontrol.action.RunApprovalNoticeAction
 
getUrlName() - Method in class io.jenkins.plugins.batchcontrol.config.BatchControlConfigurationLink
 
getUrlName() - Method in class io.jenkins.plugins.batchcontrol.queue.ApprovedRunAction
 
getUrlName() - Method in class io.jenkins.plugins.batchcontrol.ui.SectionTabs.Tab
Path below /batch-control/, ending in a slash; empty for the overview.
getUser() - Method in class io.jenkins.plugins.batchcontrol.action.GrantsSection.Row
The window holder, or the requester before there is a window.
getUser() - Method in class io.jenkins.plugins.batchcontrol.model.ChangeRecord
 
getUser() - Method in class io.jenkins.plugins.batchcontrol.model.Grant
 
getUser() - Method in class io.jenkins.plugins.batchcontrol.model.RunRecord
 
getUser() - Method in class io.jenkins.plugins.batchcontrol.queue.ReplayUnderGrantAction
 
getUser() - Method in class io.jenkins.plugins.batchcontrol.ui.FilterParser.Filter
 
getUser() - Method in class io.jenkins.plugins.batchcontrol.ui.GuardInfo.Changed
Holder of the window, the user whose save or creation was recorded.
getViewPermissions() - Method in class io.jenkins.plugins.batchcontrol.action.ActivationItem
Permissions for this screen's l:layout (the same set its section gate checks).
getViewPermissions() - Method in class io.jenkins.plugins.batchcontrol.action.ActivationsSection
Permissions for this screen's l:layout (the same set its section gate checks).
getViewPermissions() - Method in class io.jenkins.plugins.batchcontrol.action.ActiveGrantsSection
The bare /batch-control/grants/active/ URL has nothing to show: its index.jelly redirects to the grants index (hosting review: no doIndex).
getViewPermissions() - Method in class io.jenkins.plugins.batchcontrol.action.ActiveGrantsSection.Item
A GET of /batch-control/grants/active/<grantId>/ has no detail view: its index.jelly redirects to the grants index (hosting review: no doIndex).
getViewPermissions() - Method in class io.jenkins.plugins.batchcontrol.action.BatchControlRootAction
Permissions for the landing page's l:layout: any Batch Control permission.
getViewPermissions() - Method in class io.jenkins.plugins.batchcontrol.action.ChangesSection
Permissions for this screen's l:layout (the same set its section gate checks).
getViewPermissions() - Method in class io.jenkins.plugins.batchcontrol.action.DashboardSection
Permissions for this screen's l:layout (the same set its section gate checks).
getViewPermissions() - Method in class io.jenkins.plugins.batchcontrol.action.GrantRequestItem
Permissions for this screen's l:layout (the same set its section gate checks).
getViewPermissions() - Method in class io.jenkins.plugins.batchcontrol.action.GrantsSection
Permissions for this screen's l:layout (the same set its section gate checks).
getViewPermissions() - Method in class io.jenkins.plugins.batchcontrol.action.HistorySection
Permissions for this screen's l:layout (the same set its section gate checks).
getViewPermissions() - Method in class io.jenkins.plugins.batchcontrol.action.IncidentItem
Permissions for this screen's l:layout (the same set its section gate checks).
getViewPermissions() - Method in class io.jenkins.plugins.batchcontrol.action.IncidentsSection
Permissions for this screen's l:layout (the same set its section gate checks).
getViewPermissions() - Method in class io.jenkins.plugins.batchcontrol.action.JobActivationForm
Permissions for the form's l:layout.
getViewPermissions() - Method in class io.jenkins.plugins.batchcontrol.action.JobRequestAction
Permissions for the request form's l:layout.
getViewPermissions() - Method in class io.jenkins.plugins.batchcontrol.action.RequestItem
Permissions for this screen's l:layout (the same set its section gate checks).
getViewPermissions() - Method in class io.jenkins.plugins.batchcontrol.action.RequestsSection
Permissions for this screen's l:layout (the same set its section gate checks).
getWindows() - Method in class io.jenkins.plugins.batchcontrol.action.FolderCreateWindowAction
The viewer's active Create windows that cover new items in this folder: those naming its current full name (a window follows its folder through a rename or move, D-74 (3)).
governingJob(Job<?, ?>) - Static method in class io.jenkins.plugins.batchcontrol.policy.ActivationService
D-82: the job whose approval property governs job at the queue gate: the job itself, or for a sub-item the topmost job among its parents (a configuration's matrix project).
grant(NotificationEvent, GrantRequest) - Static method in class io.jenkins.plugins.batchcontrol.ops.NotificationDispatcher
Event for a change (grant) request.
grant(String) - Method in class io.jenkins.plugins.batchcontrol.ui.SectionAccess
Whether the grant request (or the grant, which has the same id) with this id may be linked (DEF-11): the Grants screen is open to the user AND the request is visible to them (P-09).
Grant - Class in io.jenkins.plugins.batchcontrol.model
An approved temporary permission (SPEC item 8, section 3): the result of an approved GrantRequest.
GRANT_EXPIRING - Enum constant in enum class io.jenkins.plugins.batchcontrol.ops.NotificationEvent
An active change window (grant) ends soon.
GRANT_REQUEST_BLOCKED - Enum constant in enum class io.jenkins.plugins.batchcontrol.model.ChangeType
A permission-window request or approval refused because change control is off (S-15).
GRANT_REVOKE - Enum constant in enum class io.jenkins.plugins.batchcontrol.model.ChangeType
 
GRANT_VIOLATION - Enum constant in enum class io.jenkins.plugins.batchcontrol.model.ChangeType
D-35b: a save by a user whose Item/Configure on the item came only from a grant changed the item's (or folder's) matrix-auth authorization property, and Batch Control put the previous property back.
GrantAction - Enum Class in io.jenkins.plugins.batchcontrol.model
The change actions a JIT grant can cover (SPEC item 8).
grantApproved(GrantRequest, String) - Static method in class io.jenkins.plugins.batchcontrol.ops.NotificationDispatcher
NotificationEvent.APPROVED for a change request, sent to its requester.
grantEnded(NotificationEvent, GrantRequest, boolean, String) - Static method in class io.jenkins.plugins.batchcontrol.ops.NotificationDispatcher
grantExpiring(Grant, GrantRequest) - Static method in class io.jenkins.plugins.batchcontrol.ops.NotificationDispatcher
NotificationEvent.GRANT_EXPIRING for an active window, sent to its holder.
grantIds() - Method in record class io.jenkins.plugins.batchcontrol.store.RetentionResult
Returns the value of the grantIds record component.
GrantLayer - Class in io.jenkins.plugins.batchcontrol.security
Entry points to the grant layer for code outside this package (D-35b, D-35c).
GrantLayeredStrategy - Interface in io.jenkins.plugins.batchcontrol.security
Implemented by the Batch Control authorization strategies, the subclasses of the supported strategies that layer active grants over the parent's ACLs (D-35a, ARCHITECTURE section 4).
GrantRequest - Class in io.jenkins.plugins.batchcontrol.model
A request for a temporary (JIT) change permission (SPEC item 8, section 3).
GrantRequest.ApproverChange - Class in io.jenkins.plugins.batchcontrol.model
One approver change entry of a grant request: (previous set, new set, changed by, at) (SPEC section 3, D-37).
GrantRequestItem - Class in io.jenkins.plugins.batchcontrol.action
One grant request at /batch-control/grants/<id>/: detail view plus the five state-changing POST endpoints (approve, reject, cancel, changeApprover and, for its open window, revoke — R4-12).
GrantRequestLinks - Class in io.jenkins.plugins.batchcontrol.ui
Links to the new grant request form on the Grants screen, prefilled for one item and one action (U-01 convention: new?scopeFullName=&actions=, D-66; D-71: a window names exactly one item, so there is no scope type).
grantRequests() - Method in record class io.jenkins.plugins.batchcontrol.store.RetentionResult
Returns the value of the grantRequests record component.
GrantRequestService - Class in io.jenkins.plugins.batchcontrol.policy
The single entry point for every GrantRequest state transition (SPEC items 3 and 8).
grantRequestUrl(String, String) - Method in class io.jenkins.plugins.batchcontrol.action.BatchControlRootAction
Root-relative URL of the new grant request form prefilled for the item and the action, or null when the viewer cannot see the item or it cannot carry a window.
GrantRequiredFailure - Exception Class in io.jenkins.plugins.batchcontrol.ui
The refusal of a change that needs a permission window the user does not hold (SPEC item 8), for example the delete veto (e2e-03 DEF-26).
GrantRequiredFailure(Item, GrantAction, String) - Constructor for exception class io.jenkins.plugins.batchcontrol.ui.GrantRequiredFailure
 
grantRevokeRecordsSince(Instant, Set<String>, Predicate<? super ChangeRecord>) - Method in class io.jenkins.plugins.batchcontrol.store.FileStore
S-39-03: every GRANT_REVOKE change record of a grant in grantIds with a time at or after since, newest first, for re-ending windows at startup (D-74).
grantRevokeRecordsSince(Instant, Set<String>, Predicate<? super ChangeRecord>) - Method in interface io.jenkins.plugins.batchcontrol.store.Store
S-39-03: every GRANT_REVOKE change record of a grant in grantIds with a time at or after since, newest first, for re-ending windows at startup (D-74).
grants() - Static method in class io.jenkins.plugins.batchcontrol.ui.SectionAccess
/batch-control/grants/**: grant requesters, approvers and managers.
GrantScope - Class in io.jenkins.plugins.batchcontrol.model
Target of a grant request / grant: exactly one item, a job or a folder of any kind (D-71, replaces the JOB, FOLDER and FOLDER_ONLY scopes of D-65).
GrantScope(GrantScope.Type, String) - Constructor for class io.jenkins.plugins.batchcontrol.model.GrantScope
 
GrantScope.Type - Enum Class in io.jenkins.plugins.batchcontrol.model
Scope kind.
GrantService - Class in io.jenkins.plugins.batchcontrol.security
Runtime authority on active grants (SPEC item 8).
GrantsSection - Class in io.jenkins.plugins.batchcontrol.action
The grant screens at /batch-control/grants/ (SPEC item 8, JIT permission requests).
GrantsSection() - Constructor for class io.jenkins.plugins.batchcontrol.action.GrantsSection
 
GrantsSection.Row - Class in io.jenkins.plugins.batchcontrol.action
One row of the Grants lists: a grant request and, once approved, its permission window (the window carries the request's id).
GrantViolationGuard - Class in io.jenkins.plugins.batchcontrol.listener
D-35b: a user whose Item/Configure comes only from a grant cannot turn it into a permanent authorization entry.
GrantViolationGuard() - Constructor for class io.jenkins.plugins.batchcontrol.listener.GrantViolationGuard
 
GrantViolationGuard.Baseline - Class in io.jenkins.plugins.batchcontrol.listener
Keeps the baseline in step with item lifecycle events, and applies the payload half of D-35c.
GROUP - Static variable in class io.jenkins.plugins.batchcontrol.security.BatchControlPermissions
The "Batch Control" permission group shown on the authorization matrix screen.
GUARD_REVIEWED - Enum constant in enum class io.jenkins.plugins.batchcontrol.model.ChangeType
An administrator or a native Configure holder marked an item as reviewed (D-58b): it and everything below it left the "changed under a grant" state.
GuardInfo - Class in io.jenkins.plugins.batchcontrol.ui
What the strategy monitor says about an item in the "changed under a grant" state (D-58a/b): which permission window recorded the change, and after "Mark as reviewed" what still guards the item.
GuardInfo.Changed - Class in io.jenkins.plugins.batchcontrol.ui
The permission window that recorded a change to an item (or to a folder above it).
GuardInfo.Outcome - Class in io.jenkins.plugins.batchcontrol.ui
What still guards an item after it was marked as reviewed.
guardingGrantId(String) - Method in class io.jenkins.plugins.batchcontrol.security.GrantService
D-58a: the id of a grant that makes the item guarded (one that lists it as changed, else an active one covering it), or null when it is not guarded.

H

handle(Item, ItemGroup<?>, AtomicReference<Item>, List<? extends RelocationHandler>) - Method in class io.jenkins.plugins.batchcontrol.security.ChangeControlledRelocationHandler
 
hasActivationRequestBy(String) - Method in class io.jenkins.plugins.batchcontrol.store.FileStore
 
hasActivationRequestBy(String) - Method in interface io.jenkins.plugins.batchcontrol.store.Store
Whether at least one stored activation or hold request, in any status, was filed by userId (D-38b).
hasActiveGrant(String, String, Permission) - Method in class io.jenkins.plugins.batchcontrol.security.GrantService
Whether user currently holds permission on the item named itemFullName through an active grant.
hasAny(Permission[]) - Static method in class io.jenkins.plugins.batchcontrol.ui.SectionAccess
Whether the current user holds at least one of permissions on Jenkins.
hasChanged(String) - Method in class io.jenkins.plugins.batchcontrol.model.Grant
Whether itemFullName was changed under this grant and not reviewed since (D-58a).
hasConfigSnapshot(String) - Method in class io.jenkins.plugins.batchcontrol.store.FileStore
 
hasConfigSnapshot(String) - Method in interface io.jenkins.plugins.batchcontrol.store.Store
Whether anything is stored where the config snapshot of a job belongs: a snapshot, or something else in its place (which Store.loadConfigSnapshot(java.lang.String) refuses).
hasCreated(String) - Method in class io.jenkins.plugins.batchcontrol.model.Grant
Whether itemFullName was created through this grant's Create (D-35c).
hashCode() - Method in class io.jenkins.plugins.batchcontrol.model.GrantScope
 
hashCode() - Method in class io.jenkins.plugins.batchcontrol.model.ItemKind
 
hashCode() - Method in class io.jenkins.plugins.batchcontrol.model.PendingCount
 
hashCode() - Method in class io.jenkins.plugins.batchcontrol.queue.ApprovedCause
 
hashCode() - Method in record class io.jenkins.plugins.batchcontrol.store.IncidentSummary
Returns a hash code value for this object.
hashCode() - Method in record class io.jenkins.plugins.batchcontrol.store.Period
Returns a hash code value for this object.
hashCode() - Method in record class io.jenkins.plugins.batchcontrol.store.RequestSummary
Returns a hash code value for this object.
hashCode() - Method in record class io.jenkins.plugins.batchcontrol.store.RetentionResult
Returns a hash code value for this object.
hashCode() - Method in record class io.jenkins.plugins.batchcontrol.store.RunMonthStats
Returns a hash code value for this object.
hasMissedInvalidation(String) - Method in class io.jenkins.plugins.batchcontrol.policy.RunRequestService
Whether request id missed a D-21 invalidation because its file could not be read or written (RunRequestService.invalidateForJob(java.lang.String, java.lang.String)); its queued run, if any, is cancelled like that of an invalidated request.
hasMissedInvalidations() - Method in class io.jenkins.plugins.batchcontrol.policy.RunRequestService
Whether any request missed a D-21 invalidation (RunRequestService.hasMissedInvalidation(java.lang.String)).
hasNext(int, int) - Static method in class io.jenkins.plugins.batchcontrol.ui.Paging
Whether an older page exists for a list of total rows.
hasOwnRequests(Authentication) - Method in class io.jenkins.plugins.batchcontrol.policy.ActivationService
D-38b: whether auth filed at least one activation or hold request, in any status (the requester always sees their own, P-09).
hasOwnRequests(Authentication) - Method in class io.jenkins.plugins.batchcontrol.policy.RunRequestService
D-38b: whether auth filed at least one run request, in any status.
hasPermissionWithoutGrants(AccessControlled, Authentication, Permission) - Static method in class io.jenkins.plugins.batchcontrol.security.GrantLayer
Whether a holds permission on object without any grant: the answer of the installed strategy alone, with every grant layer switched off on this thread for the duration of the check (inherited ACLs included).
hasPrevious(int) - Static method in class io.jenkins.plugins.batchcontrol.ui.Paging
Whether a newer page exists (every page after the first).
hasRunRequestBy(String) - Method in class io.jenkins.plugins.batchcontrol.store.FileStore
 
hasRunRequestBy(String) - Method in interface io.jenkins.plugins.batchcontrol.store.Store
Whether at least one stored run request, in any status, was filed by userId (D-38b).
held(String, String, Instant, String) - Static method in class io.jenkins.plugins.batchcontrol.model.ActivationState
A never-activated job put on hold (a HOLD approved for a job without a stored state).
HELD - Enum constant in enum class io.jenkins.plugins.batchcontrol.model.ChangeType
A job was put on hold (SPEC item 6a): a HOLD request was approved, so timer and upstream causes no longer run it.
heldBy(String, Instant, String) - Method in class io.jenkins.plugins.batchcontrol.model.ActivationState
This state put on hold by by through requestId: not activated, keeping who activated it last for the record.
history() - Static method in class io.jenkins.plugins.batchcontrol.ui.SectionAccess
Changes, dashboard, incidents and history: ViewHistory.
HistorySection - Class in io.jenkins.plugins.batchcontrol.action
The history browser at /batch-control/history/ (SPEC item 12): filtered listings of run records, incidents, change records and run requests, a monthly aggregate JSON endpoint, and CSV exports.
HistorySection() - Constructor for class io.jenkins.plugins.batchcontrol.action.HistorySection
 
HOLD - Enum constant in enum class io.jenkins.plugins.batchcontrol.model.ActivationRequest.Action
Put the job on hold: timer and upstream causes no longer run it.
holdAfterMove(Item, String, String) - Method in class io.jenkins.plugins.batchcontrol.policy.ActivationService
D-59a (SPEC 6a): item was moved from oldFullName by mover, a user without Overall/Administer, while run control and change control were on.
holdEpoch(Item) - Method in class io.jenkins.plugins.batchcontrol.policy.ActivationService
e2e-04 FD-07, security-25 S-25-03: the part of a refusal record's coalescing key that changes when the item's activation ends: never-activated, held-<epoch millis>, or unknown when the state cannot be read.
howEnded(GrantsSection.Row) - Method in class io.jenkins.plugins.batchcontrol.action.GrantsSection
How a row ended, in words: the window's end, else the request's outcome.
HttpVerbs - Class in io.jenkins.plugins.batchcontrol.ui
HTTP verb guard for the Batch Control URL spaces.

I

id() - Method in record class io.jenkins.plugins.batchcontrol.store.IncidentSummary
Returns the value of the id record component.
id() - Method in record class io.jenkins.plugins.batchcontrol.store.RequestSummary
Returns the value of the id record component.
ID - Static variable in class io.jenkins.plugins.batchcontrol.ops.BatchControlStrategyMonitor
The monitor id, also its URL segment under /administrativeMonitor/.
Ids - Class in io.jenkins.plugins.batchcontrol.store
Generates store identifiers.
impliedByList(Permission) - Method in class io.jenkins.plugins.batchcontrol.security.BatchControlRoleBasedAuthorizationStrategy.DescriptorImpl
The space-separated ids of the permissions implying p.
Incident - Class in io.jenkins.plugins.batchcontrol.model
An automatically registered error case (SPEC items 11 and section 3): opened for every build whose result is in the configured incidentResults, then handled by people (OPEN -> ACKNOWLEDGED -> RESOLVED).
Incident(String, String, String, String, Instant) - Constructor for class io.jenkins.plugins.batchcontrol.model.Incident
 
incidentCreatedAt(Incident) - Method in class io.jenkins.plugins.batchcontrol.action.HistorySection
Creation timestamp of an incident.
IncidentItem - Class in io.jenkins.plugins.batchcontrol.action
One incident at /batch-control/incidents/<id>/ (SPEC item 11): detail view plus the four state-changing POST endpoints (acknowledge, resolve, comment, rerun).
incidentRunUrl(Incident) - Method in class io.jenkins.plugins.batchcontrol.action.HistorySection
Root-relative build URL for an incident's originating run, or null for plain text (D-44).
IncidentService - Class in io.jenkins.plugins.batchcontrol.ops
The single entry point for every Incident lifecycle operation (SPEC item 11, D-10, D-19): automatic registration from completed builds, forward-only handling transitions (OPEN -> ACKNOWLEDGED -> RESOLVED), comments, rerun requests and the automatic resolvedByRunId link.
IncidentsSection - Class in io.jenkins.plugins.batchcontrol.action
The incident list at /batch-control/incidents/ (SPEC item 11).
IncidentsSection() - Constructor for class io.jenkins.plugins.batchcontrol.action.IncidentsSection
 
IncidentStatus - Enum Class in io.jenkins.plugins.batchcontrol.model
Handling state of an Incident (SPEC section 4): OPEN -> ACKNOWLEDGED -> RESOLVED, forward-only.
IncidentSummary - Record Class in io.jenkins.plugins.batchcontrol.store
One line of the monthly incident index (incidents/index/YYYY-MM.jsonl).
IncidentSummary(String, String, String, String, Instant) - Constructor for record class io.jenkins.plugins.batchcontrol.store.IncidentSummary
Creates an instance of a IncidentSummary record class.
IncidentTransition - Class in io.jenkins.plugins.batchcontrol.model
One entry of an Incident's handling history (SPEC item 11): a status transition ({status, by, at, comment}) or a plain comment (recorded against the incident's status at the time, without changing it).
IncidentTransition(IncidentStatus, String, Instant, String) - Constructor for class io.jenkins.plugins.batchcontrol.model.IncidentTransition
 
includes(String) - Method in class io.jenkins.plugins.batchcontrol.model.GrantScope
Whether the given item full name is the scope item: an exact full-name match (D-71).
initialize() - Static method in class io.jenkins.plugins.batchcontrol.security.BatchControlPermissions
Forces this class to initialize during Jenkins startup so the permission group is registered before any authorization strategy screen enumerates permission groups.
inRange(Instant) - Method in class io.jenkins.plugins.batchcontrol.ui.FilterParser.Filter
Whether the timestamp lies inside the [from, to] date range; null never matches.
invalidateCache() - Static method in class io.jenkins.plugins.batchcontrol.ops.ConfigureWithoutGrantMonitor
Drops the cached scan (called on a change-control toggle; next render recomputes).
INVALIDATED - Enum constant in enum class io.jenkins.plugins.batchcontrol.model.RequestStatus
 
INVALIDATED - Enum constant in enum class io.jenkins.plugins.batchcontrol.ops.NotificationEvent
A request was invalidated (D-54), for example because its job was renamed or deleted.
invalidateForDeletedItem(String, boolean) - Method in class io.jenkins.plugins.batchcontrol.policy.RunRequestService
#38: an item was deleted.
invalidateForJob(String, String) - Method in class io.jenkins.plugins.batchcontrol.policy.RunRequestService
Invalidates every PENDING/APPROVED request that targets the given (old) job full name after a rename or move (D-21).
io.jenkins.plugins.batchcontrol - package io.jenkins.plugins.batchcontrol
 
io.jenkins.plugins.batchcontrol.action - package io.jenkins.plugins.batchcontrol.action
 
io.jenkins.plugins.batchcontrol.config - package io.jenkins.plugins.batchcontrol.config
 
io.jenkins.plugins.batchcontrol.listener - package io.jenkins.plugins.batchcontrol.listener
 
io.jenkins.plugins.batchcontrol.model - package io.jenkins.plugins.batchcontrol.model
 
io.jenkins.plugins.batchcontrol.ops - package io.jenkins.plugins.batchcontrol.ops
 
io.jenkins.plugins.batchcontrol.policy - package io.jenkins.plugins.batchcontrol.policy
 
io.jenkins.plugins.batchcontrol.queue - package io.jenkins.plugins.batchcontrol.queue
 
io.jenkins.plugins.batchcontrol.security - package io.jenkins.plugins.batchcontrol.security
 
io.jenkins.plugins.batchcontrol.store - package io.jenkins.plugins.batchcontrol.store
 
io.jenkins.plugins.batchcontrol.ui - package io.jenkins.plugins.batchcontrol.ui
 
isActivated() - Method in class io.jenkins.plugins.batchcontrol.action.ComputedFolderActivationAction
 
isActivated() - Method in class io.jenkins.plugins.batchcontrol.action.JobActivationForm
Whether the job may run on timer and upstream triggers as far as activation is concerned.
isActivated() - Method in class io.jenkins.plugins.batchcontrol.action.JobActivationNoticeAction
 
isActivated() - Method in class io.jenkins.plugins.batchcontrol.model.ActivationState
 
isActivated() - Method in class io.jenkins.plugins.batchcontrol.ops.BatchControlStrategyMonitor
Shows while change control is on and either the installed strategy is not a Batch Control strategy (BatchControlStrategyMonitor.isStrategyUnsupported()) or builds run as SYSTEM (BatchControlStrategyMonitor.isBuildAuthenticatorMissing()).
isActivated() - Method in class io.jenkins.plugins.batchcontrol.ops.ConfigureWithoutGrantMonitor
 
isActivated(Item) - Method in class io.jenkins.plugins.batchcontrol.policy.ActivationService
Whether an approved activation is stored for this very item.
isActivated(Item) - Static method in class io.jenkins.plugins.batchcontrol.ui.ActivationView
Whether an activated state is stored for this very item (the service's truthful read).
isActivated(Job<?, ?>) - Method in class io.jenkins.plugins.batchcontrol.policy.ActivationService
isActivationLocked() - Method in class io.jenkins.plugins.batchcontrol.config.BatchControlJobProperty
Whether these settings already are the activation lock, so that applying it again would cost the job a property rebuild and a save (S-20) and change nothing.
isActivations() - Method in class io.jenkins.plugins.batchcontrol.ui.SectionAccess
Whether the Activations screen (and its detail pages) may be linked for this user.
isActivationSchemaMarked() - Method in class io.jenkins.plugins.batchcontrol.store.FileStore
 
isActivationSchemaMarked() - Method in interface io.jenkins.plugins.batchcontrol.store.Store
Whether the one-time upgrade seeding marker activations/.schema exists.
isActive() - Method in class io.jenkins.plugins.batchcontrol.action.JobRequestAction
True when run control is on and this job requires approved runs.
isActiveAt(Instant) - Method in class io.jenkins.plugins.batchcontrol.model.Grant
Whether the grant confers its permissions at the given instant: not yet expired (strictly before expiresAt — the first check at or past the expiry instant is already denied) and not revoked.
isAllowAdminSelfApproval() - Method in class io.jenkins.plugins.batchcontrol.config.BatchControlGlobalConfiguration
 
isApplicable(Run) - Method in class io.jenkins.plugins.batchcontrol.policy.ApprovalRebuildValidator
 
isApplicable(Class<? extends Job>) - Method in class io.jenkins.plugins.batchcontrol.config.BatchControlJobProperty.DescriptorImpl
 
isApprovalRequired() - Method in class io.jenkins.plugins.batchcontrol.action.JobActivationNoticeAction
e2e-03 DEF-01 (SPEC item 6): whether the "manual runs need an approved request" notice is rendered.
isApprovalRequired() - Method in class io.jenkins.plugins.batchcontrol.config.BatchControlJobProperty
 
isAwaitingExecution() - Method in class io.jenkins.plugins.batchcontrol.action.RequestItem
Whether the request is approved but its build has not been recorded yet (UX-10).
isAwaitingMyDecision(ActivationRequest) - Method in class io.jenkins.plugins.batchcontrol.action.ActivationsSection
Whether the viewer is a designated approver of this pending request (the Activations tab badge's predicate), so its row says "awaiting your decision".
isBlockTimer() - Method in class io.jenkins.plugins.batchcontrol.config.BatchControlJobProperty
 
isBlockUpstream() - Method in class io.jenkins.plugins.batchcontrol.config.BatchControlJobProperty
 
isBuildAuthenticatorMissing() - Method in class io.jenkins.plugins.batchcontrol.ops.BatchControlStrategyMonitor
Condition 2 (D-35d (2), S-02): change control is on and no QueueItemAuthenticator is configured, so builds run as SYSTEM.
isBuildsMayRunAsSystem() - Method in class io.jenkins.plugins.batchcontrol.ops.BatchControlStrategyMonitor
Condition 3 (D-50, D-50a): with change control on, a build of a job without its own build authorization and without a user cause would run as SYSTEM under the configured build authenticators (for example Authorize Project per-project, or a strategy that follows the triggering user).
isCanAcknowledge() - Method in class io.jenkins.plugins.batchcontrol.action.IncidentItem
View gating only; the service re-validates the state machine.
isCanCancel() - Method in class io.jenkins.plugins.batchcontrol.action.ActivationItem
View gating for the cancel link; the service enforces requester-or-Manage.
isCanCancel() - Method in class io.jenkins.plugins.batchcontrol.action.GrantRequestItem
View gating for the cancel link; the service enforces requester-or-Manage.
isCanCancel() - Method in class io.jenkins.plugins.batchcontrol.action.RequestItem
View gating for the cancel link; the service enforces requester-or-Manage.
isCanChangeApprover() - Method in class io.jenkins.plugins.batchcontrol.action.ActivationItem
View gating for the change-approver form; the service enforces requester-only.
isCanChangeApprover() - Method in class io.jenkins.plugins.batchcontrol.action.GrantRequestItem
View gating for the change-approver form; the service enforces requester-only.
isCanChangeApprover() - Method in class io.jenkins.plugins.batchcontrol.action.RequestItem
View gating for the change-approver form; the service enforces requester-only.
isCanComment() - Method in class io.jenkins.plugins.batchcontrol.action.IncidentItem
Comments stay possible in every state (SPEC section 4: RESOLVED still takes comments).
isCanConfigure() - Method in class io.jenkins.plugins.batchcontrol.action.JobTriggerLockAction
Whether the viewer may open the job configuration, so the notice links to it.
isCanDecide() - Method in class io.jenkins.plugins.batchcontrol.action.ActivationItem
View gating for the decision forms: a designated approver holding Approve (D-29, D-37).
isCanDecide() - Method in class io.jenkins.plugins.batchcontrol.action.GrantRequestItem
View gating for the approve/reject forms: only a member of the designated set sees them (D-29, D-37).
isCanDecide() - Method in class io.jenkins.plugins.batchcontrol.action.RequestItem
View gating for the approve/reject forms: only a member of the designated set sees them (D-29, D-37).
isCanManage() - Method in class io.jenkins.plugins.batchcontrol.config.BatchControlConfigurationLink
Whether the current user may open and save this page.
isCanRenew(GrantsSection.Row) - Method in class io.jenkins.plugins.batchcontrol.action.GrantsSection
Whether the re-request button is shown: the caller's own ended window, and may request.
isCanRequest() - Method in class io.jenkins.plugins.batchcontrol.action.ComputedFolderActivationAction
D-38b: Request (and Item/Read) on this folder, the service's predicate.
isCanRequest() - Method in class io.jenkins.plugins.batchcontrol.action.GrantsSection
isCanRequest() - Method in class io.jenkins.plugins.batchcontrol.action.JobActivationNoticeAction
Whether the viewer may open the activation request form (BatchControl/Request).
isCanRequest() - Method in class io.jenkins.plugins.batchcontrol.action.RunApprovalNoticeAction
Whether the viewer holds BatchControl/Request.
isCanRequest() - Method in exception class io.jenkins.plugins.batchcontrol.ui.ApprovalRequiredFailure
Whether the page links the request form: the viewer may submit a run request for the job (BatchControl/Request, without which <job>/batch-control/ answers 404, and Item/Read; Item/Build is not required, D-38a).
isCanRequest() - Method in exception class io.jenkins.plugins.batchcontrol.ui.GrantRequiredFailure
Whether the refused user may request the window and a window can allow the change (D-71), so the page links the form.
isCanRequestGrants() - Method in class io.jenkins.plugins.batchcontrol.action.BatchControlRootAction
For refusal pages outside this action (reached through app.getExtensionList, since j:invokeStatic cannot load plugin classes): whether the viewer may open the Grants screen and submit a grant request.
isCanRequestRun() - Method in class io.jenkins.plugins.batchcontrol.action.JobActivationNoticeAction
Whether the viewer may submit a run request for this job, so the run request form is linked (e2e-03 DEF-12): BatchControl/Request and Item/Read on the job (D-38a), the same predicate as the sidebar entry.
isCanRequestRun() - Method in class io.jenkins.plugins.batchcontrol.action.JobRequestAction
Whether the current user may submit a run request for this job: BatchControl/Request and Item/Read on the job (D-38a; Item/Build is not required), the checks RunRequestService.create(hudson.model.Job<?, ?>, java.util.List<hudson.model.ParameterValue>, java.lang.String, java.lang.String) makes.
isCanRequestRun() - Method in class io.jenkins.plugins.batchcontrol.action.RunApprovalNoticeAction
Whether the run request form is linked (JobActivationNoticeAction.isCanRequestRun()).
isCanRerun() - Method in class io.jenkins.plugins.batchcontrol.action.IncidentItem
View gating for the rerun form (e2e-03 DEF-12): BatchControl/Request and Item/Read on the incident's job, the permissions a run request needs (D-38a; Item/Build is not required).
isCanResolve() - Method in class io.jenkins.plugins.batchcontrol.action.IncidentItem
View gating only; the service re-validates the state machine.
isCanRevoke() - Method in class io.jenkins.plugins.batchcontrol.action.GrantRequestItem
R4-12: view gating for the Revoke button of this page, the rule of the Grants list's Revoke (BatchControl/Manage); GrantRequestItem.doRevoke(org.kohsuke.stapler.StaplerRequest2, org.kohsuke.stapler.StaplerResponse2) and the service re-check.
isCanRevoke() - Method in class io.jenkins.plugins.batchcontrol.action.GrantsSection
View gating for the Revoke buttons; the revoke endpoint re-checks for real.
isCarrierReadable() - Method in class io.jenkins.plugins.batchcontrol.action.JobActivationForm
S-14-02: whether the viewer holds Item/Read on the carrier, so its name may be shown; otherwise the view renders a neutral line.
isChangeControlEnabled() - Method in class io.jenkins.plugins.batchcontrol.action.JobTriggerLockAction
Whether change control is on, so clearing a switch needs a permission window.
isChangeControlEnabled() - Method in class io.jenkins.plugins.batchcontrol.config.BatchControlGlobalConfiguration
 
isChangedUnderGrant(Item) - Method in class io.jenkins.plugins.batchcontrol.security.GrantService
D-58b: whether the item, or an item above it, is in the "changed under a grant" state (any grant, active or ended).
isCompletedForCurrentSession() - Static method in class io.jenkins.plugins.batchcontrol.ops.StartupRecovery
Whether recovery has completed for the currently running Jenkins instance.
isComputedChild(Item) - Static method in class io.jenkins.plugins.batchcontrol.policy.ActivationService
D-32: a job its parent computes for itself (a multibranch branch job, an organization folder's repositories) is not controlled and needs no activation.
isCreateMissing() - Method in exception class io.jenkins.plugins.batchcontrol.security.MoveRefusal
Whether the refusal lacks Item/Create on the destination, either entirely or because the active Create window's name restriction does not admit the item's name; a Create window on MoveRefusal.getDestinationFullName() that admits the name would supply it.
isCurrent(ConfigSnapshotListener.Refresh) - Static method in class io.jenkins.plugins.batchcontrol.listener.ConfigSnapshotListener
Whether refresh is still the current one (no newer refresh started and none was ended).
isDelete() - Method in exception class io.jenkins.plugins.batchcontrol.ui.GrantRequiredFailure
Whether the refused change is a delete (the page then says "delete (or move) it").
isDeleteMissing() - Method in exception class io.jenkins.plugins.batchcontrol.security.MoveRefusal
Whether the refusal lacks Item/Delete on the item and a Delete window on the item would supply it.
isDesignated(String) - Method in class io.jenkins.plugins.batchcontrol.action.ActivationItem
Whether the change-approver picker starts with this candidate checked.
isDesignated(String) - Method in class io.jenkins.plugins.batchcontrol.action.GrantRequestItem
Whether the change-approver picker starts with this candidate checked.
isDesignated(String) - Method in class io.jenkins.plugins.batchcontrol.action.RequestItem
Whether the change-approver picker starts with this candidate checked: the current members, so the form edits the set rather than retyping it.
isDesignatedApprover(String) - Method in class io.jenkins.plugins.batchcontrol.model.ActivationRequest
Whether userId is a member of the designated set.
isDesignatedApprover(String) - Method in class io.jenkins.plugins.batchcontrol.model.GrantRequest
Whether userId is a member of the designated set.
isDesignatedApprover(String) - Method in class io.jenkins.plugins.batchcontrol.model.RunRequest
Whether userId is a member of the designated set.
isEmailNotifications() - Method in class io.jenkins.plugins.batchcontrol.config.BatchControlGlobalConfiguration
 
isEmpty() - Method in class io.jenkins.plugins.batchcontrol.model.PendingCount
 
isEmpty() - Method in record class io.jenkins.plugins.batchcontrol.store.RetentionResult
Whether anything was deleted.
isEmpty() - Method in class io.jenkins.plugins.batchcontrol.ui.FormErrors
Whether anything was refused.
isExpiringNotified() - Method in class io.jenkins.plugins.batchcontrol.model.ActivationRequest
 
isExpiringNotified() - Method in class io.jenkins.plugins.batchcontrol.model.Grant
Whether the D-36 GRANT_EXPIRING notification was already sent.
isExpiringNotified() - Method in class io.jenkins.plugins.batchcontrol.model.GrantRequest
Whether the D-36 EXPIRING notification was already sent.
isExpiringNotified() - Method in class io.jenkins.plugins.batchcontrol.model.RunRequest
Whether the D-36 EXPIRING notification was already sent.
isFile(ParameterValue) - Static method in class io.jenkins.plugins.batchcontrol.store.ParameterDisplay
Whether value is a file value (see the class description).
isFileDefinition(ParameterDefinition) - Static method in class io.jenkins.plugins.batchcontrol.store.FileParametersSupport
Whether definition is one of the plugin's file definitions (stashedFile, base64File).
isFileDefinition(ParameterDefinition) - Static method in class io.jenkins.plugins.batchcontrol.ui.RequestRunPrefill
Whether definition takes a file: core's FileParameterDefinition or a definition of the optional file-parameters plugin (stashedFile, base64File; through FileParametersSupport.isFileDefinition(hudson.model.ParameterDefinition)).
isFileValue(ParameterValue) - Static method in class io.jenkins.plugins.batchcontrol.store.FileParametersSupport
Whether value is one of the plugin's file values (stashedFile, base64File).
isFolder() - Method in class io.jenkins.plugins.batchcontrol.action.JobActivationForm
Whether the target is a computed folder rather than a job (the view words it accordingly).
isGrantLayered(AuthorizationStrategy) - Static method in class io.jenkins.plugins.batchcontrol.security.GrantLayer
Whether strategy is a Batch Control strategy (layers grants over its parent).
isGrants() - Method in class io.jenkins.plugins.batchcontrol.ui.SectionAccess
Whether the Grants screen may be linked: the permission gate, and change control on (the subtree refuses every request while it is off, P-15).
isGroup() - Method in class io.jenkins.plugins.batchcontrol.ops.ConfigureWithoutGrantMonitor.StandingHolder
true for a security-realm group (including authenticated), else a user.
isGroup() - Method in exception class io.jenkins.plugins.batchcontrol.ui.GrantRequiredFailure
Whether the item contains other items, for the page's wording of a refused delete.
isGuardedItem(String) - Method in class io.jenkins.plugins.batchcontrol.security.GrantService
D-58a: whether the item is guarded: covered by an active grant (its scope includes the item, the scope lies below the item when the item is a folder, or the item was created through it), or changed under a grant (active or ended) and not reviewed since.
isHasActiveNext() - Method in class io.jenkins.plugins.batchcontrol.action.ActivationsSection
 
isHasActiveNext() - Method in class io.jenkins.plugins.batchcontrol.action.GrantsSection
 
isHasActiveNext() - Method in class io.jenkins.plugins.batchcontrol.action.RequestsSection
 
isHasActivePrevious() - Method in class io.jenkins.plugins.batchcontrol.action.ActivationsSection
 
isHasActivePrevious() - Method in class io.jenkins.plugins.batchcontrol.action.GrantsSection
 
isHasActivePrevious() - Method in class io.jenkins.plugins.batchcontrol.action.RequestsSection
 
isHasEndedNext() - Method in class io.jenkins.plugins.batchcontrol.action.ActivationsSection
 
isHasEndedNext() - Method in class io.jenkins.plugins.batchcontrol.action.GrantsSection
 
isHasEndedNext() - Method in class io.jenkins.plugins.batchcontrol.action.RequestsSection
 
isHasEndedPrevious() - Method in class io.jenkins.plugins.batchcontrol.action.ActivationsSection
 
isHasEndedPrevious() - Method in class io.jenkins.plugins.batchcontrol.action.GrantsSection
 
isHasEndedPrevious() - Method in class io.jenkins.plugins.batchcontrol.action.RequestsSection
 
isHasNext() - Method in class io.jenkins.plugins.batchcontrol.action.ChangesSection
 
isHasNext() - Method in class io.jenkins.plugins.batchcontrol.action.HistorySection
 
isHasNext() - Method in class io.jenkins.plugins.batchcontrol.action.IncidentsSection
 
isHasNext() - Method in class io.jenkins.plugins.batchcontrol.store.RecordPage
Whether a further page of matches exists among the records read.
isHasNextMonth() - Method in class io.jenkins.plugins.batchcontrol.action.ChangesSection
Whether a next-month link makes sense (no records exist in the future).
isHasNextMonth() - Method in class io.jenkins.plugins.batchcontrol.action.IncidentsSection
Whether a next-month link makes sense (no incidents exist in the future).
isHasPendingNext() - Method in class io.jenkins.plugins.batchcontrol.action.ActivationsSection
 
isHasPendingNext() - Method in class io.jenkins.plugins.batchcontrol.action.GrantsSection
 
isHasPendingNext() - Method in class io.jenkins.plugins.batchcontrol.action.RequestsSection
 
isHasPendingPrevious() - Method in class io.jenkins.plugins.batchcontrol.action.ActivationsSection
 
isHasPendingPrevious() - Method in class io.jenkins.plugins.batchcontrol.action.GrantsSection
 
isHasPendingPrevious() - Method in class io.jenkins.plugins.batchcontrol.action.RequestsSection
 
isHasPrevious() - Method in class io.jenkins.plugins.batchcontrol.action.ChangesSection
 
isHasPrevious() - Method in class io.jenkins.plugins.batchcontrol.action.HistorySection
 
isHasPrevious() - Method in class io.jenkins.plugins.batchcontrol.action.IncidentsSection
 
isHeld() - Method in class io.jenkins.plugins.batchcontrol.action.ComputedFolderActivationAction
 
isHeld() - Method in class io.jenkins.plugins.batchcontrol.action.JobActivationForm
Whether an approved hold took the job out of service (as opposed to never activated).
isHeld() - Method in class io.jenkins.plugins.batchcontrol.action.JobActivationNoticeAction
Whether an approved hold took the job out of service (as opposed to never activated).
isHeld(Item) - Static method in class io.jenkins.plugins.batchcontrol.ui.ActivationView
Whether an approved hold took the item out of service (as opposed to never activated).
isHistory() - Method in class io.jenkins.plugins.batchcontrol.ui.SectionAccess
Whether the ViewHistory screens (changes, dashboard, incidents, history) may be linked.
isHold() - Method in class io.jenkins.plugins.batchcontrol.action.ActivationItem
Whether the request asks to put the job on hold (the view words the decision accordingly).
isId(String) - Static method in class io.jenkins.plugins.batchcontrol.store.PathCodec
Whether id has the shape of a store identifier: ASCII letters, digits and - only, at most 128 characters.
isInputKept() - Method in class io.jenkins.plugins.batchcontrol.ui.FormErrors
Whether the refused form is shown with the user's input (FormErrors.value(java.lang.String), FormErrors.checked(java.lang.String, java.lang.String)): something was refused and the input could be read (FormErrors.withoutInput()).
isInstalled() - Static method in class io.jenkins.plugins.batchcontrol.store.FileParametersSupport
Whether the file-parameters plugin is installed and active.
isJobAvailable() - Method in class io.jenkins.plugins.batchcontrol.action.IncidentItem
Whether the incident's job still exists and is visible, so a rerun is possible at all.
isJobDisabled() - Method in class io.jenkins.plugins.batchcontrol.action.RequestItem
D-55 (SPEC item 3): whether the request's job is disabled, so the decision form says to enable it first and offers no Approve button, and an approved request says that it waits.
isLinked() - Method in class io.jenkins.plugins.batchcontrol.action.GrantsSection.Row
Whether the row links to a detail page (/batch-control/grants/<id>/).
isListedApprover(String) - Static method in class io.jenkins.plugins.batchcontrol.policy.ApprovalPolicy
Whether the user id is on the global approver list.
isMailerAvailable() - Method in class io.jenkins.plugins.batchcontrol.config.BatchControlGlobalConfiguration
Whether the Mailer plugin is installed and active; the configuration page shows the emailNotifications option only then (D-36).
isMigratable() - Method in class io.jenkins.plugins.batchcontrol.ops.BatchControlStrategyMonitor
Whether the installed strategy can be copied into a Batch Control subclass (for the view).
isMigratable(AuthorizationStrategy) - Static method in class io.jenkins.plugins.batchcontrol.security.StrategyMigration
Whether strategy is exactly one of the plain strategies the migration action copies: matrix-auth's project matrix or global matrix, or role-strategy's class.
isMoved() - Method in class io.jenkins.plugins.batchcontrol.ui.ScopeDisplay
Whether the item was renamed or moved where the viewer may not read it, so the screen shows ScopeDisplay.getFullName() (the approved name) with the fixed note instead of the current name.
isMultipart(StaplerRequest2) - Static method in class io.jenkins.plugins.batchcontrol.ui.RepeatedField
Whether Stapler reads this request's fields from a parsed multipart body (its own test).
isNameHidden() - Method in class io.jenkins.plugins.batchcontrol.ui.ScopeDisplay
Whether no name can be shown at all (a moved window whose request is no longer stored).
isOpen() - Method in record class io.jenkins.plugins.batchcontrol.store.RequestSummary
PENDING or APPROVED: the only statuses the expiry, recovery and invalidation work acts on.
isOwnedByCurrentUser() - Method in class io.jenkins.plugins.batchcontrol.action.GrantRequestItem
Whether the current user is the requester (view gating only; the service re-checks).
isPageAvailable() - Method in class io.jenkins.plugins.batchcontrol.config.BatchControlConfigurationLink
Whether the page's view exists (Jelly: the Batch Control page links here only then).
isParentOf(String) - Method in class io.jenkins.plugins.batchcontrol.model.GrantScope
D-35c (as amended by D-71): whether the scope item is the parent of itemFullName, i.e.
isPartOfJob() - Method in exception class io.jenkins.plugins.batchcontrol.ui.GrantRequiredFailure
Whether the item is part of a job (no window can name it), for the page's wording.
isPattern(Grant) - Method in class io.jenkins.plugins.batchcontrol.action.FolderCreateWindowAction
Whether the restriction is a /regex/ (worded "matching") rather than an exact name.
isPending() - Method in class io.jenkins.plugins.batchcontrol.action.ActivationItem
 
isPending() - Method in class io.jenkins.plugins.batchcontrol.action.GrantRequestItem
Whether the request is still awaiting a decision.
isPending() - Method in class io.jenkins.plugins.batchcontrol.action.RequestItem
 
isPending(String) - Method in class io.jenkins.plugins.batchcontrol.listener.ConfigSnapshotListener.Refresh
Whether the snapshot of fullName may still be older than the configuration.
isPerItemWidening() - Method in class io.jenkins.plugins.batchcontrol.ops.BatchControlStrategyMonitor
Whether the migration would make per-item authorization properties effective (D-35d (3), S-04): the installed strategy is matrix-auth's global matrix, which ignores job, folder and agent properties, while the Batch Control matrix is project-based (for the view's warning).
isPerItemWidening(AuthorizationStrategy) - Static method in class io.jenkins.plugins.batchcontrol.security.StrategyMigration
Whether migrating strategy makes per-item authorization properties effective (S-04, D-35d): matrix-auth's global matrix ignores job, folder and agent properties, and the Batch Control matrix is project-based, so stale properties would start to count and native Item/Configure holders could edit item ACLs.
isPrefillAction(String) - Method in class io.jenkins.plugins.batchcontrol.action.GrantsSection
Whether the action checkbox starts checked: the renewed grant's actions; else the ?actions= values (matched against GrantAction, how a refusal such as the delete veto hands over the action it needs, DEF-26); else CONFIGURE when the form was opened for an item.
isPrefillDuration(int) - Method in class io.jenkins.plugins.batchcontrol.action.GrantsSection
Whether the preset minutes starts selected: the renewed grant's length when it is one of the presets.
isPrefilled() - Method in class io.jenkins.plugins.batchcontrol.action.GrantsSection
Whether the form was opened for a specific item: from a job's "Request Change Permission" entry (CONFIGURE then starts checked, the user is trying to change that job) or from the re-request link of an ended grant (its actions start checked, D-33).
isPrefilled() - Method in class io.jenkins.plugins.batchcontrol.action.JobRequestAction
D-60: whether the form shows values carried from a refused build submission.
isPrefilled(List<ParameterDefinition>, StaplerRequest2) - Static method in class io.jenkins.plugins.batchcontrol.ui.RequestRunPrefill
Whether req is a GET carrying a "p."<name> value for at least one of definitions (the page then says where the values came from; constant text only).
isPrefilledForFolder() - Method in class io.jenkins.plugins.batchcontrol.action.GrantsSection
Whether the form was opened for a folder where a window's Create applies (?scopeFullName= resolves, as the viewer, to a regular folder; D-71: not a job and not a computed folder such as a multibranch project or an organization folder).
isPresent() - Method in class io.jenkins.plugins.batchcontrol.ui.FormErrors
The inverse of FormErrors.isEmpty(), for Jelly.
isQueueCancelled() - Method in class io.jenkins.plugins.batchcontrol.action.RequestItem
R2-05: whether the request is approved but the queue item of its run was cancelled, from the queue or by disabling the job (which cancels the job's queued items, D-55), before a build started.
isRecentRunsTruncated() - Method in class io.jenkins.plugins.batchcontrol.action.RequestItem
Whether the job has more runs than were shown, so the view can tell "these are all of them" apart from "this is the newest page of a longer history".
isRequesterLacksBuild() - Method in class io.jenkins.plugins.batchcontrol.action.RequestItem
D-38a: whether the detail page states that the requester does not hold Item/Build on the job (evaluated for the requester, not the viewer).
isRequests() - Method in class io.jenkins.plugins.batchcontrol.ui.SectionAccess
Whether the Run Requests screen (and its detail pages) may be linked for this user.
isRevertable() - Method in class io.jenkins.plugins.batchcontrol.ops.BatchControlStrategyMonitor
Whether a Batch Control strategy is installed, so that BatchControlStrategyMonitor.doRevert() applies.
isReviewedNotice() - Method in class io.jenkins.plugins.batchcontrol.action.JobRequestAction
Whether the page shows the "marked as reviewed" confirmation (constant text only).
isRunControlEnabled() - Method in class io.jenkins.plugins.batchcontrol.config.BatchControlGlobalConfiguration
 
isRunControlled() - Method in class io.jenkins.plugins.batchcontrol.action.JobActivationForm
Whether run control is on, i.e.
isSelfApproved() - Method in class io.jenkins.plugins.batchcontrol.model.ActivationRequest
Whether the deciding approver was the requester (administrator self-approval, SPEC item 2).
isSelfApproved() - Method in class io.jenkins.plugins.batchcontrol.model.RunRequest
 
isShowGroupConfigureNotice() - Method in class io.jenkins.plugins.batchcontrol.action.GrantRequestItem
D-71a (5), security-34 S-34-02: whether this page states that the settings of the item group the request names reach the items inside it.
isShowMarkReviewed() - Method in class io.jenkins.plugins.batchcontrol.action.JobRequestAction
D-58b (3): whether this page offers "Mark as reviewed": the job is in the "changed under a grant" state (itself or through an ancestor, GrantService.isChangedUnderGrant(hudson.model.Item)) and the viewer holds Item/Configure on it.
isShown() - Method in class io.jenkins.plugins.batchcontrol.action.ComputedFolderActivationAction
Run control on and the viewer holds Item/Read on the folder.
isShown() - Method in class io.jenkins.plugins.batchcontrol.action.JobActivationNoticeAction
Whether the notice is rendered: run control on and the viewer holds Item/Read.
isShown() - Method in class io.jenkins.plugins.batchcontrol.action.JobNoticesWidget
Whether either notice has anything to say to this viewer (no empty card otherwise).
isShown() - Method in class io.jenkins.plugins.batchcontrol.action.RunApprovalNoticeAction
Whether the notice is rendered (see JobActivationNoticeAction.isApprovalRequired()).
isShowNoRenameNotice() - Method in class io.jenkins.plugins.batchcontrol.action.GrantRequestItem
D-71c (security-36 S-36-02, S-36-04): whether this page states that a Configure window does not allow renaming the item, for a CONFIGURE request whose item is not an item group (a job, or an item whose kind is no longer known), to the same audience as GrantRequestItem.isShowGroupConfigureNotice(), whose notice already says it for an item group.
isShowSystemBuildWarning() - Method in class io.jenkins.plugins.batchcontrol.action.GrantRequestItem
D-50a (SPEC item 2): whether this page shows the fixed warning that builds can run as SYSTEM on this instance.
isStorable(CharSequence) - Static method in class io.jenkins.plugins.batchcontrol.store.XmlChars
Whether text holds only characters XML 1.0 can store.
isStrategyMissing() - Method in class io.jenkins.plugins.batchcontrol.ops.ConfigureWithoutGrantMonitor
Whether the installed authorization strategy is not a Batch Control strategy, so grants can never apply (D-35a).
isStrategyUnsupported() - Method in class io.jenkins.plugins.batchcontrol.ops.BatchControlStrategyMonitor
Condition 1 (D-35a): change control is on, but the installed strategy is not a Batch Control strategy, so active grants confer nothing (for the view).
isSubItem() - Method in class io.jenkins.plugins.batchcontrol.action.JobActivationNoticeAction
D-82: whether the job is a sub-item of a job (a matrix configuration, a Maven module), which follows its parent job's activation and run approval and has no requests of its own.
isSubItem(Item) - Static method in class io.jenkins.plugins.batchcontrol.policy.ActivationService
D-82: whether item is a sub-item of a job (a multi-configuration project's configuration, a Maven module): its parent is itself a job.
isSubject(Item) - Static method in class io.jenkins.plugins.batchcontrol.policy.ActivationService
Whether the item carries an activation of its own: a job or a computed folder that is not itself a computed child (D-46) nor a job's sub-item (D-82).
isTimerBlocked() - Method in class io.jenkins.plugins.batchcontrol.action.JobTriggerLockAction
Whether blockTimer is refusing cron runs (Jelly).
isTruncated() - Method in class io.jenkins.plugins.batchcontrol.action.ChangesSection
Whether the per-request record cap stopped the read: ask to narrow the filter.
isTruncated() - Method in class io.jenkins.plugins.batchcontrol.action.HistorySection
Whether the per-request record cap stopped the read: ask to narrow the filter.
isTruncated() - Method in class io.jenkins.plugins.batchcontrol.action.IncidentsSection
Whether the per-request record cap stopped the read: ask to narrow the filter.
isTruncated() - Method in class io.jenkins.plugins.batchcontrol.store.RecordPage
Whether the scan cap stopped the query before the oldest requested record.
isUpstreamBlocked() - Method in class io.jenkins.plugins.batchcontrol.action.JobTriggerLockAction
Whether blockUpstream is refusing upstream-triggered runs (Jelly).
isValid() - Method in class io.jenkins.plugins.batchcontrol.ui.FilterParser.Filter
Whether both dates were usable; the screen lists nothing otherwise.
isWellFormed(String) - Static method in class io.jenkins.plugins.batchcontrol.ui.RecordLookup
Whether id has the shape of a store id (see the class comment).
isWindowApplies() - Method in exception class io.jenkins.plugins.batchcontrol.ui.GrantRequiredFailure
D-71: whether a permission window can allow the change at all.
isWindowOpen() - Method in class io.jenkins.plugins.batchcontrol.action.GrantRequestItem
Whether the window is open now.
item(String) - Static method in class io.jenkins.plugins.batchcontrol.model.GrantScope
The scope naming exactly the item fullName (D-71).
ITEM - Enum constant in enum class io.jenkins.plugins.batchcontrol.model.GrantScope.Type
The one item with exactly this full name (D-71).
ItemChangeListener - Class in io.jenkins.plugins.batchcontrol.listener
Records item lifecycle events (SPEC item 9): CREATE, DELETE, RENAME and MOVE, with the acting user, the BatchClock timestamp and — when the actor holds an active matching grant — the grant id.
ItemChangeListener() - Constructor for class io.jenkins.plugins.batchcontrol.listener.ItemChangeListener
 
itemForPolicy(String) - Static method in class io.jenkins.plugins.batchcontrol.policy.ApprovalPolicy
As ApprovalPolicy.jobForPolicy(String) for any item (an activation request's subject may be a computed folder, D-46).
ItemIdentity - Class in io.jenkins.plugins.batchcontrol.security
security-13 S-13-09, D-80: the identity of an item's directory, recorded with an activation state so that a state left behind by a deleted item is not taken for a new item of the same name.
ItemKind - Class in io.jenkins.plugins.batchcontrol.model
The kind of the item a permission window names (D-71): the item's TopLevelItemDescriptor id, display name and icon, recorded when the request is created and copied to the grant at approval.
ItemKind(String, String, String) - Constructor for class io.jenkins.plugins.batchcontrol.model.ItemKind
 
itemsChangedUnderGrant(int) - Method in class io.jenkins.plugins.batchcontrol.security.GrantService
D-58a: the items in the "changed under a grant" state, sorted, at most limit.

J

JobActivationForm - Class in io.jenkins.plugins.batchcontrol.action
The activation request form at <item>/batch-control-activation/ (SPEC item 6a, D-39, D-64) for a job (JobRequestActionFactory) or a computed folder, which carries the activation of its children (D-46c, ComputedFolderActivationActionFactory).
JobActivationNoticeAction - Class in io.jenkins.plugins.batchcontrol.action
The job-page Batch Control notice area: whether a run-controlled job is activated, not activated or on hold, with a link to the activation request form (SPEC item 6a), and, on an approval-required job, that manual runs need an approved run request, with a link to the request form (SPEC item 6, e2e-03 DEF-01).
JobActivationNoticeAction(Job<?, ?>) - Constructor for class io.jenkins.plugins.batchcontrol.action.JobActivationNoticeAction
 
jobApproverRestriction(Job<?, ?>) - Static method in class io.jenkins.plugins.batchcontrol.policy.ApprovalPolicy
The job-level approver restriction, or an empty list when the job does not narrow it.
jobForPolicy(String) - Static method in class io.jenkins.plugins.batchcontrol.policy.ApprovalPolicy
Resolves the job a request targets, for applying its approver policy (security-08 S-11).
jobFullName() - Method in record class io.jenkins.plugins.batchcontrol.store.IncidentSummary
Returns the value of the jobFullName record component.
jobFullName() - Method in record class io.jenkins.plugins.batchcontrol.store.RequestSummary
Returns the value of the jobFullName record component.
JobGrantRequestAction - Class in io.jenkins.plugins.batchcontrol.action
Sidebar entry "Request Change Permission" on a job, linking to the grant request screen with this job already filled in (U-01).
JobGrantRequestAction(Job<?, ?>) - Constructor for class io.jenkins.plugins.batchcontrol.action.JobGrantRequestAction
 
JobNoticesWidget - Class in io.jenkins.plugins.batchcontrol.action
The job page notices (trigger lock, approval, activation) as a card of core's new job page.
JobNoticesWidget.FactoryImpl - Class in io.jenkins.plugins.batchcontrol.action
Contributes the card to a job's widgets on the new job page only.
JobRequestAction - Class in io.jenkins.plugins.batchcontrol.action
Per-job "Request Run" page at /job/<name>/batch-control/ (attached by JobRequestActionFactory).
JobRequestAction(Job<?, ?>) - Constructor for class io.jenkins.plugins.batchcontrol.action.JobRequestAction
 
JobRequestActionFactory - Class in io.jenkins.plugins.batchcontrol.action
Attaches the plugin's two per-job sidebar entries, and the trigger-lock notice, to every job.
JobRequestActionFactory() - Constructor for class io.jenkins.plugins.batchcontrol.action.JobRequestActionFactory
 
JobTriggerLockAction - Class in io.jenkins.plugins.batchcontrol.action
The job-page notice for blocked unattended triggers (SPEC item 6).
JobTriggerLockAction(Job<?, ?>) - Constructor for class io.jenkins.plugins.batchcontrol.action.JobTriggerLockAction
 
jobUrl(ActivationRequest) - Method in class io.jenkins.plugins.batchcontrol.action.ActivationsSection
Root-relative URL of the request's job or computed folder (D-46c) when the viewer may read it, else null (plain text).
jobUrl(String) - Static method in class io.jenkins.plugins.batchcontrol.ui.RunLinks
 
join(Collection<?>) - Method in class io.jenkins.plugins.batchcontrol.action.GrantRequestItem
Jelly helper: comma-joined action list ("CREATE, CONFIGURE").
join(Collection<?>) - Method in class io.jenkins.plugins.batchcontrol.action.GrantsSection
Jelly helper: comma-joined action list ("CREATE, CONFIGURE").
join(List<String>) - Method in class io.jenkins.plugins.batchcontrol.action.ActivationItem
Jelly helper: an approver set for display (a1, a2).
join(List<String>) - Method in class io.jenkins.plugins.batchcontrol.action.ActivationsSection
Jelly helper: an approver set for display (a1, a2).
join(List<String>) - Method in class io.jenkins.plugins.batchcontrol.action.HistorySection
An approver set for display (a1, a2).
join(List<String>) - Method in class io.jenkins.plugins.batchcontrol.action.RequestItem
Jelly helper: an approver set for display (a1, a2); empty for none.
join(List<String>) - Method in class io.jenkins.plugins.batchcontrol.action.RequestsSection
Jelly helper: an approver set for display (a1, a2).

K

keepsTemporaryFile(ParameterValue) - Static method in class io.jenkins.plugins.batchcontrol.policy.ParameterFiles
Whether value keeps a temporary file until its build takes it over: core's file value or the file-parameters plugin's stashed file value.
keepsTemporaryFile(ParameterValue) - Static method in class io.jenkins.plugins.batchcontrol.store.FileParametersSupport
Whether value is the plugin's stashed file value.
keptSize(List<? extends ParameterValue>, Map<String, Long>) - Static method in class io.jenkins.plugins.batchcontrol.policy.RequestBodyLimit
The size in bytes of what a run request holding values would keep: for each value its name plus the larger of its own size (RequestBodyLimit.ownSize(hudson.model.ParameterValue)) and the size of the uploaded parts it was created from (uploaded, by name).
KIND_ACTIVATION - Static variable in class io.jenkins.plugins.batchcontrol.ops.Notification
Notification.getKind() of an activation or hold request for a job (SPEC item 6a).
KIND_GRANT - Static variable in class io.jenkins.plugins.batchcontrol.ops.Notification
Notification.getKind() of a change (grant) request or window.
KIND_RUN - Static variable in class io.jenkins.plugins.batchcontrol.ops.Notification
Notification.getKind() of a run request.
KindIcon - Class in io.jenkins.plugins.batchcontrol.ui
D-71 (spec-review-S6 M-1): an item kind's icon as markup, for answers that are built in Java rather than in Jelly (the request form's item check, FormValidation.okWithMarkup).

L

lacksBuild(RunRequest) - Static method in class io.jenkins.plugins.batchcontrol.ui.RequesterPermission
LEGACY_FIELD - Static variable in class io.jenkins.plugins.batchcontrol.ui.ApproverInput
Field name of the single-approver field accepted for compatibility.
LIMIT - Static variable in class io.jenkins.plugins.batchcontrol.action.DashboardSection
Most runs the dashboard lists (D-67).
linkableIncident(String, Job<?, ?>) - Method in class io.jenkins.plugins.batchcontrol.ops.IncidentService
D-72a (SPEC item 11): the incident a run request submitted from the Request Run form may be linked to, when an incident rerun fell back to that form and the form carried the incident id back.
linkResolvedBy(String, String) - Method in class io.jenkins.plugins.batchcontrol.ops.IncidentService
Records the successful linked rerun on the incident (SPEC item 11): sets resolvedByRunId but never touches the status — resolution stays a human decision.
list() - Method in class io.jenkins.plugins.batchcontrol.policy.ActivationService
All stored activation requests, in creation order.
list() - Method in class io.jenkins.plugins.batchcontrol.policy.GrantRequestService
All stored grant requests, in creation order.
list() - Method in class io.jenkins.plugins.batchcontrol.policy.RunRequestService
All stored requests, in creation order.
list(YearMonth) - Method in class io.jenkins.plugins.batchcontrol.ops.IncidentService
Every incident created in the given month, in creation order.
listActivationRequests() - Method in class io.jenkins.plugins.batchcontrol.store.FileStore
 
listActivationRequests() - Method in interface io.jenkins.plugins.batchcontrol.store.Store
Loads every stored activation request, sorted by id (creation order).
listActivationStates() - Method in class io.jenkins.plugins.batchcontrol.store.FileStore
 
listActivationStates() - Method in interface io.jenkins.plugins.batchcontrol.store.Store
Every stored activation state (unordered).
listActive() - Method in class io.jenkins.plugins.batchcontrol.security.GrantService
Every grant that is active right now (not expired, not revoked).
listAll() - Method in class io.jenkins.plugins.batchcontrol.security.GrantService
Every known grant, active or ended, as the permission checks see it (a copy of the list): an end not yet written to its file is already in it.
listAwaitingDecision(Authentication) - Method in class io.jenkins.plugins.batchcontrol.policy.ActivationService
The PENDING requests counted as PendingCount.getAwaitingDecision() by ActivationService.countPendingFor(Authentication), in creation order (oldest, the one closest to its timeout, first): empty unless auth holds Jenkins-level BatchControl/Approve.
listChangeRecords(YearMonth) - Method in class io.jenkins.plugins.batchcontrol.store.FileStore
 
listChangeRecords(YearMonth) - Method in interface io.jenkins.plugins.batchcontrol.store.Store
Reads every change record of the given month (empty list if the month file is absent).
listGrantRequests() - Method in class io.jenkins.plugins.batchcontrol.store.FileStore
 
listGrantRequests() - Method in interface io.jenkins.plugins.batchcontrol.store.Store
Loads every stored grant request, sorted by id (creation order).
listGrants() - Method in class io.jenkins.plugins.batchcontrol.store.FileStore
 
listGrants() - Method in interface io.jenkins.plugins.batchcontrol.store.Store
Loads every stored grant, sorted by id (creation order).
listIncidents(YearMonth) - Method in class io.jenkins.plugins.batchcontrol.store.FileStore
 
listIncidents(YearMonth) - Method in interface io.jenkins.plugins.batchcontrol.store.Store
Loads every incident created in the given month via the monthly index, in index (creation) order.
listOpenActivationRequests() - Method in interface io.jenkins.plugins.batchcontrol.store.Store
Loads the PENDING activation requests only, sorted by id, via the entity index.
listOpenActivationRequests(Consumer<String>) - Method in class io.jenkins.plugins.batchcontrol.store.FileStore
 
listOpenActivationRequests(Consumer<String>) - Method in interface io.jenkins.plugins.batchcontrol.store.Store
As Store.listOpenActivationRequests(), and hands the id of every open request left out because its file cannot be read to unreadable.
listOpenGrantRequests() - Method in class io.jenkins.plugins.batchcontrol.store.FileStore
 
listOpenGrantRequests() - Method in interface io.jenkins.plugins.batchcontrol.store.Store
Loads the PENDING grant requests only, sorted by id, via the entity index.
listOpenRunRequests() - Method in interface io.jenkins.plugins.batchcontrol.store.Store
Loads the PENDING and APPROVED run requests only, sorted by creation time.
listOpenRunRequests(Consumer<String>) - Method in class io.jenkins.plugins.batchcontrol.store.FileStore
 
listOpenRunRequests(Consumer<String>) - Method in interface io.jenkins.plugins.batchcontrol.store.Store
As Store.listOpenRunRequests(), and hands the id of every open request left out because its file cannot be read to unreadable, for a caller that must act on it once it can be read (an invalidation it would otherwise miss).
listPending() - Method in class io.jenkins.plugins.batchcontrol.policy.ActivationService
The PENDING activation and hold requests, in creation order (the approval inbox).
listPendingFor(String) - Method in class io.jenkins.plugins.batchcontrol.policy.ActivationService
The PENDING requests on which userId is a designated approver.
listPendingForJob(String) - Method in class io.jenkins.plugins.batchcontrol.policy.ActivationService
The PENDING requests of one job, in creation order.
listRunRecords(YearMonth) - Method in class io.jenkins.plugins.batchcontrol.store.FileStore
 
listRunRecords(YearMonth) - Method in interface io.jenkins.plugins.batchcontrol.store.Store
Reads every run record of the given month (empty list if the month file is absent).
listRunRequests() - Method in class io.jenkins.plugins.batchcontrol.store.FileStore
 
listRunRequests() - Method in interface io.jenkins.plugins.batchcontrol.store.Store
Loads every stored run request, sorted by creation time.
listRunRequestSummaries() - Method in class io.jenkins.plugins.batchcontrol.store.FileStore
 
listRunRequestSummaries() - Method in interface io.jenkins.plugins.batchcontrol.store.Store
The listing fields of every stored run request, sorted by id, from memory.
listStoredMonths() - Method in class io.jenkins.plugins.batchcontrol.store.FileStore
 
listStoredMonths() - Method in interface io.jenkins.plugins.batchcontrol.store.Store
Every month for which any record bucket exists (runs, changes or incident index), sorted ascending.
listStoredMonths(Period) - Method in class io.jenkins.plugins.batchcontrol.store.FileStore
 
listStoredMonths(Period) - Method in interface io.jenkins.plugins.batchcontrol.store.Store
#33: the stored month buckets (as Store.listStoredMonths()) that may hold a record whose timestamp lies in period, whatever time zone the plugin clock had when the record was written: a bucket is named by the month of the record in the zone of its writer (SPEC 4), so after the controller's zone changed, a record near a month boundary sits in the neighbouring month's bucket.
load(String) - Method in class io.jenkins.plugins.batchcontrol.ops.IncidentService
Loads an incident by id, or null.
load(String) - Method in class io.jenkins.plugins.batchcontrol.policy.ActivationService
Loads an activation request by id, or null.
load(String) - Method in class io.jenkins.plugins.batchcontrol.policy.GrantRequestService
Loads a grant request by id, or null.
load(String) - Method in class io.jenkins.plugins.batchcontrol.policy.RunRequestService
Loads a request by id, or null.
loadActivationRequest(String) - Method in class io.jenkins.plugins.batchcontrol.store.FileStore
 
loadActivationRequest(String) - Method in interface io.jenkins.plugins.batchcontrol.store.Store
Loads an activation request by id, or returns null if it does not exist.
loadActivationState(String) - Method in class io.jenkins.plugins.batchcontrol.store.FileStore
 
loadActivationState(String) - Method in interface io.jenkins.plugins.batchcontrol.store.Store
The stored activation state of a job, or null if none exists.
loadConfigSnapshot(String) - Method in class io.jenkins.plugins.batchcontrol.store.FileStore
 
loadConfigSnapshot(String) - Method in interface io.jenkins.plugins.batchcontrol.store.Store
The stored config snapshot text of a job, or null if none exists.
loadGrant(String) - Method in class io.jenkins.plugins.batchcontrol.store.FileStore
 
loadGrant(String) - Method in interface io.jenkins.plugins.batchcontrol.store.Store
Loads a grant by id, or returns null if it does not exist.
loadGrantRequest(String) - Method in class io.jenkins.plugins.batchcontrol.store.FileStore
 
loadGrantRequest(String) - Method in interface io.jenkins.plugins.batchcontrol.store.Store
Loads a grant request by id, or returns null if it does not exist.
loadIncident(String) - Method in class io.jenkins.plugins.batchcontrol.store.FileStore
 
loadIncident(String) - Method in interface io.jenkins.plugins.batchcontrol.store.Store
Loads an incident by id, or returns null if it does not exist.
loadRunRequest(String) - Method in class io.jenkins.plugins.batchcontrol.store.FileStore
 
loadRunRequest(String) - Method in interface io.jenkins.plugins.batchcontrol.store.Store
Loads a request by id from <id>.xml, or returns null if it does not exist.
loadRunRequestValues(String) - Method in class io.jenkins.plugins.batchcontrol.store.FileStore
 
loadRunRequestValues(String) - Method in interface io.jenkins.plugins.batchcontrol.store.Store
The typed values of request id from <id>.values.xml (D-74), or null when there is no values file (the request has no parameters, or its values were deleted when its run started or it ended).

M

MailNotifier - Class in io.jenkins.plugins.batchcontrol.ops
The shipped e-mail BatchControlNotifier (SPEC item 13, D-36).
MailNotifier() - Constructor for class io.jenkins.plugins.batchcontrol.ops.MailNotifier
 
MANAGE - Static variable in class io.jenkins.plugins.batchcontrol.security.BatchControlPermissions
Manage the plugin: global configuration, approver list, revoking grants.
markActivationSchema() - Method in class io.jenkins.plugins.batchcontrol.store.FileStore
 
markActivationSchema() - Method in interface io.jenkins.plugins.batchcontrol.store.Store
Writes the upgrade seeding marker activations/.schema (atomically).
markChanged(String, String) - Method in class io.jenkins.plugins.batchcontrol.security.GrantService
D-58a: notes that itemFullName was changed under grantId (a save or creation by the holder while their permission came only from the grant), persisting the grant.
markedRuns(Item) - Method in class io.jenkins.plugins.batchcontrol.security.GrantService
D-58c: the ids (job#number) of the runs of the item (a job, or the jobs below a folder) that were replayed under a grant, at most 50.
markedRuns(String) - Method in class io.jenkins.plugins.batchcontrol.action.BatchControlRootAction
D-58c, for the batch-control-strategy monitor's view (reached there through app.getExtensionList): the runs of the item named itemFullName replayed under a permission window.
MARKER_FILE - Static variable in class io.jenkins.plugins.batchcontrol.security.ItemIdentity
The marker file in an item's root directory (D-80).
MARKER_REUSE_BLOCKED - Enum constant in enum class io.jenkins.plugins.batchcontrol.model.ChangeType
A blocked re-use of an approved-run marker (D-23 refusal, D-30 audit trail): the marker authorizes exactly one queue submission, and a further submission of the same marker is refused and recorded under this type so an operator can see the attempt.
markExecuted(String, String) - Method in class io.jenkins.plugins.batchcontrol.policy.RunRequestService
Marks an APPROVED request as EXECUTED once its build has started (SPEC section 4).
markReviewed(Item) - Method in class io.jenkins.plugins.batchcontrol.security.GrantService
D-58b (3): the deliberate review.
markRevoked(Instant, String, String) - Method in class io.jenkins.plugins.batchcontrol.model.Grant
Marks the grant revoked by revokedBy, recording why (null: an individual revocation).
marshal(Object, HierarchicalStreamWriter, MarshallingContext) - Method in class io.jenkins.plugins.batchcontrol.security.BatchControlMatrixAuthorizationStrategy.ConverterImpl
 
mask(String) - Static method in class io.jenkins.plugins.batchcontrol.store.SecretMasker
Returns the text with every secret occurrence replaced by "********".
MASK - Static variable in class io.jenkins.plugins.batchcontrol.store.SecretMasker
 
masked(Collection<? extends ParameterValue>) - Static method in class io.jenkins.plugins.batchcontrol.store.ParameterDisplay
The masked display map of values, by parameter name in submission order.
maskedParameters(Run<?, ?>) - Static method in class io.jenkins.plugins.batchcontrol.ops.IncidentService
The build's parameters in their masked display form (ParameterDisplay, D-72): a sensitive value is the mask, a file value [file] <original file name>.
matches(String) - Method in class io.jenkins.plugins.batchcontrol.model.CreateNamePattern
Whether the new item's name (not its full name) satisfies the restriction.
matchesJob(String) - Method in class io.jenkins.plugins.batchcontrol.ui.FilterParser.Filter
Case-insensitive substring match on the job full name (or change target).
matchesResult(Object) - Method in class io.jenkins.plugins.batchcontrol.ui.FilterParser.Filter
Case-insensitive match on the result token (build result / incident result).
matchesStatus(Object) - Method in class io.jenkins.plugins.batchcontrol.ui.FilterParser.Filter
Case-insensitive match on the status token (enum name).
matchesUser(String) - Method in class io.jenkins.plugins.batchcontrol.ui.FilterParser.Filter
R4-01: the same user under the realm's user id strategy (Approvers.sameUser(java.lang.String, java.lang.String)).
MAX_APPROVERS - Static variable in class io.jenkins.plugins.batchcontrol.ui.ApproverInput
Upper bound on the number of designated approvers in one submission.
MAX_CONCURRENT_EXPORTS - Static variable in class io.jenkins.plugins.batchcontrol.action.HistorySection
Most CSV exports that may run at the same time, instance-wide (S-05).
MAX_LENGTH - Static variable in class io.jenkins.plugins.batchcontrol.model.CreateNamePattern
Upper bound on the stored restriction, so a request cannot carry an unbounded regex.
MAX_NAME_LENGTH - Static variable in class io.jenkins.plugins.batchcontrol.model.CreateNamePattern
D-40a (security-08 S-03): a longer new name never matches a restriction.
MAX_SCANNED_RECORDS - Static variable in interface io.jenkins.plugins.batchcontrol.store.Store
Default maxScanned of the page queries: the per-request record cap.
MAX_USER_ID_LENGTH - Static variable in class io.jenkins.plugins.batchcontrol.ui.ApproverInput
Upper bound on one user id.
MAX_YEAR - Static variable in class io.jenkins.plugins.batchcontrol.ui.FilterParser
Highest accepted year of a from/to date (input validation).
maxRequestBodyBytes() - Static method in class io.jenkins.plugins.batchcontrol.policy.RequestBodyLimit
The current cap in bytes.
mayRunUnattended(Job<?, ?>) - Method in class io.jenkins.plugins.batchcontrol.policy.ActivationService
The queue gate's activation input (SPEC item 6a, D-46): whether the job may start on a cause that is not a human submission.
message(String) - Method in class io.jenkins.plugins.batchcontrol.ui.FormErrors
Sets the message shown above the form (one that is not about a single field).
Messages - Class in io.jenkins.plugins.batchcontrol
Generated localization support class.
Messages() - Constructor for class io.jenkins.plugins.batchcontrol.Messages
 
MIN_YEAR - Static variable in class io.jenkins.plugins.batchcontrol.ui.FilterParser
Lowest accepted year of a from/to date (input validation).
minutesLabel(int) - Method in class io.jenkins.plugins.batchcontrol.action.GrantsSection
Jelly helper: 1 minute / 15 minutes for the duration select (UX-12).
months(Collection<YearMonth>) - Method in class io.jenkins.plugins.batchcontrol.ui.FilterParser.Filter
The months of stored (the store's existing buckets) that the range covers, oldest first.
MOVE - Enum constant in enum class io.jenkins.plugins.batchcontrol.model.ChangeType
 
MOVED_NOTICE - Static variable in class io.jenkins.plugins.batchcontrol.ops.NotificationDispatcher
D-75 (1), S-39-04: the fixed sentence of a notice whose window followed its item to a name the recipient may not read; the notice then names the approved name instead.
MoveRefusal - Exception Class in io.jenkins.plugins.batchcontrol.security
D-59: the answer to a move that MoveGuard refused, in the D-48 style: HTTP 403 and a plain message saying what the move needs and what the user is missing.

N

newId() - Static method in class io.jenkins.plugins.batchcontrol.store.Ids
A new history record identifier, prefixed with the creation time on BatchClock.
newInstance(StaplerRequest2, JSONObject) - Method in class io.jenkins.plugins.batchcontrol.security.BatchControlRoleBasedAuthorizationStrategy.DescriptorImpl
 
newRequestId() - Static method in class io.jenkins.plugins.batchcontrol.store.Ids
A new identifier for a run, grant or activation request (and the window a grant request opens, which reuses the request id): a random UUID in lowercase, file-name safe (D-68).
NONE - Static variable in class io.jenkins.plugins.batchcontrol.model.PendingCount
Nothing pending for the viewer.
normalize(String) - Static method in class io.jenkins.plugins.batchcontrol.model.CreateNamePattern
Normalizes user input: null for an absent or blank restriction, otherwise the trimmed text.
normalize(List<String>) - Static method in class io.jenkins.plugins.batchcontrol.model.Approvers
Trimmed, de-duplicated (first occurrence wins) copy with blank entries removed.
notActivated(String, String) - Static method in class io.jenkins.plugins.batchcontrol.model.ActivationState
An explicit "not activated" state (security-13 S-13-06): written when an item is created under run control, and when a state file could not be deleted (S-13-05), so a later seeding or a stale file can never make the item activated.
noteMarkedRun(String, String) - Method in class io.jenkins.plugins.batchcontrol.security.GrantService
D-58c: a marked run started (called by the run listener).
notice() - Static method in class io.jenkins.plugins.batchcontrol.ui.RequesterPermission
The frozen sentence the detail page shows (RunRequestService.REQUESTER_LACKS_BUILD_NOTICE).
Notification - Class in io.jenkins.plugins.batchcontrol.ops
Immutable description of one notification (SPEC item 13, D-36), handed to every BatchControlNotifier.
Notification(String, String, String, String, String, List<String>, String) - Constructor for class io.jenkins.plugins.batchcontrol.ops.Notification
 
Notification(String, String, String, String, String, List<String>, String, String) - Constructor for class io.jenkins.plugins.batchcontrol.ops.Notification
 
Notification(String, String, String, String, String, List<String>, String, String, List<String>) - Constructor for class io.jenkins.plugins.batchcontrol.ops.Notification
 
Notification(String, String, String, String, String, List<String>, String, String, List<String>, List<String>) - Constructor for class io.jenkins.plugins.batchcontrol.ops.Notification
 
NotificationDispatcher - Class in io.jenkins.plugins.batchcontrol.ops
Hands request events to every BatchControlNotifier on a background thread (D-36).
NotificationEvent - Enum Class in io.jenkins.plugins.batchcontrol.ops
The request events a BatchControlNotifier receives (SPEC item 13, D-36).
notify(NotificationEvent, Notification) - Method in class io.jenkins.plugins.batchcontrol.ops.BatchControlNotifier
Delivers one event.
notify(NotificationEvent, Notification) - Method in class io.jenkins.plugins.batchcontrol.ops.MailNotifier
 
notifyExpiring() - Method in class io.jenkins.plugins.batchcontrol.policy.ActivationService
D-36: sends NotificationEvent.EXPIRING once per PENDING request close to its timeout.
notifyExpiring() - Method in class io.jenkins.plugins.batchcontrol.policy.GrantRequestService
D-36: sends NotificationEvent.EXPIRING once for every PENDING grant request whose pending timeout falls within notifyBeforeExpiryMinutes, and NotificationEvent.GRANT_EXPIRING once for every active window ending within it.
notifyExpiring() - Method in class io.jenkins.plugins.batchcontrol.policy.RunRequestService
D-36: sends NotificationEvent.EXPIRING once for every PENDING request whose pending timeout falls within notifyBeforeExpiryMinutes from now.
now() - Static method in class io.jenkins.plugins.batchcontrol.store.BatchClock
Current instant according to BatchClock.clock().

O

of(Item) - Static method in class io.jenkins.plugins.batchcontrol.model.ItemKind
The kind of item, read from its descriptor, or null when the item is not a top-level item (a sub-item of a job, such as a matrix configuration or a Maven module, which is part of that job and cannot be named by a window).
of(Item) - Static method in class io.jenkins.plugins.batchcontrol.ui.ReplayedRuns
The marked runs of item; empty for null.
of(GrantScope, GrantScope) - Static method in class io.jenkins.plugins.batchcontrol.ui.ScopeDisplay
The name to show for a request approved for approved whose window now names current.
of(File) - Static method in class io.jenkins.plugins.batchcontrol.security.ItemIdentity
The identity held by the marker in rootDir, or null when the directory or the marker does not exist, cannot be read, or does not hold an id.
of(String) - Static method in class io.jenkins.plugins.batchcontrol.model.Approvers
The one-element set for a single approver id; empty for null/blank.
of(String) - Static method in class io.jenkins.plugins.batchcontrol.ui.DiffSummary
 
of(String) - Static method in class io.jenkins.plugins.batchcontrol.ui.RequestScope
The item named itemFullName, or Jenkins when it does not exist.
of(String, String) - Static method in class io.jenkins.plugins.batchcontrol.ui.ScopeDisplay
offset(int) - Static method in class io.jenkins.plugins.batchcontrol.ui.Paging
The zero-based offset of the first row of page; saturates instead of overflowing.
onChange(Saveable, XmlFile) - Method in class io.jenkins.plugins.batchcontrol.listener.ConfigSnapshotListener
 
onChange(Saveable, XmlFile) - Method in class io.jenkins.plugins.batchcontrol.listener.ConfigSnapshotListener.SaveStart
 
onChange(Saveable, XmlFile) - Method in class io.jenkins.plugins.batchcontrol.listener.GrantViolationGuard
 
onCheckCopy(Item, ItemGroup) - Method in class io.jenkins.plugins.batchcontrol.listener.GrantViolationGuard.Baseline
Starts watching a copy into parent by a user whose creation the guard acts on there: their Item/Create comes only from a window (D-35c), or the parent is guarded (D-58a) and they are not an administrator saving through an HTTP request.
onCheckDelete(Item) - Method in class io.jenkins.plugins.batchcontrol.listener.DeleteVetoListener
 
onCheckDelete(Item) - Method in class io.jenkins.plugins.batchcontrol.security.WindowItemListener
 
onCompleted(CLIContext, int) - Method in class io.jenkins.plugins.batchcontrol.security.CliCreateContext
 
onCopied(Item, Item) - Method in class io.jenkins.plugins.batchcontrol.listener.ConfigSnapshotListener.CreationAnnounced
 
onCopied(Item, Item) - Method in class io.jenkins.plugins.batchcontrol.listener.ConfigSnapshotListener.CreationAnnouncedEnd
 
onCreated(Item) - Method in class io.jenkins.plugins.batchcontrol.listener.ActivationItemListener
 
onCreated(Item) - Method in class io.jenkins.plugins.batchcontrol.listener.ConfigSnapshotListener.CreationAnnounced
 
onCreated(Item) - Method in class io.jenkins.plugins.batchcontrol.listener.ConfigSnapshotListener.CreationAnnouncedEnd
 
onCreated(Item) - Method in class io.jenkins.plugins.batchcontrol.listener.CreatedItemGrantListener
 
onCreated(Item) - Method in class io.jenkins.plugins.batchcontrol.listener.GrantViolationGuard.Baseline
D-35c, creation payload: an item created by a user whose Create comes only from a grant (a createItem with a config.xml payload, or a copy) keeps no authorization property it arrived with.
onCreated(Item) - Method in class io.jenkins.plugins.batchcontrol.listener.ItemChangeListener
 
onCreated(Item) - Method in class io.jenkins.plugins.batchcontrol.security.WindowItemListener
 
onDeleted(Item) - Method in class io.jenkins.plugins.batchcontrol.listener.ActivationItemListener
 
onDeleted(Item) - Method in class io.jenkins.plugins.batchcontrol.listener.CreatedItemGrantListener
 
onDeleted(Item) - Method in class io.jenkins.plugins.batchcontrol.listener.GrantViolationGuard.Baseline
 
onDeleted(Item) - Method in class io.jenkins.plugins.batchcontrol.listener.ItemChangeListener
 
onDeleted(Item) - Method in class io.jenkins.plugins.batchcontrol.listener.RequestInvalidationListener
#38: deleting a job ends its PENDING/APPROVED run requests INVALIDATED, and deleting a folder (or any other item group) does the same for the requests on the items below it, as SPEC 6a already does for activation requests.
onDeleted(Item) - Method in class io.jenkins.plugins.batchcontrol.security.WindowItemListener
 
onExecution(CLIContext) - Method in class io.jenkins.plugins.batchcontrol.security.CliCreateContext
 
onFinalized(Run<?, ?>) - Method in class io.jenkins.plugins.batchcontrol.listener.RunRecordListener
 
onItemCreated(Item) - Method in class io.jenkins.plugins.batchcontrol.policy.ActivationService
An item was created (SPEC item 6a, D-45, D-46).
onLeft(Queue.LeftItem) - Method in class io.jenkins.plugins.batchcontrol.queue.ApprovedRunQueueListener
 
onLoaded() - Method in class io.jenkins.plugins.batchcontrol.listener.CreatedItemGrantListener
S-09: after all items are loaded at startup, drops created-item records of items that no longer exist.
onLoaded() - Method in class io.jenkins.plugins.batchcontrol.listener.GrantViolationGuard.Baseline
Fills the baseline once all items are loaded (startup and reload).
onLoaded() - Method in class io.jenkins.plugins.batchcontrol.security.WindowItemListener
 
onLocationChanged(Item, String, String) - Method in class io.jenkins.plugins.batchcontrol.listener.ActivationItemListener
 
onLocationChanged(Item, String, String) - Method in class io.jenkins.plugins.batchcontrol.listener.CreatedItemGrantListener
 
onLocationChanged(Item, String, String) - Method in class io.jenkins.plugins.batchcontrol.listener.GrantViolationGuard.Baseline
 
onLocationChanged(Item, String, String) - Method in class io.jenkins.plugins.batchcontrol.listener.ItemChangeListener
 
onLocationChanged(Item, String, String) - Method in class io.jenkins.plugins.batchcontrol.listener.RequestInvalidationListener
 
onLocationChanged(Item, String, String) - Method in class io.jenkins.plugins.batchcontrol.security.WindowItemListener
 
onRenamed(Item, String, String) - Method in class io.jenkins.plugins.batchcontrol.listener.ItemChangeListener
 
onStarted(Run<?, ?>, TaskListener) - Method in class io.jenkins.plugins.batchcontrol.listener.ReplayUnderGrantListener
 
onStarted(Run<?, ?>, TaskListener) - Method in class io.jenkins.plugins.batchcontrol.listener.RunRequestExecutionListener
 
onThrowable(CLIContext, Throwable) - Method in class io.jenkins.plugins.batchcontrol.security.CliCreateContext
 
open(StaplerResponse2, String) - Static method in class io.jenkins.plugins.batchcontrol.ui.CsvWriter
Sets the CSV content type and attachment disposition on the response, writes the UTF-8 byte order mark and returns a writer for the header row and the data rows.
OPEN - Enum constant in enum class io.jenkins.plugins.batchcontrol.model.IncidentStatus
 
openForRun(Run<?, ?>) - Method in class io.jenkins.plugins.batchcontrol.ops.IncidentService
Opens an incident for a completed build whose result is in the configured incidentResults — regardless of what caused the build (SPEC item 11, D-10).
OTHER - Enum constant in enum class io.jenkins.plugins.batchcontrol.model.CauseType
 

P

PAGE_SIZE - Static variable in class io.jenkins.plugins.batchcontrol.action.ActivationsSection
Page size for the request list.
PAGE_SIZE - Static variable in class io.jenkins.plugins.batchcontrol.action.ChangesSection
Page size for the change record list.
PAGE_SIZE - Static variable in class io.jenkins.plugins.batchcontrol.action.GrantsSection
Page size for both the request list and the active grant list.
PAGE_SIZE - Static variable in class io.jenkins.plugins.batchcontrol.action.HistorySection
Page size for every table.
PAGE_SIZE - Static variable in class io.jenkins.plugins.batchcontrol.action.IncidentsSection
Page size for the incident list.
PAGE_SIZE - Static variable in class io.jenkins.plugins.batchcontrol.action.RequestsSection
Page size for the request list.
PAGE_SIZE - Static variable in class io.jenkins.plugins.batchcontrol.ui.Paging
Rows per page on every Batch Control list screen (SPEC: 50 by default).
pageChangeRecords(Collection<YearMonth>, Period, Predicate<? super ChangeRecord>, int, int, int) - Method in class io.jenkins.plugins.batchcontrol.store.FileStore
 
pageChangeRecords(Collection<YearMonth>, Period, Predicate<? super ChangeRecord>, int, int, int) - Method in interface io.jenkins.plugins.batchcontrol.store.Store
pageChangeRecords(Collection<YearMonth>, Predicate<? super ChangeRecord>, int, int, int) - Method in class io.jenkins.plugins.batchcontrol.store.FileStore
 
pageChangeRecords(Collection<YearMonth>, Predicate<? super ChangeRecord>, int, int, int) - Method in interface io.jenkins.plugins.batchcontrol.store.Store
pageIncidents(Collection<YearMonth>, Period, Predicate<? super IncidentSummary>, Predicate<? super Incident>, int, int, int) - Method in class io.jenkins.plugins.batchcontrol.store.FileStore
 
pageIncidents(Collection<YearMonth>, Period, Predicate<? super IncidentSummary>, Predicate<? super Incident>, int, int, int) - Method in interface io.jenkins.plugins.batchcontrol.store.Store
pagerQuery(String, long) - Method in class io.jenkins.plugins.batchcontrol.action.BatchControlRootAction
#45: the query string of a bc:pager link to page of the list paged with parameter, keeping the current URL's other parameters (Paging.query(java.lang.String, long)).
pageRunRecords(Collection<YearMonth>, Period, Predicate<? super RunRecord>, int, int, int) - Method in class io.jenkins.plugins.batchcontrol.store.FileStore
 
pageRunRecords(Collection<YearMonth>, Period, Predicate<? super RunRecord>, int, int, int) - Method in interface io.jenkins.plugins.batchcontrol.store.Store
One page of the run records of months that match filter, newest first (start time, then run id).
Paging - Class in io.jenkins.plugins.batchcontrol.ui
Paging arithmetic shared by every list screen (D-44).
PARAMETER - Static variable in class io.jenkins.plugins.batchcontrol.ui.Dialogs
Hidden form field marking a submission made from a dialog.
ParameterDisplay - Class in io.jenkins.plugins.batchcontrol.store
D-72: the one place where typed ParameterValues become the masked text that Batch Control displays or writes (the request's parameters map, run records, incidents, CSV).
parameterField(String) - Method in class io.jenkins.plugins.batchcontrol.action.JobRequestAction
D-72b: the FormErrors field of the parameter named name, whose message the form shows right below that parameter (_form.jelly).
ParameterFiles - Class in io.jenkins.plugins.batchcontrol.policy
D-72: disposal of the temporary files that typed parameter values keep until a build takes them over, for values that will never reach the queue: a run request that ended without a run (REJECTED, CANCELLED, EXPIRED, INVALIDATED before it was queued), a submission that was refused before a request was stored, a person's own build submission that the queue gate refused, or rerun values that could not be completed.
parameters(Map<String, String>) - Method in class io.jenkins.plugins.batchcontrol.action.DashboardSection
One-line parameter rendering; values come from the record already masked.
parameters(Map<String, String>) - Method in class io.jenkins.plugins.batchcontrol.action.HistorySection
One-line parameter rendering; values come from the record already masked.
parameterValues(StaplerRequest2, String) - Static method in class io.jenkins.plugins.batchcontrol.ui.RepeatedField
R4-03: getParameterValues(field) with the value of the multipart part read as UTF-8 where RepeatedField.asTyped(org.kohsuke.stapler.StaplerRequest2, java.lang.String) allows it.
parentOf(String) - Static method in class io.jenkins.plugins.batchcontrol.model.GrantScope
The full name of the group itemFullName lies in ("" for a root item).
parse(String) - Static method in class io.jenkins.plugins.batchcontrol.model.CreateNamePattern
Validates and compiles a restriction at submission time.
parse(StaplerRequest2) - Static method in class io.jenkins.plugins.batchcontrol.ui.FilterParser
Parses the filter from the current request; never returns null.
partNames(JSONObject) - Static method in class io.jenkins.plugins.batchcontrol.policy.RequestBodyLimit
The part names a json parameter entry can refer to: each top-level value as JSONObject.getString(java.lang.String) reads it (a number or an object as its text).
PathCodec - Class in io.jenkins.plugins.batchcontrol.store
The single place where job full names are turned into store file names and where store file names are validated.
PENDING - Enum constant in enum class io.jenkins.plugins.batchcontrol.model.RequestStatus
 
PendingCount - Class in io.jenkins.plugins.batchcontrol.model
How many PENDING requests of one kind concern a viewer (D-61): the requests awaiting their decision as a designated approver holding BatchControl/Approve, and their own requests on which they are not a designated approver.
PendingCount(int, int) - Constructor for class io.jenkins.plugins.batchcontrol.model.PendingCount
 
pendingExpired() - Static method in class io.jenkins.plugins.batchcontrol.policy.EndReasons
A pending request passed the pending timeout.
Period - Record Class in io.jenkins.plugins.batchcontrol.store
The time range of a page query (security-10 S-03): only records inside it count toward the query's record cap.
Period(Instant, Instant) - Constructor for record class io.jenkins.plugins.batchcontrol.store.Period
Creates an instance of a Period record class.
PREFIX - Static variable in class io.jenkins.plugins.batchcontrol.ui.RequestRunPrefill
Query parameter prefix of a pre-filled value (frozen name).
PRESENT - Enum constant in enum class io.jenkins.plugins.batchcontrol.listener.ConfigSnapshotListener.Seeding
The snapshot was left as it was: seeding found one (or something else in its place), or the refresh found it equal to the configuration or no longer waiting for the refresh.
PROPERTY - Static variable in class io.jenkins.plugins.batchcontrol.policy.RequestBodyLimit
System property holding the cap in bytes.
pruneCreatedItems(Predicate<String>) - Method in class io.jenkins.plugins.batchcontrol.security.GrantService
D-35c, S-09: drops from the created-items lists of active grants every item for which exists is false.

Q

query(String) - Method in class io.jenkins.plugins.batchcontrol.action.HistorySection
Full query fragment for a tab link of the given kind (filter preserved, page reset).
query(String, long) - Static method in class io.jenkins.plugins.batchcontrol.ui.Paging
#45: the query string (without the leading ?) of a pager link to page of the list paged with parameter: every other parameter of the current URL's query string, in its order (the other lists' pendingPage, activePage, endedPage), then parameter=page.
queuedMarkerRequestIds(Jenkins) - Static method in class io.jenkins.plugins.batchcontrol.policy.RunRequestService
Request ids whose approval marker is currently sitting on a queue item, whoever asks.

R

R4-02: a script gets the plain message, never the redirect - Search tag in exception class io.jenkins.plugins.batchcontrol.ui.ApprovalRequiredFailure
Section
read(StaplerRequest2, JSONObject) - Static method in class io.jenkins.plugins.batchcontrol.ui.ApproverInput
 
record(ChangeType, String, String, String, String) - Method in class io.jenkins.plugins.batchcontrol.store.BlockedAttemptAudit
Appends one refused-attempt record unless the same attempt by the same account was already recorded inside BlockedAttemptAudit.COOLDOWN.
record(ChangeType, String, String, String, String, String) - Method in class io.jenkins.plugins.batchcontrol.store.BlockedAttemptAudit
As BlockedAttemptAudit.record(ChangeType, String, String, String, String), naming the grant involved (D-40: a refused CREATE of a name the grant's restriction does not allow).
recordCoalesced(ChangeType, String, Duration, String, String, String) - Method in class io.jenkins.plugins.batchcontrol.store.BlockedAttemptAudit
Appends one refused-attempt record unless one was already written under the same type and attemptKey inside cooldown, whoever made the attempt.
recordCreatedItem(String, Item) - Method in class io.jenkins.plugins.batchcontrol.security.GrantService
D-35c: notes that user created item through the Create of an active grant, persisting the grant.
recordingTurnedOn() - Static method in class io.jenkins.plugins.batchcontrol.ops.SnapshotSeeding
A switch turned recording on (no switch was on before).
RecordLookup - Class in io.jenkins.plugins.batchcontrol.ui
Resolves a record id that arrives as a URL segment (/batch-control/requests/<id>/ and the other detail URLs) or is about to become a link to one (S-39-01).
RecordPage<T> - Class in io.jenkins.plugins.batchcontrol.store
One page of a bounded record query: the rows to render plus what the pager needs.
recordPersonRefusal(ChangeType, String, String, String, String, String) - Method in class io.jenkins.plugins.batchcontrol.store.BlockedAttemptAudit
D-51, D-51a: appends the record of a re-run a person submitted and was refused.
recordQueueCancelled(String, String) - Method in class io.jenkins.plugins.batchcontrol.policy.RunRequestService
D-72b (7), security-35 S-35-07: the queue item of the approved run of requestId for job jobFullName was cancelled, so that run will not happen.
recordRerunRequest(String, String) - Method in class io.jenkins.plugins.batchcontrol.ops.IncidentService
Lists the stored run request requestId among the incident's rerun requests (the link back from the incident; the request itself carries incidentId).
recover() - Static method in class io.jenkins.plugins.batchcontrol.ops.StartupRecovery
 
recoverApprovedRequests() - Method in class io.jenkins.plugins.batchcontrol.policy.RunRequestService
Re-submits APPROVED, never-executed requests exactly once after a restart (SPEC item 4).
refresh(Item, ConfigSnapshotListener.Refresh) - Static method in class io.jenkins.plugins.batchcontrol.listener.ConfigSnapshotListener
Brings the snapshot of item up to date for refresh: stores the item's current configuration unless the snapshot already equals it, for SPEC item 9 after recording was turned on.
refusalView(StaplerRequest2, String) - Static method in class io.jenkins.plugins.batchcontrol.ui.Dialogs
The view that shows a refusal of req: the dialog's, else pageView.
refuseNonGet(StaplerRequest2, StaplerResponse2) - Static method in class io.jenkins.plugins.batchcontrol.ui.HttpVerbs
The GET-only guard for a read-only URL served by a do* method (JSON and CSV exports, redirect stubs): answers 405 with Allow: GET, HEAD unless the request is GET or HEAD.
refuseRequestWhileChangeControlOff(String) - Method in class io.jenkins.plugins.batchcontrol.policy.GrantRequestService
e2e-03 DEF-27: the refusal of a grant request that the HTTP layer turns away before it reaches GrantRequestService.create(io.jenkins.plugins.batchcontrol.model.GrantScope, java.util.List<io.jenkins.plugins.batchcontrol.model.GrantAction>, int, java.lang.String, java.lang.String) (the Grants screen closes with the change-control switch).
refuseUnsupported() - Static method in class io.jenkins.plugins.batchcontrol.ui.HttpVerbs
Throws a 405 response unless the current request is GET, HEAD or POST.
register() - Static method in class io.jenkins.plugins.batchcontrol.listener.SelfGrantRevertFilter
Registers the filter once the plugin has started.
register(Grant, Item) - Method in class io.jenkins.plugins.batchcontrol.security.GrantService
Persists a freshly created grant and makes it effective immediately.
registerApproved(Item, Supplier<Grant>) - Method in class io.jenkins.plugins.batchcontrol.security.GrantService
#39: the approval's registration.
reject(String, String) - Method in class io.jenkins.plugins.batchcontrol.policy.ActivationService
Rejects a PENDING request; the comment is mandatory (SPEC item 5 rule).
reject(String, String) - Method in class io.jenkins.plugins.batchcontrol.policy.GrantRequestService
Rejects a PENDING grant request; the comment is mandatory (SPEC item 5 rule reused).
reject(String, String) - Method in class io.jenkins.plugins.batchcontrol.policy.RunRequestService
Rejects a PENDING request; the comment is mandatory (SPEC 5).
REJECTED - Enum constant in enum class io.jenkins.plugins.batchcontrol.model.RequestStatus
 
REJECTED - Enum constant in enum class io.jenkins.plugins.batchcontrol.ops.NotificationEvent
A designated approver rejected the request.
relocate(String, String) - Method in class io.jenkins.plugins.batchcontrol.policy.ActivationService
A job was renamed or moved: its activation follows it, and PENDING requests on the old name end INVALIDATED, as run requests do (D-21: the approver reviewed another identity).
relocateChanged(Item, String, String) - Method in class io.jenkins.plugins.batchcontrol.security.GrantService
D-58a (S-27-03): an item was renamed or moved.
relocateCreatedItem(Item, String, String) - Method in class io.jenkins.plugins.batchcontrol.security.GrantService
D-35c: the item moved, recorded as created through an active grant, was renamed or moved from oldFullName to newFullName; the record follows it.
remaining(Instant) - Method in class io.jenkins.plugins.batchcontrol.action.FolderCreateWindowAction
 
remaining(Instant) - Method in class io.jenkins.plugins.batchcontrol.action.GrantRequestItem
Jelly helper: how much of the window is left.
remaining(Instant) - Method in class io.jenkins.plugins.batchcontrol.action.GrantsSection
Jelly helper: how much of a grant window is left (12 min 30 sec), so the user does not have to subtract the absolute expiry time from the current time (UX-11).
REMOTE_RUN_BLOCKED - Enum constant in enum class io.jenkins.plugins.batchcontrol.model.ChangeType
A run submission refused by the queue gate because its cause is a remote trigger carrying no Jenkins identity (hudson.model.Cause$RemoteCause, which core mints for /job/X/build?token=… and /job/X/buildWithParameters?token=…).
remove(String, boolean) - Method in class io.jenkins.plugins.batchcontrol.policy.ActivationService
A job was deleted: its activation is removed and its PENDING requests end INVALIDATED, so a later job of the same name starts not activated and cannot be activated by a request that was about another job.
removeInvalid(String) - Static method in class io.jenkins.plugins.batchcontrol.store.XmlChars
R1-01: text without the characters XML 1.0 cannot store.
RENAME - Enum constant in enum class io.jenkins.plugins.batchcontrol.model.ChangeType
 
render(StaplerRequest2, StaplerResponse2, Object) - Method in class io.jenkins.plugins.batchcontrol.ui.FormErrors
Forwards the current request to it's index.jelly with HTTP 400 and this refusal attached.
render(StaplerRequest2, StaplerResponse2, Object, String) - Method in class io.jenkins.plugins.batchcontrol.ui.FormErrors
As FormErrors.render(StaplerRequest2, StaplerResponse2, Object), to the view view of it: D-66, a form submitted from a dialog is answered with the dialog's own view, so core's dialog replaces its form with the refused one (messages shown, input kept).
render(StaplerRequest2, StaplerResponse2, Object, String, int) - Method in class io.jenkins.plugins.batchcontrol.ui.FormErrors
As FormErrors.render(StaplerRequest2, StaplerResponse2, Object, String) with the HTTP status status (D-72: 413 for a body over the size cap).
RepeatedField - Class in io.jenkins.plugins.batchcontrol.ui
Reads the values of a repeated form field (one value per entry, in submission order) from an application/x-www-form-urlencoded or a multipart/form-data body alike.
REPLAY_UNDER_GRANT - Enum constant in enum class io.jenkins.plugins.batchcontrol.model.ChangeType
A run was started by a Replay, Pipeline Rebuild or Restart from Stage by a user whose permission for it came only from a grant (D-58c).
ReplayedRuns - Class in io.jenkins.plugins.batchcontrol.ui
D-58c: the runs of an item that were replayed under a permission window, for the two review surfaces (the batch-control-strategy monitor and the job's Batch Control page).
ReplayedRuns.Row - Class in io.jenkins.plugins.batchcontrol.ui
One marked run: its id and its root-relative build URL, or null for plain text.
ReplayUnderGrantAction - Class in io.jenkins.plugins.batchcontrol.queue
D-58c: the hidden marker of a run started by a Replay, Pipeline Rebuild or Restart from Stage that a user whose permission for it came only from a grant submitted.
ReplayUnderGrantAction(String, String) - Constructor for class io.jenkins.plugins.batchcontrol.queue.ReplayUnderGrantAction
 
ReplayUnderGrantAction(String, String, Integer) - Constructor for class io.jenkins.plugins.batchcontrol.queue.ReplayUnderGrantAction
 
ReplayUnderGrantListener - Class in io.jenkins.plugins.batchcontrol.listener
D-58c: when a run marked ReplayUnderGrantAction starts, a REPLAY_UNDER_GRANT change record names the user, the run and the grant, and the run is added to the marked runs the review surfaces list.
ReplayUnderGrantListener() - Constructor for class io.jenkins.plugins.batchcontrol.listener.ReplayUnderGrantListener
 
request(String) - Method in class io.jenkins.plugins.batchcontrol.ui.SectionAccess
Whether the run request with this id may be linked (e2e-03 DEF-11): the Run Requests screen is open to the user AND the request itself is visible to them (P-09, Visibility.canSeeRunRequest(io.jenkins.plugins.batchcontrol.model.RunRequest)); the detail page answers 404 otherwise.
REQUEST - Static variable in class io.jenkins.plugins.batchcontrol.security.BatchControlPermissions
Create run requests.
REQUEST_CHANGE_LABEL - Static variable in class io.jenkins.plugins.batchcontrol.action.JobGrantRequestAction
Sidebar caption.
REQUEST_CREATED - Enum constant in enum class io.jenkins.plugins.batchcontrol.ops.NotificationEvent
A run or change request was created and waits for a decision.
REQUEST_GRANT - Static variable in class io.jenkins.plugins.batchcontrol.security.BatchControlPermissions
Request temporary change permissions (JIT).
REQUEST_RUN_LABEL - Static variable in class io.jenkins.plugins.batchcontrol.action.RequestRunUiDecorator
The sidebar label of the plugin's own request form, used by JobRequestAction.getDisplayName().
RequestBodyLimit - Class in io.jenkins.plugins.batchcontrol.policy
D-72, D-74 (2): the size cap on a run request submission.
requester() - Method in record class io.jenkins.plugins.batchcontrol.store.RequestSummary
Returns the value of the requester record component.
REQUESTER_LACKS_BUILD_NOTICE - Static variable in class io.jenkins.plugins.batchcontrol.policy.RunRequestService
D-38a: the sentence the request detail page and the approver notification show when the requester does not hold Item/Build on the request's job.
requesterLacksBuild(RunRequest) - Method in class io.jenkins.plugins.batchcontrol.policy.RunRequestService
D-38a (SPEC item 6): whether the requester of request (not the current user) lacks Item/Build on the request's job, so an approval also authorises a run the requester could not start.
RequesterPermission - Class in io.jenkins.plugins.batchcontrol.ui
D-38a: whether the requester of a run request (not the viewer) lacks Item/Build on the request's job, for the request detail page.
requestId() - Method in class io.jenkins.plugins.batchcontrol.model.RunRequestValues
The id of the request these values belong to.
RequestInvalidationListener - Class in io.jenkins.plugins.batchcontrol.listener
D-21: renaming or moving a job ends every PENDING/APPROVED request that targets its old full name in status INVALIDATED (the approver reviewed a different identity than the one that would run).
RequestInvalidationListener() - Constructor for class io.jenkins.plugins.batchcontrol.listener.RequestInvalidationListener
 
RequestItem - Class in io.jenkins.plugins.batchcontrol.action
One run request at /batch-control/requests/<id>/: detail view plus the four state-changing POST endpoints (approve, reject, cancel, changeApprover).
RequestItem.RecentRun - Class in io.jenkins.plugins.batchcontrol.action
One row of the recent-run table.
RequestRunPrefill - Class in io.jenkins.plugins.batchcontrol.ui
D-60: carrying the values of a refused build submission into the job's Request Run form.
RequestRunUiDecorator - Class in io.jenkins.plugins.batchcontrol.action
Relabels core's "Build Now" sidebar entry on approval-protected jobs (SPEC item 6: the manual build entry point must not read "Build Now" while run control is on).
RequestRunUiDecorator() - Constructor for class io.jenkins.plugins.batchcontrol.action.RequestRunUiDecorator
 
requests() - Static method in class io.jenkins.plugins.batchcontrol.ui.SectionAccess
/batch-control/requests/**: requesters, approvers and managers.
RequestScope - Class in io.jenkins.plugins.batchcontrol.ui
D-38b: where BatchControl/Request is checked for a job-specific use (viewing, cancelling or re-designating a run or activation request, requesting an activation or hold): the request's item, so Request assigned on that job or a folder above it counts; Jenkins when the item no longer exists.
RequestsSection - Class in io.jenkins.plugins.batchcontrol.action
The run request lists at /batch-control/requests/ (D-66): pending requests (oldest first), active ones (approved, run not started) and ended ones (newest first), each in pages of 50 selected with ?pendingPage=N, ?activePage=N and ?endedPage=N.
RequestsSection() - Constructor for class io.jenkins.plugins.batchcontrol.action.RequestsSection
 
RequestStatus - Enum Class in io.jenkins.plugins.batchcontrol.model
Lifecycle status of a RunRequest (and, from slice S2 on, a grant request).
RequestSummary - Record Class in io.jenkins.plugins.batchcontrol.store
The few fields of a run request that listings filter and sort on, kept in memory by the store so a listing reads only the XML files of the rows it renders.
RequestSummary(String, String, String, RequestStatus, Instant, Instant) - Constructor for record class io.jenkins.plugins.batchcontrol.store.RequestSummary
Creates an instance of a RequestSummary record class.
RequestTooLargeException - Exception Class in io.jenkins.plugins.batchcontrol.policy
D-72b (4), security-37 S-37-01: a run request refused because what it would keep (its file contents and the stored text of its other values, RequestBodyLimit.keptSize(java.util.List<? extends hudson.model.ParameterValue>, java.util.Map<java.lang.String, java.lang.Long>)) is over the cap RequestBodyLimit.maxRequestBodyBytes().
requireRerunTarget(String, Job<?, ?>) - Method in class io.jenkins.plugins.batchcontrol.ops.IncidentService
The incident a run request for job is linked to (SPEC item 11): it must exist and belong to job.
requiresApprovalToRun(Job<?, ?>) - Static method in class io.jenkins.plugins.batchcontrol.policy.RunRequestService
Whether a person's Build Now, Rebuild, Retry or Replay of job is refused by the queue gate and needs an approved run request instead (SPEC item 6): run control is on and the job requires approval.
requireStorable(String, String) - Static method in class io.jenkins.plugins.batchcontrol.store.XmlChars
R1-01: refuses a user-entered text that holds a character XML 1.0 cannot store, before anything is stored.
rerun(String, String) - Method in class io.jenkins.plugins.batchcontrol.ops.IncidentService
Creates a rerun RunRequest carrying the failed run's own parameter values (D-72: taken from the build's ParametersAction, original secrets and recoverable file values included) and links it both ways: request.incidentId and incident.rerunRequestIds.
rerun(String, List<String>) - Method in class io.jenkins.plugins.batchcontrol.ops.IncidentService
Approver-set form (D-37) of IncidentService.rerun(String, String).
rerunFromQuery(HttpServletRequest) - Static method in class io.jenkins.plugins.batchcontrol.ui.RequestRunPrefill
D-72a: the raw "fromRerun" value of req's query string alone (never its body), URL-decoded, or null.
RerunNeedsFormException - Exception Class in io.jenkins.plugins.batchcontrol.ops
D-72 (SPEC item 11): an incident rerun could not recover every parameter value of the failed run (a stashed file, which the build clears when it completes; a core file whose copy under the build directory is gone; a deleted build), so no request was created.
RerunNeedsFormException(String, Map<String, String>) - Constructor for exception class io.jenkins.plugins.batchcontrol.ops.RerunNeedsFormException
 
rerunQuery(Job<?, ?>, Map<String, String>, String) - Static method in class io.jenkins.plugins.batchcontrol.ui.RequestRunPrefill
D-72: the query of the Request Run form an incident rerun continues on when a value of the failed run could not be recovered (RerunNeedsFormException): the prefill values the job defines as carriable parameters, under the same caps as RequestRunPrefill.carriedValues(hudson.model.Job<?, ?>, java.util.List<hudson.model.ParameterValue>) (2000 characters per value, 4000 for the encoded "p." part, definition order), then "fromRerun"=<incidentId>.
reset() - Static method in class io.jenkins.plugins.batchcontrol.store.BatchClock
Restores the system default zone clock.
resetCacheOnStartup() - Static method in class io.jenkins.plugins.batchcontrol.security.GrantService
Clears the in-memory cache.
resolve(String, String) - Method in class io.jenkins.plugins.batchcontrol.ops.IncidentService
ACKNOWLEDGED -> RESOLVED only (SPEC section 4: OPEN must pass ACKNOWLEDGED first).
RESOLVED - Enum constant in enum class io.jenkins.plugins.batchcontrol.model.IncidentStatus
 
resolveId(Path, String, String) - Static method in class io.jenkins.plugins.batchcontrol.store.PathCodec
The file <id><suffix> under baseDir of the entity id (S-39-01).
resolveUnder(Path, String) - Static method in class io.jenkins.plugins.batchcontrol.store.PathCodec
Resolves fileName under baseDir, guaranteeing the result cannot escape.
restore(String, ChangeType, String, String, Instant, String, String, String) - Static method in class io.jenkins.plugins.batchcontrol.model.ChangeRecord
Rebuilds a record from stored fields (used by the store when reading JSONL).
restriction(Grant) - Method in class io.jenkins.plugins.batchcontrol.action.FolderCreateWindowAction
The allowed names of a window in words: the exact name or pattern, or null for any.
result() - Method in record class io.jenkins.plugins.batchcontrol.store.IncidentSummary
Returns the value of the result record component.
RETENTION - Enum constant in enum class io.jenkins.plugins.batchcontrol.model.ChangeType
 
RetentionPeriodicWork - Class in io.jenkins.plugins.batchcontrol.ops
Daily retention cleanup (SPEC item 12): deletes every month bucket older than the configured retentionMonths — the runs and changes JSONL files, that month's diff patches, and that month's incidents (index + XMLs) — and records each deleted month as ChangeRecord(type=RETENTION) identifying the month as YYYY-MM.
RetentionPeriodicWork() - Constructor for class io.jenkins.plugins.batchcontrol.ops.RetentionPeriodicWork
 
RetentionResult - Record Class in io.jenkins.plugins.batchcontrol.store
What one retention pass over the XML entities deleted.
RetentionResult(int, int, List<String>) - Constructor for record class io.jenkins.plugins.batchcontrol.store.RetentionResult
The form without activation requests.
RetentionResult(int, int, List<String>, int) - Constructor for record class io.jenkins.plugins.batchcontrol.store.RetentionResult
Creates an instance of a RetentionResult record class.
retry() - Static method in class io.jenkins.plugins.batchcontrol.listener.UnsavedItemWrites
Saves every listed item again (called by the periodic work, which runs as SYSTEM).
retryUnsavedExecutions() - Method in class io.jenkins.plugins.batchcontrol.policy.RunRequestService
Writes the EXECUTED states that could not be written when their build started (RunRequestService.markExecuted(java.lang.String, java.lang.String)), with the deletion of the typed values file that goes with them.
retryUnsavedQueueCancels() - Method in class io.jenkins.plugins.batchcontrol.policy.RunRequestService
T-GAP-384, D-72b (7): writes the queue cancellations that could not be written when they happened (RunRequestService.recordQueueCancelled(java.lang.String, java.lang.String)), with the deletion of the typed values file that goes with them.
REUSE_ALERT_LIMIT - Static variable in class io.jenkins.plugins.batchcontrol.action.HistorySection
How many blocked marker re-use attempts the always-visible alert lists at most.
reviewed(String) - Static method in class io.jenkins.plugins.batchcontrol.ui.GuardInfo
After "Mark as reviewed" of itemFullName: the outcome, or null when the name does not resolve (as the viewer) or the item is still listed as changed itself, so that a hand-edited query string never produces a confirmation that is not true now.
reviewOutcome(String) - Method in class io.jenkins.plugins.batchcontrol.action.BatchControlRootAction
For the monitor's reviewed view: what still guards the item after it was marked as reviewed, or null when that is not true now.
revoke(String) - Method in class io.jenkins.plugins.batchcontrol.security.GrantService
Immediately revokes a grant (SPEC item 8: Manage holders only — the web action checks; the service double-checks) and appends a ChangeRecord(GRANT_REVOKE).
revokeAllActive() - Method in class io.jenkins.plugins.batchcontrol.security.GrantService
S-15, the kill switch: revokes every grant that is active right now and returns how many were closed.
REVOKED_CHANGE_CONTROL_OFF - Static variable in class io.jenkins.plugins.batchcontrol.model.Grant
P-15: the revocation reason of the windows closed by turning change control off.
REVOKED_ITEM_DELETED - Static variable in class io.jenkins.plugins.batchcontrol.model.Grant
D-74: the revocation reason of a window whose item was deleted (or no longer exists).
REVOKED_ITEM_NOT_FOLLOWED - Static variable in class io.jenkins.plugins.batchcontrol.model.Grant
S-39-02: the revocation reason of a window that could not follow its renamed or moved item for certain (its file could not be updated, another item had already taken the old name again, or another item has just taken the name the window gives).
REVOKED_UNCONFIRMED - Static variable in class io.jenkins.plugins.batchcontrol.model.Grant
S-39-03: the revocation reason of a window ended at startup because the change records could not all be read, so it could not be shown not to have ended before.
row(Object...) - Method in class io.jenkins.plugins.batchcontrol.ui.CsvWriter
Writes one row; each cell is sanitized and quoted as needed.
run(NotificationEvent, RunRequest) - Static method in class io.jenkins.plugins.batchcontrol.ops.NotificationDispatcher
Event for a run request.
RunApprovalNoticeAction - Class in io.jenkins.plugins.batchcontrol.action
The build-page counterpart of the job-page approval notice (SPEC item 6, e2e re-audit DEF-31): on every build of a job whose manual runs need an approved run request, the build page says so and links the run request form for a viewer who may submit it.
RunApprovalNoticeAction(Run<?, ?>) - Constructor for class io.jenkins.plugins.batchcontrol.action.RunApprovalNoticeAction
 
RunApprovalNoticeActionFactory - Class in io.jenkins.plugins.batchcontrol.action
Attaches RunApprovalNoticeAction to the builds of a job whose manual runs need an approved request (e2e re-audit DEF-31), and to no build while run control is off or the job needs no approval (S-18-06).
RunApprovalNoticeActionFactory() - Constructor for class io.jenkins.plugins.batchcontrol.action.RunApprovalNoticeActionFactory
 
runEnded(NotificationEvent, RunRequest, boolean, String) - Static method in class io.jenkins.plugins.batchcontrol.ops.NotificationDispatcher
D-54: NotificationEvent.CANCELLED, NotificationEvent.EXPIRED or NotificationEvent.INVALIDATED for a run request that ended without a decision.
runId() - Method in record class io.jenkins.plugins.batchcontrol.store.IncidentSummary
Returns the value of the runId record component.
RunLinks - Class in io.jenkins.plugins.batchcontrol.ui
Builds root-relative build URLs from stored identifiers, and small display helpers shared by the dashboard/incident/history views.
runMonthStats(YearMonth) - Method in class io.jenkins.plugins.batchcontrol.store.FileStore
 
runMonthStats(YearMonth) - Method in interface io.jenkins.plugins.batchcontrol.store.Store
Run counters of one month, maintained incrementally from the bucket.
RunMonthStats - Record Class in io.jenkins.plugins.batchcontrol.store
Per-month run counters for the history summary, maintained incrementally from the append-only runs/YYYY-MM.jsonl bucket: a summary request only reads the bytes appended since the previous one.
RunMonthStats(long, long, long, long) - Constructor for record class io.jenkins.plugins.batchcontrol.store.RunMonthStats
Creates an instance of a RunMonthStats record class.
RunRecord - Class in io.jenkins.plugins.batchcontrol.model
Summary of one build execution (SPEC section 3).
RunRecord(String, String, int, CauseType, String, Instant, long) - Constructor for class io.jenkins.plugins.batchcontrol.model.RunRecord
 
RunRecordListener - Class in io.jenkins.plugins.batchcontrol.listener
Appends a RunRecord for EVERY completed build — Freestyle, Pipeline and multibranch children alike (SPEC item 10) — and drives the SPEC item 11 automatics: incident registration and the successful-rerun resolvedByRunId link.
RunRecordListener() - Constructor for class io.jenkins.plugins.batchcontrol.listener.RunRecordListener
 
RunRequest - Class in io.jenkins.plugins.batchcontrol.model
A request to run a specific job with a fixed set of parameters (SPEC section 3).
RunRequest.ApproverChange - Class in io.jenkins.plugins.batchcontrol.model
One approver change entry: (previous set, new set, changed by, at) (SPEC item 3, D-37).
RunRequestExecutionListener - Class in io.jenkins.plugins.batchcontrol.listener
Completes the APPROVED → EXECUTED transition (SPEC section 4): when a build carrying the approval marker starts, the linked request is marked EXECUTED with the run id (jobFullName#number).
RunRequestExecutionListener() - Constructor for class io.jenkins.plugins.batchcontrol.listener.RunRequestExecutionListener
 
runRequests() - Method in record class io.jenkins.plugins.batchcontrol.store.RetentionResult
Returns the value of the runRequests record component.
RunRequestService - Class in io.jenkins.plugins.batchcontrol.policy
The single entry point for every RunRequest state transition (SPEC items 3, 5, 7; D-20/D-21/D-22/D-23).
RunRequestValues - Class in io.jenkins.plugins.batchcontrol.model
The typed parameter values of one run request (D-72, D-74), persisted with XStream at requests/run/<id>.values.xml, next to the request file, as core keeps parameter values in build.xml: a Secret field is written in Jenkins' encrypted form.
RunRequestValues(String, List<ParameterValue>) - Constructor for class io.jenkins.plugins.batchcontrol.model.RunRequestValues
 
runs() - Method in record class io.jenkins.plugins.batchcontrol.store.RunMonthStats
Returns the value of the runs record component.
runUrl(Incident) - Method in class io.jenkins.plugins.batchcontrol.action.IncidentsSection
Root-relative build URL for the incident's originating run, or null for plain text (D-44).
runUrl(RunRecord) - Method in class io.jenkins.plugins.batchcontrol.action.DashboardSection
Root-relative build URL (job/a/job/b/12/), or null for plain text (D-44).
runUrl(RunRecord) - Method in class io.jenkins.plugins.batchcontrol.action.HistorySection
Root-relative build URL for a run record, or null for plain text (D-44).
runUrl(String, int) - Static method in class io.jenkins.plugins.batchcontrol.ui.RunLinks
 
runUrl(String, int) - Static method in class io.jenkins.plugins.batchcontrol.ui.Visibility
The one run-link rule of every Batch Control screen (D-44): a run links to its build page only when the viewer holds Item/Read on the job; otherwise the view renders the run as plain text, and a build that has been deleted since is plain text too (e2e-03 DEF-23).
runUrlFromRunId(String) - Static method in class io.jenkins.plugins.batchcontrol.ui.RunLinks
Builds the run URL from a stored run id of the form jobFullName#number.
runUrlFromRunId(String) - Static method in class io.jenkins.plugins.batchcontrol.ui.Visibility
Visibility.runUrl(String, int) for a stored run id of the form jobFullName#number.

S

sameUser(String, String) - Static method in class io.jenkins.plugins.batchcontrol.model.Approvers
Whether two user ids name the same user under Jenkins' configured user id strategy (SPEC item 3; security-08 S-12), for example case-insensitively by default.
save() - Method in class io.jenkins.plugins.batchcontrol.config.BatchControlGlobalConfiguration
S-25-06: a detached draft or candidate is never written to config.xml.
saveActivationRequest(ActivationRequest) - Method in class io.jenkins.plugins.batchcontrol.store.FileStore
 
saveActivationRequest(ActivationRequest) - Method in interface io.jenkins.plugins.batchcontrol.store.Store
Writes (or rewrites, on a status transition) the activation request XML atomically.
saveActivationState(ActivationState) - Method in class io.jenkins.plugins.batchcontrol.store.FileStore
 
saveActivationState(ActivationState) - Method in interface io.jenkins.plugins.batchcontrol.store.Store
Writes the activation state of a job atomically to activations/<PathCodec-encoded full name>.xml; the file name comes from ActivationState.getJobFullName().
saveConfigSnapshot(String, String) - Method in class io.jenkins.plugins.batchcontrol.store.FileStore
 
saveConfigSnapshot(String, String) - Method in interface io.jenkins.plugins.batchcontrol.store.Store
Stores the latest config.xml snapshot of a job (diff baseline; only the latest version is kept, ARCHITECTURE section 5).
saveGrant(Grant) - Method in class io.jenkins.plugins.batchcontrol.store.FileStore
 
saveGrant(Grant) - Method in interface io.jenkins.plugins.batchcontrol.store.Store
Writes (or rewrites, on revocation) the grant XML atomically.
saveGrantRequest(GrantRequest) - Method in class io.jenkins.plugins.batchcontrol.store.FileStore
 
saveGrantRequest(GrantRequest) - Method in interface io.jenkins.plugins.batchcontrol.store.Store
Writes (or rewrites, on a status transition) the grant request XML atomically.
saveIncident(Incident) - Method in class io.jenkins.plugins.batchcontrol.store.FileStore
 
saveIncident(Incident) - Method in interface io.jenkins.plugins.batchcontrol.store.Store
Rewrites an existing incident's XML atomically (handling transitions, links).
saveNewRunRequest(RunRequest, List<ParameterValue>) - Method in class io.jenkins.plugins.batchcontrol.store.FileStore
Stores a new request (D-72, D-74): <id>.xml, then its typed values in <id>.values.xml when there are any (a request without parameters has no values file).
saveNewRunRequest(RunRequest, List<ParameterValue>) - Method in interface io.jenkins.plugins.batchcontrol.store.Store
Stores a new request (D-72, D-74): <id>.xml, then its typed values in <id>.values.xml when there are any (a request without parameters has no values file).
saveRunRequest(RunRequest) - Method in class io.jenkins.plugins.batchcontrol.store.FileStore
 
saveRunRequest(RunRequest) - Method in interface io.jenkins.plugins.batchcontrol.store.Store
Writes (or rewrites, on a status transition) the request XML <id>.xml atomically.
SaveStart() - Constructor for class io.jenkins.plugins.batchcontrol.listener.ConfigSnapshotListener.SaveStart
 
SCAN - Static variable in class io.jenkins.plugins.batchcontrol.action.DashboardSection
Records read at most, newest appended first.
SCM - Enum constant in enum class io.jenkins.plugins.batchcontrol.model.CauseType
 
ScopeDisplay - Class in io.jenkins.plugins.batchcontrol.ui
D-75 (1), security-39 S-39-04 (SPEC item 8): the name a screen shows for the item of a grant request or permission window (tags/scopeItem.jelly).
SecretMasker - Class in io.jenkins.plugins.batchcontrol.store
Masks secret material in config XML text BEFORE it is diffed or stored (SPEC item 9: "unified diff with secrets masked").
SectionAccess - Class in io.jenkins.plugins.batchcontrol.ui
The permissions each Batch Control screen requires, in one place (SPEC item 2, hosting review).
SectionAccess() - Constructor for class io.jenkins.plugins.batchcontrol.ui.SectionAccess
 
SectionTabs - Class in io.jenkins.plugins.batchcontrol.ui
The tabs of the Batch Control page (hosting review 2026-10-02, PR6): one entry per section the current user may open, in a fixed order.
SectionTabs.Tab - Class in io.jenkins.plugins.batchcontrol.ui
One tab: a section of /batch-control/.
seed() - Static method in class io.jenkins.plugins.batchcontrol.ops.ActivationSeeding
 
SEEDED - Enum constant in enum class io.jenkins.plugins.batchcontrol.listener.ConfigSnapshotListener.Seeding
The item's configuration was stored as its snapshot: it had none or, when refreshing, the snapshot differed from the configuration (or could not be read).
seedExistingJobs() - Method in class io.jenkins.plugins.batchcontrol.policy.ActivationService
One-time upgrade seeding: when activations/.schema is absent, every job that exists now (other than a computed child, D-32) is recorded as activated with activatedBy = upgrade and one ChangeType.ACTIVATED record, and then the marker is written.
seedIfMissing(Item) - Static method in class io.jenkins.plugins.batchcontrol.listener.ConfigSnapshotListener
Stores the current configuration of item as its baseline if no snapshot of it is stored (SPEC item 9), for SnapshotSeeding.
selectedRunId(ParameterDefinition) - Method in class io.jenkins.plugins.batchcontrol.action.JobRequestAction
T-06-103 (D-60, DEF-09): the run the form shows selected for the run parameter definition, or null to render the definition's own view (RequestRunPrefill.selectedRunId(hudson.model.ParameterDefinition); core's view does not show a carried run).
selectedRunId(ParameterDefinition) - Static method in class io.jenkins.plugins.batchcontrol.ui.RequestRunPrefill
T-06-103: the run the Request Run form must show selected for definition, or null when the definition's own view is right.
SelfGrantRevertedFailure - Exception Class in io.jenkins.plugins.batchcontrol.ui
Tells the saving user that the guard reverted the authorization part of their save (SPEC item 2, D-48, D-58a, D-58b): the item is guarded because a permission window covers it or it was changed under one and not yet reviewed, so a widening of its authorization is undone whoever saves it.
SelfGrantRevertedFailure(Item) - Constructor for exception class io.jenkins.plugins.batchcontrol.ui.SelfGrantRevertedFailure
 
SelfGrantRevertFilter - Class in io.jenkins.plugins.batchcontrol.listener
Tells the saving user when the D-35b guard reverted part of their save (SPEC item 2, D-48, e2e-03 DEF-35).
SelfGrantRevertFilter() - Constructor for class io.jenkins.plugins.batchcontrol.listener.SelfGrantRevertFilter
 
setAbortedBy(String) - Method in class io.jenkins.plugins.batchcontrol.model.RunRecord
 
setAllowAdminSelfApproval(boolean) - Method in class io.jenkins.plugins.batchcontrol.config.BatchControlGlobalConfiguration
 
setAllowedUpstreamJobs(List<String>) - Method in class io.jenkins.plugins.batchcontrol.config.BatchControlJobProperty
 
setAllowedUpstreamJobsText(String) - Method in class io.jenkins.plugins.batchcontrol.config.BatchControlJobProperty
 
setAppendedAt(Instant) - Method in class io.jenkins.plugins.batchcontrol.model.RunRecord
 
setApprovedRunTimeoutMinutes(int) - Method in class io.jenkins.plugins.batchcontrol.config.BatchControlGlobalConfiguration
 
setApprovers(List<String>) - Method in class io.jenkins.plugins.batchcontrol.config.BatchControlGlobalConfiguration
 
setApprovers(List<String>) - Method in class io.jenkins.plugins.batchcontrol.model.ActivationRequest
Only the policy service changes the designated set.
setApprovers(List<String>) - Method in class io.jenkins.plugins.batchcontrol.model.GrantRequest
Only the policy services change the designated set.
setApprovers(List<String>) - Method in class io.jenkins.plugins.batchcontrol.model.RunRequest
Only the policy services change the designated set.
setApproversText(String) - Method in class io.jenkins.plugins.batchcontrol.config.BatchControlGlobalConfiguration
 
setBlockTimer(boolean) - Method in class io.jenkins.plugins.batchcontrol.config.BatchControlJobProperty
 
setBlockUpstream(boolean) - Method in class io.jenkins.plugins.batchcontrol.config.BatchControlJobProperty
 
setChangeControlEnabled(boolean) - Method in class io.jenkins.plugins.batchcontrol.config.BatchControlGlobalConfiguration
S-15: turning change control off is a kill switch, not just a stop on new windows.
setChangedItems(List<String>) - Method in class io.jenkins.plugins.batchcontrol.model.Grant
Replaces the changed-items list (D-58a).
setCreatedItems(List<String>) - Method in class io.jenkins.plugins.batchcontrol.model.Grant
Replaces the created-items list (D-35c).
setDecidedAt(Instant) - Method in class io.jenkins.plugins.batchcontrol.model.ActivationRequest
 
setDecidedAt(Instant) - Method in class io.jenkins.plugins.batchcontrol.model.GrantRequest
 
setDecidedAt(Instant) - Method in class io.jenkins.plugins.batchcontrol.model.RunRequest
 
setDecidedBy(String) - Method in class io.jenkins.plugins.batchcontrol.model.ActivationRequest
Only the policy service records the deciding approver.
setDecidedBy(String) - Method in class io.jenkins.plugins.batchcontrol.model.GrantRequest
Only the policy services record the deciding approver.
setDecidedBy(String) - Method in class io.jenkins.plugins.batchcontrol.model.RunRequest
Only the policy services record the deciding approver.
setDecisionComment(String) - Method in class io.jenkins.plugins.batchcontrol.model.ActivationRequest
 
setDecisionComment(String) - Method in class io.jenkins.plugins.batchcontrol.model.GrantRequest
 
setDecisionComment(String) - Method in class io.jenkins.plugins.batchcontrol.model.RunRequest
 
setDiff(String) - Method in class io.jenkins.plugins.batchcontrol.model.ChangeRecord
 
setEmailNotifications(boolean) - Method in class io.jenkins.plugins.batchcontrol.config.BatchControlGlobalConfiguration
 
setExecutedAt(Instant) - Method in class io.jenkins.plugins.batchcontrol.model.RunRequest
 
setExecutedRunId(String) - Method in class io.jenkins.plugins.batchcontrol.model.RunRequest
 
setExpiringNotified(boolean) - Method in class io.jenkins.plugins.batchcontrol.model.ActivationRequest
Only the policy service marks the D-36 EXPIRING notification as sent.
setExpiringNotified(boolean) - Method in class io.jenkins.plugins.batchcontrol.model.Grant
Only security.GrantService marks the notification as sent.
setExpiringNotified(boolean) - Method in class io.jenkins.plugins.batchcontrol.model.GrantRequest
Only the policy services mark the D-36 EXPIRING notification as sent.
setExpiringNotified(boolean) - Method in class io.jenkins.plugins.batchcontrol.model.RunRequest
Only the policy services mark the D-36 EXPIRING notification as sent.
setExpiryBase(Instant) - Method in class io.jenkins.plugins.batchcontrol.model.RunRequest
 
setForTest(Clock) - Static method in class io.jenkins.plugins.batchcontrol.store.BatchClock
Installs a fixed/offset clock for tests.
setGrantDurationOptions(List<Integer>) - Method in class io.jenkins.plugins.batchcontrol.config.BatchControlGlobalConfiguration
 
setGrantDurationOptionsText(String) - Method in class io.jenkins.plugins.batchcontrol.config.BatchControlGlobalConfiguration
 
setGrantId(String) - Method in class io.jenkins.plugins.batchcontrol.model.ChangeRecord
 
setIncidentId(String) - Method in class io.jenkins.plugins.batchcontrol.model.RunRequest
 
setIncidentResults(List<String>) - Method in class io.jenkins.plugins.batchcontrol.config.BatchControlGlobalConfiguration
 
setIncidentResultsText(String) - Method in class io.jenkins.plugins.batchcontrol.config.BatchControlGlobalConfiguration
 
setInvalidationReason(String) - Method in class io.jenkins.plugins.batchcontrol.model.RunRequest
 
setJobApprovers(List<String>) - Method in class io.jenkins.plugins.batchcontrol.config.BatchControlJobProperty
 
setJobApproversText(String) - Method in class io.jenkins.plugins.batchcontrol.config.BatchControlJobProperty
 
setLogTail(List<String>) - Method in class io.jenkins.plugins.batchcontrol.model.Incident
 
setMaxGrantMinutes(int) - Method in class io.jenkins.plugins.batchcontrol.config.BatchControlGlobalConfiguration
 
setNotifyBeforeExpiryMinutes(int) - Method in class io.jenkins.plugins.batchcontrol.config.BatchControlGlobalConfiguration
 
setParameters(Map<String, String>) - Method in class io.jenkins.plugins.batchcontrol.model.Incident
 
setParameters(Map<String, String>) - Method in class io.jenkins.plugins.batchcontrol.model.RunRecord
 
setPendingTimeoutHours(int) - Method in class io.jenkins.plugins.batchcontrol.config.BatchControlGlobalConfiguration
 
setQueueCancelledAt(Instant) - Method in class io.jenkins.plugins.batchcontrol.model.RunRequest
Only the policy service records the cancellation of the approved run's queue item.
setQueuedAt(Instant) - Method in class io.jenkins.plugins.batchcontrol.model.RunRequest
Only the policy service claims (non-null) or re-issues (null) the ticket.
setResolvedByRunId(String) - Method in class io.jenkins.plugins.batchcontrol.model.Incident
 
setRetentionMonths(int) - Method in class io.jenkins.plugins.batchcontrol.config.BatchControlGlobalConfiguration
 
setRunControlEnabled(boolean) - Method in class io.jenkins.plugins.batchcontrol.config.BatchControlGlobalConfiguration
Direct switch change (JCasC, script console).
setRunRequestId(String) - Method in class io.jenkins.plugins.batchcontrol.model.RunRecord
 
setRunTimestampMillis(Long) - Method in class io.jenkins.plugins.batchcontrol.model.Incident
Only ops.IncidentService records the failed build's timestamp, when it opens the incident.
setSelfApproved(boolean) - Method in class io.jenkins.plugins.batchcontrol.model.ActivationRequest
 
setSelfApproved(boolean) - Method in class io.jenkins.plugins.batchcontrol.model.RunRequest
 
setStatus(IncidentStatus) - Method in class io.jenkins.plugins.batchcontrol.model.Incident
Only ops.IncidentService may transition the status.
setStatus(RequestStatus) - Method in class io.jenkins.plugins.batchcontrol.model.ActivationRequest
Only the policy service may transition the status.
setStatus(RequestStatus) - Method in class io.jenkins.plugins.batchcontrol.model.GrantRequest
Only the policy services may transition the status.
setStatus(RequestStatus) - Method in class io.jenkins.plugins.batchcontrol.model.RunRequest
Only the policy services may transition the status.
setUser(String) - Method in class io.jenkins.plugins.batchcontrol.model.RunRecord
 
shouldSchedule(Queue.Task, List<Action>) - Method in class io.jenkins.plugins.batchcontrol.queue.ApprovalQueueDecisionHandler
 
shouldSchedule(List<Action>) - Method in class io.jenkins.plugins.batchcontrol.queue.ApprovedRunAction
Always a separate queue item (S-26-01).
showPermission(String, Permission) - Method in class io.jenkins.plugins.batchcontrol.security.BatchControlRoleBasedAuthorizationStrategy.DescriptorImpl
Whether a permission is shown for a role type.
shutdown() - Static method in class io.jenkins.plugins.batchcontrol.ops.NotificationDispatcher
Stops the notifier thread when Jenkins shuts down: no new work is accepted, pending notifications are discarded, and a running delivery gets a short grace period before it is interrupted.
SKIPPED - Enum constant in enum class io.jenkins.plugins.batchcontrol.listener.ConfigSnapshotListener.Seeding
Not seeded on purpose: it has no configuration file, it is not (or no longer) in its parent, a save of it is being reported (that save stores the baseline), or a newer refresh started.
slice(List<T>, int) - Static method in class io.jenkins.plugins.batchcontrol.ui.Paging
The rows of page out of a fully materialised, already sorted list (a copy).
SnapshotSeeding - Class in io.jenkins.plugins.batchcontrol.ops
Keeps the configuration snapshots (the CONFIGURE diff baselines, ARCHITECTURE section 5) in step with the items when change recording becomes active (SPEC item 9).
span(long) - Static method in class io.jenkins.plugins.batchcontrol.ui.Dates
A length of time in the one span vocabulary the plugin uses (3 min 20 sec).
startRefresh(Jenkins, Iterable<? extends Item>) - Static method in class io.jenkins.plugins.batchcontrol.listener.ConfigSnapshotListener
Starts the refresh of every snapshot of items after change recording was turned on (SPEC item 9), replacing any earlier refresh.
StartupRecovery - Class in io.jenkins.plugins.batchcontrol.ops
Restart durability (SPEC item 4): after every startup, APPROVED requests that never executed are re-submitted exactly once (idempotent via the consumption ticket and the restored-queue/existing-build checks in the policy service).
stateLabel(Item) - Static method in class io.jenkins.plugins.batchcontrol.ui.ActivationView
"activated", "on hold" or "not activated", as the screens word the three states.
status() - Method in record class io.jenkins.plugins.batchcontrol.store.RequestSummary
Returns the value of the status record component.
Store - Interface in io.jenkins.plugins.batchcontrol.store
Durable, build-independent plugin store under $JENKINS_HOME/batch-control/ (layout in docs/ARCHITECTURE.md section 5).
storedText(ParameterValue) - Static method in class io.jenkins.plugins.batchcontrol.store.ParameterDisplay
D-72b (2): the text a non-file value stores, which the length and character limits apply to: the plaintext of a Secret (a password included, although it is displayed masked), otherwise String.valueOf(value.getValue()), "" for null.
StoreWriteException - Exception Class in io.jenkins.plugins.batchcontrol.store
D-72b (2), security-35 S-35-03: an entity could not be written (an I/O failure, or content the XML writer refused).
StoreWriteException(String, Throwable) - Constructor for exception class io.jenkins.plugins.batchcontrol.store.StoreWriteException
 
STRATEGY_CHANGE - Enum constant in enum class io.jenkins.plugins.batchcontrol.model.ChangeType
A Batch Control authorization strategy was installed (migrated to) or reverted (D-52).
STRATEGY_CHANGE_TARGET - Static variable in class io.jenkins.plugins.batchcontrol.ops.BatchControlStrategyMonitor
The target of a ChangeType.STRATEGY_CHANGE record (D-52).
StrategyMigration - Class in io.jenkins.plugins.batchcontrol.security
Copies between a plain supported strategy and its Batch Control subclass (D-35a, D-35d): the migration action and its reverse.
submitQuery(boolean) - Method in class io.jenkins.plugins.batchcontrol.action.JobRequestAction
D-66, D-72a: the query string of the request form's action, with its ?, or empty: dialog=true for the dialog form (Dialogs.fromDialogQuery(jakarta.servlet.http.HttpServletRequest)) and "fromRerun"=<id> when the form continues an incident rerun (JobRequestAction.getRerunIncidentId(), already validated).
success() - Method in record class io.jenkins.plugins.batchcontrol.store.RunMonthStats
Returns the value of the success record component.
summaryLabel(String) - Method in class io.jenkins.plugins.batchcontrol.action.HistorySection
The label of a monthly summary row; an unknown key is shown as it is.
svg(String, String) - Static method in class io.jenkins.plugins.batchcontrol.ui.KindIcon
The inline SVG of iconClassName with the CSS classes classes, or an empty string when the class is not a symbol or the symbol cannot be rendered.
swapStoreForTesting(Store) - Static method in class io.jenkins.plugins.batchcontrol.store.BlockedAttemptAudit
Test seam (S-24-04): replaces the store this class appends to and returns the previous one, so a test can make appends fail and restore the real store afterwards.
SystemBuildCheck - Class in io.jenkins.plugins.batchcontrol.security
D-50, D-50a (SPEC item 2, e2e-03 DEF-37, security-21): whether builds on this instance may run as SYSTEM although change control is on.

T

text(ParameterValue) - Static method in class io.jenkins.plugins.batchcontrol.store.ParameterDisplay
The masked display text of one value (see the class description).
text(StaplerRequest2, String) - Static method in class io.jenkins.plugins.batchcontrol.ui.RepeatedField
R4-03: the value of the plain text field field as the user typed it, or null when the request has no such field.
TIMER - Enum constant in enum class io.jenkins.plugins.batchcontrol.model.CauseType
 
toBatchControl(AuthorizationStrategy) - Static method in class io.jenkins.plugins.batchcontrol.security.StrategyMigration
The Batch Control subclass with every entry of strategy, or null when StrategyMigration.isMigratable(hudson.security.AuthorizationStrategy) is false or the plugin is not installed.
toExclusive() - Method in record class io.jenkins.plugins.batchcontrol.store.Period
Returns the value of the toExclusive record component.
toInstantExclusive() - Method in class io.jenkins.plugins.batchcontrol.ui.FilterParser.Filter
End of the range (exclusive: start of the day after to).
toPlain(AuthorizationStrategy) - Static method in class io.jenkins.plugins.batchcontrol.security.StrategyMigration
The plain parent strategy with every entry of a Batch Control strategy, or null if it is not one.
toPlainStrategy() - Method in class io.jenkins.plugins.batchcontrol.security.BatchControlMatrixAuthorizationStrategy
 
toPlainStrategy() - Method in class io.jenkins.plugins.batchcontrol.security.BatchControlRoleBasedAuthorizationStrategy
 
toPlainStrategy() - Method in interface io.jenkins.plugins.batchcontrol.security.GrantLayeredStrategy
A plain instance of the parent strategy with every entry of this one: the uninstall path of the migration action (D-35a).
toQuery(Map<String, String>) - Static method in class io.jenkins.plugins.batchcontrol.ui.RequestRunPrefill
?p.A=1&p.B=x for the given values, or the empty string for none.
toQueryString() - Method in class io.jenkins.plugins.batchcontrol.ui.FilterParser.Filter
The filter as a URL query fragment (from=...&to=..., plus the optional parameters when present), for paging and CSV export links.
toRoot(String) - Static method in class io.jenkins.plugins.batchcontrol.ui.Dialogs
../ once per path segment of an item URL (job/a/job/b/), the way from the item's page back to the Jenkins root (which carries the context path, if any).
toString() - Method in class io.jenkins.plugins.batchcontrol.model.CreateNamePattern
 
toString() - Method in class io.jenkins.plugins.batchcontrol.model.GrantScope
 
toString() - Method in class io.jenkins.plugins.batchcontrol.model.ItemKind
 
toString() - Method in class io.jenkins.plugins.batchcontrol.model.PendingCount
 
toString() - Method in class io.jenkins.plugins.batchcontrol.ops.Notification
 
toString() - Method in record class io.jenkins.plugins.batchcontrol.store.IncidentSummary
Returns a string representation of this record class.
toString() - Method in record class io.jenkins.plugins.batchcontrol.store.Period
Returns a string representation of this record class.
toString() - Method in record class io.jenkins.plugins.batchcontrol.store.RequestSummary
Returns a string representation of this record class.
toString() - Method in record class io.jenkins.plugins.batchcontrol.store.RetentionResult
Returns a string representation of this record class.
toString() - Method in record class io.jenkins.plugins.batchcontrol.store.RunMonthStats
Returns a string representation of this record class.
TRIGGER_BLOCKED - Enum constant in enum class io.jenkins.plugins.batchcontrol.model.ChangeType
An unattended run submission (timer, upstream) or a Pipeline Replay refused quietly by the queue gate (SPEC item 6).
type() - Method in class io.jenkins.plugins.batchcontrol.action.ComputedFolderActivationActionFactory
 
type() - Method in class io.jenkins.plugins.batchcontrol.action.FolderCreateWindowActionFactory
 
type() - Method in class io.jenkins.plugins.batchcontrol.action.JobNoticesWidget.FactoryImpl
 
type() - Method in class io.jenkins.plugins.batchcontrol.action.JobRequestActionFactory
 
type() - Method in class io.jenkins.plugins.batchcontrol.action.RunApprovalNoticeActionFactory
 

U

UNCONTROLLED - Static variable in class io.jenkins.plugins.batchcontrol.model.ActivationState
ActivationState.getActivatedBy() of a job created while run control was off (D-45); see ActivationState.UPGRADE.
UnifiedDiff - Class in io.jenkins.plugins.batchcontrol.store
Minimal unified-diff generator for config.xml change records (SPEC item 9).
unmarshal(HierarchicalStreamReader, UnmarshallingContext) - Method in class io.jenkins.plugins.batchcontrol.security.BatchControlMatrixAuthorizationStrategy.ConverterImpl
 
unmarshal(HierarchicalStreamReader, UnmarshallingContext) - Method in class io.jenkins.plugins.batchcontrol.security.BatchControlRoleBasedAuthorizationStrategy.ConverterImpl
 
UnsavedItemWrites - Class in io.jenkins.plugins.batchcontrol.listener
Items whose configuration in memory carries a fail-closed change that could not be saved: the D-34 lock of a new or moved job (SPEC item 8, ItemChangeListener.applyActivationLock(hudson.model.Job<?, ?>, java.lang.String, java.lang.String)) or the removal of an authorization property a grant holder's creation payload carried (SPEC item 2, D-35c, GrantViolationGuard).
unstable() - Method in record class io.jenkins.plugins.batchcontrol.store.RunMonthStats
Returns the value of the unstable record component.
until(Instant) - Static method in class io.jenkins.plugins.batchcontrol.ui.Dates
How much time is left until instant, read off the BatchClock like every other time read in the plugin.
UPGRADE - Static variable in class io.jenkins.plugins.batchcontrol.model.ActivationState
ActivationState.getActivatedBy() of a job that existed when the plugin version was first installed.
uploadedSize(StaplerRequest2, Collection<String>) - Static method in class io.jenkins.plugins.batchcontrol.policy.RequestBodyLimit
The size in bytes of the uploaded parts of req named by partNames, the parts a parameter definition's createValue reads: for core's form, every top-level value of the parameter's json entry as text (RequestBodyLimit.partNames(JSONObject), a file parameter names its part in file); for a scripted submission without json, the parameter's own name.
UPSTREAM - Enum constant in enum class io.jenkins.plugins.batchcontrol.model.CauseType
 
url(String, String) - Static method in class io.jenkins.plugins.batchcontrol.ui.GrantRequestLinks
Root-relative URL of the prefilled form, or null when the item is not visible to the viewer, cannot be named by a window (the Jenkins root, a sub-item of a job), the action is not one a window can carry, or it cannot apply to the item (D-71).
URL_NAME - Static variable in class io.jenkins.plugins.batchcontrol.config.BatchControlConfigurationLink
URL of the page, relative to the Jenkins root (and to /manage/).
USER - Enum constant in enum class io.jenkins.plugins.batchcontrol.model.CauseType
 

V

validDestinations(Item) - Method in class io.jenkins.plugins.batchcontrol.security.ChangeControlledRelocationHandler
 
value(String) - Method in class io.jenkins.plugins.batchcontrol.ui.FormErrors
What the user submitted in field; empty when nothing is being refused.
valueOf(String) - Static method in enum class io.jenkins.plugins.batchcontrol.listener.ConfigSnapshotListener.Seeding
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.jenkins.plugins.batchcontrol.model.ActivationRequest.Action
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.jenkins.plugins.batchcontrol.model.CauseType
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.jenkins.plugins.batchcontrol.model.ChangeType
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.jenkins.plugins.batchcontrol.model.GrantAction
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.jenkins.plugins.batchcontrol.model.GrantScope.Type
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.jenkins.plugins.batchcontrol.model.IncidentStatus
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.jenkins.plugins.batchcontrol.model.RequestStatus
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.jenkins.plugins.batchcontrol.ops.NotificationEvent
Returns the enum constant of this class with the specified name.
values() - Static method in enum class io.jenkins.plugins.batchcontrol.listener.ConfigSnapshotListener.Seeding
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.jenkins.plugins.batchcontrol.model.ActivationRequest.Action
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.jenkins.plugins.batchcontrol.model.CauseType
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.jenkins.plugins.batchcontrol.model.ChangeType
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.jenkins.plugins.batchcontrol.model.GrantAction
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.jenkins.plugins.batchcontrol.model.GrantScope.Type
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.jenkins.plugins.batchcontrol.model.IncidentStatus
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.jenkins.plugins.batchcontrol.model.RequestStatus
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Method in class io.jenkins.plugins.batchcontrol.model.RunRequestValues
The values, unmodifiable; an element that could not be loaded may be null.
values() - Static method in enum class io.jenkins.plugins.batchcontrol.ops.NotificationEvent
Returns an array containing the constants of this enum class, in the order they are declared.
values(StaplerRequest2, JSONObject, String) - Static method in class io.jenkins.plugins.batchcontrol.ui.RepeatedField
 
VIEW_HISTORY - Static variable in class io.jenkins.plugins.batchcontrol.security.BatchControlPermissions
View history screens and CSV exports.
viewPermissions(Permission[], boolean) - Static method in class io.jenkins.plugins.batchcontrol.ui.SectionAccess
The l:layout permissions of a screen whose gate admits a user through hasOwn as well as through permissions: permissions for a holder of one of them, and none (the gate has already admitted the user) for a user who is there only for requests of their own, whom the Jenkins-level check would refuse.
Visibility - Class in io.jenkins.plugins.batchcontrol.ui
Per-object visibility predicates for the request and grant screens (P-09, security review S-01).

W

warmUp() - Method in class io.jenkins.plugins.batchcontrol.store.FileStore
Builds the entity index now (startup), so no later save pays for it.
warmUp() - Method in interface io.jenkins.plugins.batchcontrol.store.Store
Prepares derived in-memory data (indexes, caches) ahead of the first request so no later save pays for it.
Who sees it - Search tag in class io.jenkins.plugins.batchcontrol.action.FolderGrantRequestAction
Section
Who sees it - Search tag in class io.jenkins.plugins.batchcontrol.action.JobGrantRequestAction
Section
widgetType() - Method in class io.jenkins.plugins.batchcontrol.action.JobNoticesWidget.FactoryImpl
 
WindowItemListener - Class in io.jenkins.plugins.batchcontrol.security
D-74: permission windows follow their item, as matrix-auth's item permissions do.
WindowItemListener() - Constructor for class io.jenkins.plugins.batchcontrol.security.WindowItemListener
 
withActivationLock() - Method in class io.jenkins.plugins.batchcontrol.config.BatchControlJobProperty
These settings with the D-34 activation lock applied: every setting that decides whether a run may start is forced to its locked value, and the settings that decide nothing about starting a run are carried over.
withEarlierComment(String, String) - Static method in class io.jenkins.plugins.batchcontrol.policy.EndReasons
The decision comment of an expired request: the reason, followed by an approver's earlier comment when there is one (it is kept, not replaced).
withoutInput() - Method in class io.jenkins.plugins.batchcontrol.ui.FormErrors
D-72: the submission is refused without its input being read (its body is over the size cap, and reading a field would parse it), so the form is shown empty: FormErrors.value(java.lang.String) and FormErrors.checked(java.lang.String, java.lang.String) return nothing and the view may use its defaults.
writeForced(Path, byte[]) - Static method in class io.jenkins.plugins.batchcontrol.store.DurableFiles
Writes bytes to the (new, empty) temporary file tmp and forces them to disk; the caller then renames it onto its target and calls DurableFiles.forceDirectory(java.nio.file.Path).

X

XmlChars - Class in io.jenkins.plugins.batchcontrol.store
D-72b (2), security-35 S-35-03: the characters a stored text may contain.

_

_BatchControlGlobalConfiguration_DisplayName() - Static method in class io.jenkins.plugins.batchcontrol.Messages
Key BatchControlGlobalConfiguration.DisplayName: Batch Control.
_BatchControlJobProperty_DisplayName() - Static method in class io.jenkins.plugins.batchcontrol.Messages
Key BatchControlJobProperty.DisplayName: Batch Control.
_BatchControlMatrixAuthorizationStrategy_DisplayName() - Static method in class io.jenkins.plugins.batchcontrol.Messages
Key BatchControlMatrixAuthorizationStrategy.DisplayName: Batch Control: Project-based Matrix Authorization Strategy.
_BatchControlPermissions_ApproveDescription() - Static method in class io.jenkins.plugins.batchcontrol.Messages
Key BatchControlPermissions.ApproveDescription: Approve or reject run requests and grant requests..
_BatchControlPermissions_ManageDescription() - Static method in class io.jenkins.plugins.batchcontrol.Messages
Key BatchControlPermissions.ManageDescription: Manage the Batch Control global configuration and revoke grants. Implied by Overall/Administer..
_BatchControlPermissions_RequestDescription() - Static method in class io.jenkins.plugins.batchcontrol.Messages
Key BatchControlPermissions.RequestDescription: Create run requests for approval-protected jobs..
_BatchControlPermissions_RequestGrantDescription() - Static method in class io.jenkins.plugins.batchcontrol.Messages
Key BatchControlPermissions.RequestGrantDescription: Request temporary change permissions (JIT grants)..
_BatchControlPermissions_Title() - Static method in class io.jenkins.plugins.batchcontrol.Messages
Key BatchControlPermissions.Title: Batch Control.
_BatchControlPermissions_ViewHistoryDescription() - Static method in class io.jenkins.plugins.batchcontrol.Messages
Key BatchControlPermissions.ViewHistoryDescription: View batch control history, dashboards and CSV exports..
_BatchControlRoleBasedAuthorizationStrategy_DisplayName() - Static method in class io.jenkins.plugins.batchcontrol.Messages
Key BatchControlRoleBasedAuthorizationStrategy.DisplayName: Batch Control: Role-Based Strategy.
_BatchControlStrategyMonitor_DisplayName() - Static method in class io.jenkins.plugins.batchcontrol.Messages
Key BatchControlStrategyMonitor.DisplayName: Batch Control: grants need a Batch Control authorization strategy.
_ConfigureWithoutGrantMonitor_DisplayName() - Static method in class io.jenkins.plugins.batchcontrol.Messages
Key ConfigureWithoutGrantMonitor.DisplayName: Batch Control: standing change permissions bypass change control.
A B C D E F G H I J K L M N O P Q R S T U V W X _ 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form