Index

A B C D E G H I L P R S T W 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

ApiConfiguration - Class in io.jenkins.plugins.signpath.ApiIntegration
Holds all general configuration values that are necessary for talking to the SignPath Pipeline Connector
ApiConfiguration() - Constructor for class io.jenkins.plugins.signpath.ApiIntegration.ApiConfiguration
 
archiveWorkspaceArtifact(FilePath, String) - Method in interface io.jenkins.plugins.signpath.Artifacts.ArtifactFileManager
Archives a file that lives in the agent workspace, streaming it from the agent to the build's archived artifacts (the same mechanism as the built-in archiveArtifacts step) so it can be retrieved later, e.g.
archiveWorkspaceArtifact(FilePath, String) - Method in class io.jenkins.plugins.signpath.Artifacts.DefaultArtifactFileManager
 
ArtifactFileManager - Interface in io.jenkins.plugins.signpath.Artifacts
A wrapper around the
ArtifactNotFoundException - Exception Class in io.jenkins.plugins.signpath.Exceptions
Thrown when the
ArtifactNotFoundException(String) - Constructor for exception class io.jenkins.plugins.signpath.Exceptions.ArtifactNotFoundException
 

B

build(StepContext, ApiConfiguration) - Static method in class io.jenkins.plugins.signpath.SignPathContainer
 
