Uses of Class
io.jenkins.plugins.batchcontrol.model.ActivationRequest
Packages that use ActivationRequest
Package
Description
-
Uses of ActivationRequest in io.jenkins.plugins.batchcontrol.action
Methods in io.jenkins.plugins.batchcontrol.action that return ActivationRequestMethods in io.jenkins.plugins.batchcontrol.action that return types with arguments of type ActivationRequestModifier and TypeMethodDescriptionActivationsSection.getActiveItems()Approved requests still in effect: the request that set its job's current activation state (ActivationState.getRequestId()), newest first.ActivationsSection.getEndedItems()Superseded, rejected, cancelled, expired and invalidated requests, newest first.ActivationsSection.getPendingItems()Pending requests on the current page, oldest first (closest to its timeout on top).ComputedFolderActivationAction.getPendingRequests()The PENDING requests of this folder the viewer may see (P-09).JobActivationForm.getPendingRequests()The PENDING requests of this job the viewer may see (P-09), oldest first.JobActivationNoticeAction.getPendingRequests()The PENDING requests of this job the viewer may see (P-09).Methods in io.jenkins.plugins.batchcontrol.action with parameters of type ActivationRequestModifier and TypeMethodDescriptionActivationsSection.endedLabel(ActivationRequest request) How an ended request ended, in words: a superseded approval says so.booleanActivationsSection.isAwaitingMyDecision(ActivationRequest request) Whether the viewer is a designated approver of this pending request (the Activations tab badge's predicate), so its row says "awaiting your decision".ActivationsSection.jobUrl(ActivationRequest request) Root-relative URL of the request's job or computed folder (D-46c) when the viewer may read it, elsenull(plain text). -
Uses of ActivationRequest in io.jenkins.plugins.batchcontrol.model
Methods in io.jenkins.plugins.batchcontrol.model that return ActivationRequestModifier and TypeMethodDescriptionstatic ActivationRequestActivationRequest.create(String jobFullName, ActivationRequest.Action action, String reason, String requester, List<String> approvers) Creates a new PENDING request with a fresh id and theBatchClocktime. -
Uses of ActivationRequest in io.jenkins.plugins.batchcontrol.ops
Methods in io.jenkins.plugins.batchcontrol.ops with parameters of type ActivationRequestModifier and TypeMethodDescriptionstatic voidNotificationDispatcher.activation(NotificationEvent event, ActivationRequest request) Event for an activation or hold request (SPEC item 6a).static voidNotificationDispatcher.activationEnded(NotificationEvent event, ActivationRequest request, boolean wasPending, String reason) -
Uses of ActivationRequest in io.jenkins.plugins.batchcontrol.policy
Methods in io.jenkins.plugins.batchcontrol.policy that return ActivationRequestModifier and TypeMethodDescriptionApproves a PENDING request and applies it:ACTIVATEmarks the job activated and writes anChangeType.ACTIVATEDrecord,HOLDmarks it not activated and writes aChangeType.HELDrecord.Cancels a PENDING request; requester or a Manage holder only (SPEC item 7 rule).ActivationService.changeApprovers(String id, List<String> newApprovers) Replaces the designated approver set of a PENDING request; requester only (D-26, D-37).ActivationService.create(Item job, ActivationRequest.Action action, String reason, List<String> approvers) Creates a PENDING activation or hold request for the job.ActivationService.create(Job<?, ?> job, ActivationRequest.Action action, String reason, List<String> approvers) Loads an activation request by id, ornull.Rejects a PENDING request; the comment is mandatory (SPEC item 5 rule).Methods in io.jenkins.plugins.batchcontrol.policy that return types with arguments of type ActivationRequestModifier and TypeMethodDescriptionActivationService.list()All stored activation requests, in creation order.ActivationService.listAwaitingDecision(org.springframework.security.core.Authentication auth) The PENDING requests counted asPendingCount.getAwaitingDecision()byActivationService.countPendingFor(Authentication), in creation order (oldest, the one closest to its timeout, first): empty unlessauthholds Jenkins-levelBatchControl/Approve.ActivationService.listPending()The PENDING activation and hold requests, in creation order (the approval inbox).ActivationService.listPendingFor(String userId) The PENDING requests on whichuserIdis a designated approver.ActivationService.listPendingForJob(String jobFullName) The PENDING requests of one job, in creation order.Methods in io.jenkins.plugins.batchcontrol.policy with parameters of type ActivationRequestModifier and TypeMethodDescriptionbooleanActivationService.canCancel(ActivationRequest request) D-38b: whether the current user may cancelrequest: its requester holdingBatchControl/Requeston the item, or a Manage holder.booleanActivationService.canChangeApprovers(ActivationRequest request) D-38b: whether the current user may change the approvers ofrequest: its requester holdingBatchControl/Requeston the item. -
Uses of ActivationRequest in io.jenkins.plugins.batchcontrol.store
Methods in io.jenkins.plugins.batchcontrol.store that return ActivationRequestModifier and TypeMethodDescriptionFileStore.loadActivationRequest(String id) Store.loadActivationRequest(String id) Loads an activation request by id, or returnsnullif it does not exist.Methods in io.jenkins.plugins.batchcontrol.store that return types with arguments of type ActivationRequestModifier and TypeMethodDescriptionFileStore.listActivationRequests()Store.listActivationRequests()Loads every stored activation request, sorted by id (creation order).FileStore.listOpenActivationRequests(Consumer<String> unreadable) default List<ActivationRequest> Store.listOpenActivationRequests()Loads the PENDING activation requests only, sorted by id, via the entity index.Store.listOpenActivationRequests(Consumer<String> unreadable) AsStore.listOpenActivationRequests(), and hands the id of every open request left out because its file cannot be read tounreadable.Methods in io.jenkins.plugins.batchcontrol.store with parameters of type ActivationRequestModifier and TypeMethodDescriptionvoidFileStore.saveActivationRequest(ActivationRequest request) voidStore.saveActivationRequest(ActivationRequest request) Writes (or rewrites, on a status transition) the activation request XML atomically. -
Uses of ActivationRequest in io.jenkins.plugins.batchcontrol.ui
Methods in io.jenkins.plugins.batchcontrol.ui with parameters of type ActivationRequestModifier and TypeMethodDescriptionstatic booleanVisibility.canSeeActivationRequest(ActivationRequest request) 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).