BUILD_SYSTEM_TYPE - Static variable in class io.jenkins.plugins.signpath.Common.PluginConstants
The build-system path segment used when calling the SignPath Pipeline Connector routes (e.g.

C

checkRoles(RoleChecker) - Method in class io.jenkins.plugins.signpath.Artifacts.ComputeArtifactHashCallable
 
close() - Method in class io.jenkins.plugins.signpath.Common.TemporaryFile
 
ComputeArtifactHashCallable - Class in io.jenkins.plugins.signpath.Artifacts
A FilePath.FileCallable that runs on the agent and computes the SHA-256 hex hash of the artifact file.
ComputeArtifactHashCallable() - Constructor for class io.jenkins.plugins.signpath.Artifacts.ComputeArtifactHashCallable
 
ConnectorSigningRequestModel - Class in io.jenkins.plugins.signpath.ApiIntegration.Model
All (non-authentication) parameters needed to submit a signing request to the SignPath Pipeline Connector.
ConnectorSigningRequestModel() - Constructor for class io.jenkins.plugins.signpath.ApiIntegration.Model.ConnectorSigningRequestModel
 
copyFrom(InputStream) - Method in class io.jenkins.plugins.signpath.Common.TemporaryFile
 
create(SignPathCredentials) - Method in interface io.jenkins.plugins.signpath.ApiIntegration.IPipelineConnectorFacadeFactory
Creates a PipelineConnectorFacade that is bound to the credentials parameter to use for authenticating against the SignPath Pipeline Connector
create(SignPathCredentials) - Method in class io.jenkins.plugins.signpath.ApiIntegration.PipelineConnectorFacade.PipelineConnectorFacadeFactory
 
CredentialBasedSecretRetriever - Class in io.jenkins.plugins.signpath.SecretRetrieval
Implementation of the
CredentialBasedSecretRetriever(Jenkins) - Constructor for class io.jenkins.plugins.signpath.SecretRetrieval.CredentialBasedSecretRetriever
 

D

DEFAULT_API_TOKEN_CREDENTIAL_ID - Static variable in class io.jenkins.plugins.signpath.Common.PluginConstants
 
DefaultArtifactFileManager - Class in io.jenkins.plugins.signpath.Artifacts
The default implementation of the
DefaultArtifactFileManager(FingerprintMap, Run<?, ?>, Launcher, TaskListener) - Constructor for class io.jenkins.plugins.signpath.Artifacts.DefaultArtifactFileManager
 
DescriptorImpl() - Constructor for class io.jenkins.plugins.signpath.GetSignedArtifactStep.DescriptorImpl
 
DescriptorImpl() - Constructor for class io.jenkins.plugins.signpath.SubmitSigningRequestStep.DescriptorImpl
 
doCheckConnectorEndpointSlug(String) - Method in class io.jenkins.plugins.signpath.SignPathPluginGlobalConfiguration
 
doCheckConnectorURL(String) - Method in class io.jenkins.plugins.signpath.SignPathPluginGlobalConfiguration
 
doCheckOrganizationId(String) - Method in class io.jenkins.plugins.signpath.SignPathPluginGlobalConfiguration
 

E

ensureNotNull(String, String) - Method in class io.jenkins.plugins.signpath.SignPathStepBase
 
ensureValidURL(String) - Method in class io.jenkins.plugins.signpath.SignPathStepBase
 
ensureValidUUID(String, String) - Method in class io.jenkins.plugins.signpath.SignPathStepBase
 

G

getAbsolutePath() - Method in class io.jenkins.plugins.signpath.Common.TemporaryFile
 
getAndValidateApiConfiguration() - Method in class io.jenkins.plugins.signpath.SignPathStepBase
 
getConnectorEndpointSlugWithGlobal() - Method in class io.jenkins.plugins.signpath.SignPathStepBase
 
getDescriptor() - Method in class io.jenkins.plugins.signpath.GetSignedArtifactStep
 
getDescriptor() - Method in class io.jenkins.plugins.signpath.SubmitSigningRequestStep
 
getDisplayName() - Method in class io.jenkins.plugins.signpath.GetSignedArtifactStep.DescriptorImpl
 
getDisplayName() - Method in class io.jenkins.plugins.signpath.SubmitSigningRequestStep.DescriptorImpl
 
getFile() - Method in class io.jenkins.plugins.signpath.Common.TemporaryFile
 
getFunctionName() - Method in class io.jenkins.plugins.signpath.GetSignedArtifactStep.DescriptorImpl
 
getFunctionName() - Method in class io.jenkins.plugins.signpath.SubmitSigningRequestStep.DescriptorImpl
 
getOrganizationId() - Method in class io.jenkins.plugins.signpath.GetSignedArtifactStep
Deprecated.
getOrganizationIdWithGlobal() - Method in class io.jenkins.plugins.signpath.GetSignedArtifactStep
 
getOrganizationIdWithGlobal() - Method in class io.jenkins.plugins.signpath.SubmitSigningRequestStep
 
getRequiredContext() - Method in class io.jenkins.plugins.signpath.GetSignedArtifactStep.DescriptorImpl
 
getRequiredContext() - Method in class io.jenkins.plugins.signpath.SubmitSigningRequestStep.DescriptorImpl
 
getSignedArtifact(UUID, UUID) - Method in interface io.jenkins.plugins.signpath.ApiIntegration.IPipelineConnectorFacade
Downloads a signed artifact from the SignPath Pipeline Connector
getSignedArtifact(UUID, UUID) - Method in class io.jenkins.plugins.signpath.ApiIntegration.PipelineConnectorFacade.PipelineConnectorFacade
 
GetSignedArtifactStep - Class in io.jenkins.plugins.signpath
Represents the getSignedArtifact step that is executable via pipeline-script For a how-to use example see *EndToEnd tests
GetSignedArtifactStep() - Constructor for class io.jenkins.plugins.signpath.GetSignedArtifactStep
 
GetSignedArtifactStep.DescriptorImpl - Class in io.jenkins.plugins.signpath
 
GetSignedArtifactStepExecution - Class in io.jenkins.plugins.signpath
The step-execution for the
GetSignedArtifactStepExecution(GetSignedArtifactStepInput, SecretRetriever, IPipelineConnectorFacadeFactory, TaskListener, StepContext) - Constructor for class io.jenkins.plugins.signpath.GetSignedArtifactStepExecution
 
GetSignedArtifactStepInput - Class in io.jenkins.plugins.signpath
Holds all input data specific to the
GetSignedArtifactStepInput() - Constructor for class io.jenkins.plugins.signpath.GetSignedArtifactStepInput
 
getSignPathConfig() - Method in class io.jenkins.plugins.signpath.SignPathStepBase
 
getWaitForCompletion() - Method in class io.jenkins.plugins.signpath.SubmitSigningRequestStep
 
getWaitForCompletion() - Method in class io.jenkins.plugins.signpath.SubmitSigningRequestStepInput
 
getWithGlobalConfig(String, Function<SignPathPluginGlobalConfiguration, String>, String, Boolean) - Method in class io.jenkins.plugins.signpath.SignPathStepBase
 

H

hasArtifactRetrievalUrl() - Method in class io.jenkins.plugins.signpath.SubmitSigningRequestStepInput
 
hasOutputArtifactPath() - Method in class io.jenkins.plugins.signpath.SubmitSigningRequestStepInput
 

I

invoke(File, VirtualChannel) - Method in class io.jenkins.plugins.signpath.Artifacts.ComputeArtifactHashCallable
 
io.jenkins.plugins.signpath - package io.jenkins.plugins.signpath
 
io.jenkins.plugins.signpath.ApiIntegration - package io.jenkins.plugins.signpath.ApiIntegration
 
io.jenkins.plugins.signpath.ApiIntegration.Model - package io.jenkins.plugins.signpath.ApiIntegration.Model
 
io.jenkins.plugins.signpath.ApiIntegration.PipelineConnectorFacade - package io.jenkins.plugins.signpath.ApiIntegration.PipelineConnectorFacade
 
io.jenkins.plugins.signpath.Artifacts - package io.jenkins.plugins.signpath.Artifacts
 
io.jenkins.plugins.signpath.Common - package io.jenkins.plugins.signpath.Common
 
io.jenkins.plugins.signpath.Exceptions - package io.jenkins.plugins.signpath.Exceptions
 
io.jenkins.plugins.signpath.SecretRetrieval - package io.jenkins.plugins.signpath.SecretRetrieval
 
IPipelineConnectorFacade - Interface in io.jenkins.plugins.signpath.ApiIntegration
A facade for the SignPath Pipeline Connector
IPipelineConnectorFacadeFactory - Interface in io.jenkins.plugins.signpath.ApiIntegration
A factory that creates a PipelineConnectorFacade that is bound to the given parameters
isValidUUID(String) - Method in class io.jenkins.plugins.signpath.SignPathPluginGlobalConfiguration
 

L

log(String) - Method in class io.jenkins.plugins.signpath.SignPathClientLogger
 
log(String, Throwable) - Method in class io.jenkins.plugins.signpath.SignPathClientLogger
 

P

PipelineConnectorFacade - Class in io.jenkins.plugins.signpath.ApiIntegration.PipelineConnectorFacade
 
PipelineConnectorFacade(SignPathCredentials, ApiConfiguration, SignPathClientSimpleLogger) - Constructor for class io.jenkins.plugins.signpath.ApiIntegration.PipelineConnectorFacade.PipelineConnectorFacade
 
PipelineConnectorFacadeCallException - Exception Class in io.jenkins.plugins.signpath.Exceptions
Occurs when the
PipelineConnectorFacadeCallException(String) - Constructor for exception class io.jenkins.plugins.signpath.Exceptions.PipelineConnectorFacadeCallException
 
PipelineConnectorFacadeFactory - Class in io.jenkins.plugins.signpath.ApiIntegration.PipelineConnectorFacade
 
PipelineConnectorFacadeFactory(ApiConfiguration, SignPathClientSimpleLogger) - Constructor for class io.jenkins.plugins.signpath.ApiIntegration.PipelineConnectorFacade.PipelineConnectorFacadeFactory
 
PluginConstants - Class in io.jenkins.plugins.signpath.Common
shared constants for the plugin

R

retrieveArtifact(String) - Method in interface io.jenkins.plugins.signpath.Artifacts.ArtifactFileManager
Retrieves the given artifact from the Jenkins Master-Node
retrieveArtifact(String) - Method in class io.jenkins.plugins.signpath.Artifacts.DefaultArtifactFileManager
 
retrieveSecret(String) - Method in class io.jenkins.plugins.signpath.SecretRetrieval.CredentialBasedSecretRetriever
 
retrieveSecret(String) - Method in interface io.jenkins.plugins.signpath.SecretRetrieval.SecretRetriever
Retrieves a secret with the given ID
retrieveSecret(String, CredentialsScope[]) - Method in class io.jenkins.plugins.signpath.SecretRetrieval.CredentialBasedSecretRetriever
 
retrieveSecret(String, CredentialsScope[]) - Method in interface io.jenkins.plugins.signpath.SecretRetrieval.SecretRetriever
 
run() - Method in class io.jenkins.plugins.signpath.GetSignedArtifactStepExecution
 
run() - Method in class io.jenkins.plugins.signpath.SubmitSigningRequestStepExecution
 

S

SecretNotFoundException - Exception Class in io.jenkins.plugins.signpath.Exceptions
Occurs when the
SecretNotFoundException(String) - Constructor for exception class io.jenkins.plugins.signpath.Exceptions.SecretNotFoundException
 
SecretRetriever - Interface in io.jenkins.plugins.signpath.SecretRetrieval
Allows retrieving secrets
setApiTokenCredentialId(String) - Method in class io.jenkins.plugins.signpath.SignPathStepBase
 
setArtifactConfigurationSlug(String) - Method in class io.jenkins.plugins.signpath.SubmitSigningRequestStep
 
setConnectorEndpointSlug(String) - Method in class io.jenkins.plugins.signpath.SignPathPluginGlobalConfiguration
 
setConnectorEndpointSlug(String) - Method in class io.jenkins.plugins.signpath.SignPathStepBase
 
setConnectorURL(String) - Method in class io.jenkins.plugins.signpath.SignPathPluginGlobalConfiguration
 
setDescription(String) - Method in class io.jenkins.plugins.signpath.SubmitSigningRequestStep
 
setInputArtifactPath(String) - Method in class io.jenkins.plugins.signpath.SubmitSigningRequestStep
 
setInputArtifactRetrievalHttpHeaders(Map<String, String>) - Method in class io.jenkins.plugins.signpath.SubmitSigningRequestStep
 
setInputArtifactRetrievalUrl(String) - Method in class io.jenkins.plugins.signpath.SubmitSigningRequestStep
 
setOrganizationId(String) - Method in class io.jenkins.plugins.signpath.GetSignedArtifactStep
Deprecated.
setOrganizationId(String) - Method in class io.jenkins.plugins.signpath.SignPathPluginGlobalConfiguration
 
setOrganizationId(String) - Method in class io.jenkins.plugins.signpath.SubmitSigningRequestStep
 
setOutputArtifactPath(String) - Method in class io.jenkins.plugins.signpath.GetSignedArtifactStep
 
setOutputArtifactPath(String) - Method in class io.jenkins.plugins.signpath.SubmitSigningRequestStep
 
setParameters(Map<String, String>) - Method in class io.jenkins.plugins.signpath.SubmitSigningRequestStep
 
setProjectSlug(String) - Method in class io.jenkins.plugins.signpath.SubmitSigningRequestStep
 
setServiceUnavailableTimeoutInSeconds(int) - Method in class io.jenkins.plugins.signpath.SignPathStepBase
 
setSigningPolicySlug(String) - Method in class io.jenkins.plugins.signpath.SubmitSigningRequestStep
 
setSigningRequestId(String) - Method in class io.jenkins.plugins.signpath.GetSignedArtifactStep
 
setUploadAndDownloadRequestTimeoutInSeconds(int) - Method in class io.jenkins.plugins.signpath.SignPathStepBase
 
setWaitForCompletion(boolean) - Method in class io.jenkins.plugins.signpath.SubmitSigningRequestStep
 
setWaitForCompletionTimeoutInSeconds(int) - Method in class io.jenkins.plugins.signpath.SignPathStepBase
 
SignPathClientLogger - Class in io.jenkins.plugins.signpath
 
SignPathClientLogger(PrintStream) - Constructor for class io.jenkins.plugins.signpath.SignPathClientLogger
 
SignPathContainer - Class in io.jenkins.plugins.signpath
A helper class that helps us share all dependencies needed for the
SignPathCredentials - Class in io.jenkins.plugins.signpath.ApiIntegration
Holds all necessary credentials to authenticate against the SignPath Pipeline Connector endpoints, exposed by the
SignPathCredentials() - Constructor for class io.jenkins.plugins.signpath.ApiIntegration.SignPathCredentials
 
SignPathPluginGlobalConfiguration - Class in io.jenkins.plugins.signpath
 
SignPathPluginGlobalConfiguration() - Constructor for class io.jenkins.plugins.signpath.SignPathPluginGlobalConfiguration
 
SignPathStepBase - Class in io.jenkins.plugins.signpath
A common base class for all SignPath API / Facade related Jenkins Steps It encapsulates all required configuration related parameters and helps share and re-use them across multiple steps
SignPathStepBase() - Constructor for class io.jenkins.plugins.signpath.SignPathStepBase
 
SignPathStepFailedException - Exception Class in io.jenkins.plugins.signpath.Exceptions
Occurs when a
SignPathStepFailedException(String, Exception) - Constructor for exception class io.jenkins.plugins.signpath.Exceptions.SignPathStepFailedException
 
SignPathStepInvalidArgumentException - Exception Class in io.jenkins.plugins.signpath.Exceptions
Occurs when user-provided arguments are invalid or missing in the
SignPathStepInvalidArgumentException(String) - Constructor for exception class io.jenkins.plugins.signpath.Exceptions.SignPathStepInvalidArgumentException
 
start(StepContext) - Method in class io.jenkins.plugins.signpath.GetSignedArtifactStep
 
start(StepContext) - Method in class io.jenkins.plugins.signpath.SubmitSigningRequestStep
 
storeArtifact(TemporaryFile, String) - Method in interface io.jenkins.plugins.signpath.Artifacts.ArtifactFileManager
Stores the given artifact from the temporary file on the Jenkins Master-Node
storeArtifact(TemporaryFile, String) - Method in class io.jenkins.plugins.signpath.Artifacts.DefaultArtifactFileManager
 
submitSigningRequest(ConnectorSigningRequestModel) - Method in interface io.jenkins.plugins.signpath.ApiIntegration.IPipelineConnectorFacade
Submits a signing request to the SignPath Pipeline Connector.
submitSigningRequest(ConnectorSigningRequestModel) - Method in class io.jenkins.plugins.signpath.ApiIntegration.PipelineConnectorFacade.PipelineConnectorFacade
 
SubmitSigningRequestResult - Class in io.jenkins.plugins.signpath.ApiIntegration.Model
Result of submitting a signing request to the SignPath Pipeline Connector.
SubmitSigningRequestResult() - Constructor for class io.jenkins.plugins.signpath.ApiIntegration.Model.SubmitSigningRequestResult
 
SubmitSigningRequestStep - Class in io.jenkins.plugins.signpath
Represents the submitSigningRequestStep step that is executable via pipeline-script Encapsulates both the sync and async version of the step -> thus the waitForCompletion param is used to toggle between the two modes For a how-to use example see *EndToEnd tests
SubmitSigningRequestStep() - Constructor for class io.jenkins.plugins.signpath.SubmitSigningRequestStep
 
SubmitSigningRequestStep.DescriptorImpl - Class in io.jenkins.plugins.signpath
 
SubmitSigningRequestStepExecution - Class in io.jenkins.plugins.signpath
The step-execution for the
SubmitSigningRequestStepExecution(SubmitSigningRequestStepInput, SecretRetriever, ArtifactFileManager, IPipelineConnectorFacadeFactory, TaskListener, StepContext) - Constructor for class io.jenkins.plugins.signpath.SubmitSigningRequestStepExecution
 
SubmitSigningRequestStepInput - Class in io.jenkins.plugins.signpath
Holds all input specific to the
SubmitSigningRequestStepInput(UUID, String, String, String, String, String, String, String, Map<String, String>, boolean, String, Map<String, String>) - Constructor for class io.jenkins.plugins.signpath.SubmitSigningRequestStepInput
 

T

TemporaryFile - Class in io.jenkins.plugins.signpath.Common
A helper class for handling (creating and disposing) temporary files
TemporaryFile() - Constructor for class io.jenkins.plugins.signpath.Common.TemporaryFile
 
TemporaryFile(String) - Constructor for class io.jenkins.plugins.signpath.Common.TemporaryFile
 

W

waitForFinalSigningRequestStatus(UUID, UUID) - Method in interface io.jenkins.plugins.signpath.ApiIntegration.IPipelineConnectorFacade
Waits for a signing request to reach a final status without downloading the artifact.
waitForFinalSigningRequestStatus(UUID, UUID) - Method in class io.jenkins.plugins.signpath.ApiIntegration.PipelineConnectorFacade.PipelineConnectorFacade
 
A B C D E G H I L P R S T W 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form