Index (Apache Commons Release Plugin 1.10.0 API)

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

A

addToZip(File, File, ZipOutputStream) - Method in class org.apache.commons.release.plugin.mojos.CommonsSiteCompressionMojo: Deprecated.

Adds the file from directoryToZip to the ZIP archive represented by zos.
annotations - Variable in class org.apache.commons.release.plugin.slsa.v1_2.ResourceDescriptor: Additional key-value metadata about the resource.
ARTIFACT_TYPES_TO_DETACH - Static variable in class org.apache.commons.release.plugin.mojos.CommonsDistributionDetachmentMojo: A list of "artifact types" in the Maven vernacular, to be detached from the deployment.
artifactId - Variable in class org.apache.commons.release.plugin.velocity.ReadmeHtmlVelocityDelegate: This is supposed to represent the Maven artifactId.
artifactId - Variable in class org.apache.commons.release.plugin.velocity.ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder: The Maven artifactId to use in the README.vm template.
artifactSha512s - Variable in class org.apache.commons.release.plugin.mojos.CommonsDistributionDetachmentMojo: A SortedProperties mapping artifact file names to their SHA-512 hashes.

B

baseDir - Variable in class org.apache.commons.release.plugin.mojos.CommonsDistributionStagingMojo: The File representing the root directory of the working project.
BUFFER_BYTE_SIZE - Static variable in class org.apache.commons.release.plugin.SharedFunctions: The buffer size in bytes.
build() - Method in class org.apache.commons.release.plugin.velocity.HeaderHtmlVelocityDelegate.HeaderHtmlVelocityDelegateBuilder: Builds a new HeaderHtmlVelocityDelegate.
build() - Method in class org.apache.commons.release.plugin.velocity.ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder: Builds up the ReadmeHtmlVelocityDelegate from the previously set parameters.
buildDefinition - Variable in class org.apache.commons.release.plugin.slsa.v1_2.Provenance: Inputs that defined the build.
BuildDefinition - Class in org.apache.commons.release.plugin.slsa.v1_2: Inputs that define the build: the build type, external and internal parameters, and resolved dependencies.
BuildDefinition() - Constructor for class org.apache.commons.release.plugin.slsa.v1_2.BuildDefinition: Creates a new BuildDefinition instance with the default build type.
BuildDefinition(String, Map) - Constructor for class org.apache.commons.release.plugin.slsa.v1_2.BuildDefinition: Creates a new BuildDefinition with the given build type and external parameters.
builder - Variable in class org.apache.commons.release.plugin.slsa.v1_2.RunDetails: Entity that executed the build.
builder() - Static method in class org.apache.commons.release.plugin.velocity.HeaderHtmlVelocityDelegate: Gets a builder for constructing a HeaderHtmlVelocityDelegate.
builder() - Static method in class org.apache.commons.release.plugin.velocity.ReadmeHtmlVelocityDelegate: Gets the ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder for constructing the ReadmeHtmlVelocityDelegate.
Builder - Class in org.apache.commons.release.plugin.slsa.v1_2: Entity that executed the build and is trusted to have correctly performed the operation and populated the provenance.
Builder() - Constructor for class org.apache.commons.release.plugin.slsa.v1_2.Builder: Creates a new Builder instance.
builderDependencies - Variable in class org.apache.commons.release.plugin.slsa.v1_2.Builder: Orchestrator dependencies that may affect provenance generation.
BuildMetadata - Class in org.apache.commons.release.plugin.slsa.v1_2: Metadata about a build invocation: its identifier and start and finish timestamps.
BuildMetadata() - Constructor for class org.apache.commons.release.plugin.slsa.v1_2.BuildMetadata: Creates a new BuildMetadata instance.
BuildMetadata(String, OffsetDateTime, OffsetDateTime) - Constructor for class org.apache.commons.release.plugin.slsa.v1_2.BuildMetadata: Creates a new BuildMetadata instance with all fields set.
buildReadmeAndHeaderHtmlFiles() - Method in class org.apache.commons.release.plugin.mojos.CommonsDistributionStagingMojo: Builds up README.html and HEADER.html that reside in the following directory structure: distRoot binaries/HEADER.html (symlink) binaries/README.html (symlink) source/HEADER.html (symlink) source/README.html (symlink) HEADER.html README.html
buildType - Variable in class org.apache.commons.release.plugin.slsa.v1_2.BuildDefinition: URI indicating what type of build was performed.
byproducts - Variable in class org.apache.commons.release.plugin.slsa.v1_2.RunDetails: Artifacts produced as a side effect of the build.

C

CommonsDistributionDetachmentMojo - Class in org.apache.commons.release.plugin.mojos: The purpose of this Maven mojo is to detach the artifacts generated by the maven-assembly-plugin, which for the Apache Commons Project do not get uploaded to Nexus, and put those artifacts in the dev distribution location for Apache projects.
CommonsDistributionDetachmentMojo() - Constructor for class org.apache.commons.release.plugin.mojos.CommonsDistributionDetachmentMojo: Constructs a new instance.
CommonsDistributionStagingMojo - Class in org.apache.commons.release.plugin.mojos: Checks out the dev distribution location, copies the distributions into that directory structure under the target/commons-release-plugin/scm directory, and commits the distributions back to SVN.
CommonsDistributionStagingMojo() - Constructor for class org.apache.commons.release.plugin.mojos.CommonsDistributionStagingMojo: Constructs a new instance.
commonsRcVersion - Variable in class org.apache.commons.release.plugin.mojos.CommonsDistributionStagingMojo: The RC version of the release.
commonsReleaseVersion - Variable in class org.apache.commons.release.plugin.mojos.CommonsDistributionStagingMojo: The release version of the artifact to be built.
CommonsSiteCompressionMojo - Class in org.apache.commons.release.plugin.mojos: Deprecated.
As we no longer wish to compress the site, we are going to put this functionality in the CommonsDistributionStagingMojo.
CommonsSiteCompressionMojo() - Constructor for class org.apache.commons.release.plugin.mojos.CommonsSiteCompressionMojo: Deprecated.

Constructs a new instance.
CommonsStagingCleanupMojo - Class in org.apache.commons.release.plugin.mojos: This class checks out the dev distribution location, checks whether anything exists in the distribution location, and, if it is non-empty, deletes all the resources there.
CommonsStagingCleanupMojo() - Constructor for class org.apache.commons.release.plugin.mojos.CommonsStagingCleanupMojo: Constructs a new instance.
content - Variable in class org.apache.commons.release.plugin.slsa.v1_2.ResourceDescriptor: Raw contents of the resource, base64-encoded in JSON.
copyDistributionsIntoScmDirectoryStructureAndAddToSvn(File, ScmProvider, ScmRepository) - Method in class org.apache.commons.release.plugin.mojos.CommonsDistributionStagingMojo: Copies the list of files at the root of the CommonsDistributionStagingMojo.workingDirectory into the directory structure of the distribution staging repository.
copyFile(Log, File, File) - Static method in class org.apache.commons.release.plugin.SharedFunctions: Copies a File from the fromFile to the toFile and logs the failure using the Maven Log.
copyHeaderAndReadmeToSubdirectories(File, File) - Method in class org.apache.commons.release.plugin.mojos.CommonsDistributionStagingMojo: Copies README.html and HEADER.html to the source and binaries directories.
copyReleaseNotesToWorkingDirectory() - Method in class org.apache.commons.release.plugin.mojos.CommonsDistributionStagingMojo: Copies the configured release notes file into CommonsDistributionStagingMojo.distRcVersionDirectory.
copyRemovedArtifactsToWorkingDirectory() - Method in class org.apache.commons.release.plugin.mojos.CommonsDistributionDetachmentMojo: A helper method to copy the newly detached artifacts to target/commons-release-plugin so that the CommonsDistributionStagingMojo can find the artifacts later.
copySignatureValidatorScriptToScmDirectory() - Method in class org.apache.commons.release.plugin.mojos.CommonsDistributionStagingMojo: Copies our signature-validator.sh script into ${basedir}/target/commons-release-plugin/scm/signature-validator.sh.
copySiteToScmDirectory() - Method in class org.apache.commons.release.plugin.mojos.CommonsDistributionStagingMojo: Copies ${basedir}/target/site to ${basedir}/target/commons-release-plugin/scm/site.

D

detachedArtifacts - Variable in class org.apache.commons.release.plugin.mojos.CommonsDistributionDetachmentMojo: This list is supposed to hold the Maven references to the aforementioned artifacts so that we can upload them to SVN after they've been detached from the Maven deployment.
digest - Variable in class org.apache.commons.release.plugin.slsa.v1_2.ResourceDescriptor: Map of digest algorithm names to hex-encoded values.
distCheckoutDirectory - Variable in class org.apache.commons.release.plugin.mojos.CommonsDistributionStagingMojo: The location to which to check out the dist Subversion repository under our working directory, which was given above.
distCleanupDirectory - Variable in class org.apache.commons.release.plugin.mojos.CommonsStagingCleanupMojo: The location to which to check out the dist Subversion repository under our working directory, which was given above.
distRcVersionDirectory - Variable in class org.apache.commons.release.plugin.mojos.CommonsDistributionStagingMojo: A subdirectory of the dist directory into which we are going to stage the release candidate.
distServer - Variable in class org.apache.commons.release.plugin.mojos.CommonsDistributionStagingMojo: The ID of the server (specified in settings.xml) which should be used for dist authentication.
distServer - Variable in class org.apache.commons.release.plugin.mojos.CommonsStagingCleanupMojo: The ID of the server (specified in settings.xml) which should be used for dist authentication.
distSvnStagingUrl - Variable in class org.apache.commons.release.plugin.mojos.CommonsDistributionDetachmentMojo: The Subversion staging URL to which we upload all of our staged artifacts.
distSvnStagingUrl - Variable in class org.apache.commons.release.plugin.mojos.CommonsDistributionStagingMojo: The URL of the Subversion repository to which we wish the artifacts to be staged.
distSvnStagingUrl - Variable in class org.apache.commons.release.plugin.mojos.CommonsSiteCompressionMojo: Deprecated.

The URL of the Subversion repository to which we wish the artifacts to be staged.
distSvnStagingUrl - Variable in class org.apache.commons.release.plugin.mojos.CommonsStagingCleanupMojo: The URL of the Subversion repository to which we wish the artifacts to be staged.
downloadLocation - Variable in class org.apache.commons.release.plugin.slsa.v1_2.ResourceDescriptor: Download URI for the resource, if different from ResourceDescriptor.uri.
dryRun - Variable in class org.apache.commons.release.plugin.mojos.CommonsDistributionStagingMojo: A boolean that determines whether or not we actually commit the files up to the Subversion repository.
dryRun - Variable in class org.apache.commons.release.plugin.mojos.CommonsStagingCleanupMojo: A boolean that determines whether or not we actually commit the files up to the Subversion repository.
DsseEnvelope - Class in org.apache.commons.release.plugin.slsa.v1_2: DSSE (Dead Simple Signing Envelope) that wraps a signed in-toto statement payload.
DsseEnvelope() - Constructor for class org.apache.commons.release.plugin.slsa.v1_2.DsseEnvelope: Creates a new DsseEnvelope instance with payloadType pre-set to DsseEnvelope.PAYLOAD_TYPE.

E

END_DIGIT - Static variable in class org.apache.commons.release.plugin.velocity.ReadmeHtmlVelocityDelegate: ".
equals(Object) - Method in class org.apache.commons.release.plugin.slsa.v1_2.BuildDefinition
equals(Object) - Method in class org.apache.commons.release.plugin.slsa.v1_2.Builder
equals(Object) - Method in class org.apache.commons.release.plugin.slsa.v1_2.BuildMetadata
equals(Object) - Method in class org.apache.commons.release.plugin.slsa.v1_2.DsseEnvelope
equals(Object) - Method in class org.apache.commons.release.plugin.slsa.v1_2.Provenance
equals(Object) - Method in class org.apache.commons.release.plugin.slsa.v1_2.ResourceDescriptor
equals(Object) - Method in class org.apache.commons.release.plugin.slsa.v1_2.RunDetails
equals(Object) - Method in class org.apache.commons.release.plugin.slsa.v1_2.Signature
equals(Object) - Method in class org.apache.commons.release.plugin.slsa.v1_2.Statement
execute() - Method in class org.apache.commons.release.plugin.mojos.CommonsDistributionDetachmentMojo
execute() - Method in class org.apache.commons.release.plugin.mojos.CommonsDistributionStagingMojo
execute() - Method in class org.apache.commons.release.plugin.mojos.CommonsSiteCompressionMojo: Deprecated.
execute() - Method in class org.apache.commons.release.plugin.mojos.CommonsStagingCleanupMojo
externalParameters - Variable in class org.apache.commons.release.plugin.slsa.v1_2.BuildDefinition: Inputs passed to the build.

F

filesToCompress - Variable in class org.apache.commons.release.plugin.mojos.CommonsSiteCompressionMojo: Deprecated.

The list of files to compress into the site.zip file.
finishedOn - Variable in class org.apache.commons.release.plugin.slsa.v1_2.BuildMetadata: Timestamp when the build completed.

G

getAllSiteFiles(File, List) - Method in class org.apache.commons.release.plugin.mojos.CommonsSiteCompressionMojo: Deprecated.

Gets all site files and adds them to the CommonsSiteCompressionMojo.filesToCompress List.
getAnnotations() - Method in class org.apache.commons.release.plugin.slsa.v1_2.ResourceDescriptor: Gets additional key-value metadata about the resource, such as filename, size, or builder-specific attributes.
getArtifactKey(Artifact) - Method in class org.apache.commons.release.plugin.mojos.CommonsDistributionDetachmentMojo: Gets the unique artifact key for storage in our sha512 map.
getBuildDefinition() - Method in class org.apache.commons.release.plugin.slsa.v1_2.Provenance: Gets the build definition describing all inputs that produced the build output.
getBuilder() - Method in class org.apache.commons.release.plugin.slsa.v1_2.RunDetails: Gets the builder that executed the invocation.
getBuilderDependencies() - Method in class org.apache.commons.release.plugin.slsa.v1_2.Builder: Gets orchestrator dependencies that do not run within the build workload and do not affect the build output, but may affect provenance generation or security guarantees.
getBuildType() - Method in class org.apache.commons.release.plugin.slsa.v1_2.BuildDefinition: Gets the URI indicating what type of build was performed.
getByproducts() - Method in class org.apache.commons.release.plugin.slsa.v1_2.RunDetails: Gets artifacts produced as a side effect of the build that are not the primary output.
getContent() - Method in class org.apache.commons.release.plugin.slsa.v1_2.ResourceDescriptor: Gets the raw contents of the resource, base64-encoded when serialized to JSON.
getDigest() - Method in class org.apache.commons.release.plugin.slsa.v1_2.ResourceDescriptor: Gets the map of cryptographic digest algorithms to their corresponding hex-encoded values for this resource.
getDownloadLocation() - Method in class org.apache.commons.release.plugin.slsa.v1_2.ResourceDescriptor: Gets the download URI for the resource, if different from ResourceDescriptor.getUri().
getExternalParameters() - Method in class org.apache.commons.release.plugin.slsa.v1_2.BuildDefinition: Gets the inputs passed to the build, such as command-line arguments or environment variables.
getFinishedOn() - Method in class org.apache.commons.release.plugin.slsa.v1_2.BuildMetadata: Gets the timestamp of when the build completed, serialized as RFC 3339 in UTC ("Z" suffix).
getId() - Method in class org.apache.commons.release.plugin.slsa.v1_2.Builder: Gets the identifier of the builder.
getInternalParameters() - Method in class org.apache.commons.release.plugin.slsa.v1_2.BuildDefinition: Gets the parameters set by the build platform.
getInvocationId() - Method in class org.apache.commons.release.plugin.slsa.v1_2.BuildMetadata: Gets the identifier for this build invocation.
getKeyid() - Method in class org.apache.commons.release.plugin.slsa.v1_2.Signature: Gets the key identifier hint, or null if not set.
getMediaType() - Method in class org.apache.commons.release.plugin.slsa.v1_2.ResourceDescriptor: Gets the media type of the resource (for example, "application/octet-stream").
getMetadata() - Method in class org.apache.commons.release.plugin.slsa.v1_2.RunDetails: Gets the metadata about the build invocation, including its identifier and timing.
getName() - Method in class org.apache.commons.release.plugin.slsa.v1_2.ResourceDescriptor: Gets the name of the resource.
getPayload() - Method in class org.apache.commons.release.plugin.slsa.v1_2.DsseEnvelope: Gets the serialized payload bytes.
getPayloadType() - Method in class org.apache.commons.release.plugin.slsa.v1_2.DsseEnvelope: Gets the payload type URI.
getPredicate() - Method in class org.apache.commons.release.plugin.slsa.v1_2.Statement: Gets the provenance predicate.
getPredicateType() - Method in class org.apache.commons.release.plugin.slsa.v1_2.Statement: Gets the URI identifying the type of the predicate.
getResolvedDependencies() - Method in class org.apache.commons.release.plugin.slsa.v1_2.BuildDefinition: Gets the materials that influenced the build.
getRunDetails() - Method in class org.apache.commons.release.plugin.slsa.v1_2.Provenance: Gets the details about the invocation of the build tool and the environment in which it was run.
getSha512FilePath(File, File) - Method in class org.apache.commons.release.plugin.mojos.CommonsDistributionDetachmentMojo: Gets the file path for the sha512 checksum file for a given file.
getSig() - Method in class org.apache.commons.release.plugin.slsa.v1_2.Signature: Gets the raw signature bytes.
getSignatures() - Method in class org.apache.commons.release.plugin.slsa.v1_2.DsseEnvelope: Gets the list of signatures over the PAE-encoded payload.
getStartedOn() - Method in class org.apache.commons.release.plugin.slsa.v1_2.BuildMetadata: Gets the timestamp of when the build started, serialized as RFC 3339 in UTC ("Z" suffix).
getSubject() - Method in class org.apache.commons.release.plugin.slsa.v1_2.Statement: Gets the set of software artifacts that the attestation applies to.
getType() - Method in class org.apache.commons.release.plugin.slsa.v1_2.Statement: Gets the JSON object type.
getUri() - Method in class org.apache.commons.release.plugin.slsa.v1_2.ResourceDescriptor: Gets the URI identifying the resource.
getVersion() - Method in class org.apache.commons.release.plugin.slsa.v1_2.Builder: Gets a map of build platform component names to their versions.

H

hashArtifacts() - Method in class org.apache.commons.release.plugin.mojos.CommonsDistributionDetachmentMojo: Creates SHA-512 checksum files for detached artifacts in the target/commons-release-plugin directory for upload by CommonsDistributionStagingMojo.
hashCode() - Method in class org.apache.commons.release.plugin.slsa.v1_2.BuildDefinition
hashCode() - Method in class org.apache.commons.release.plugin.slsa.v1_2.Builder
hashCode() - Method in class org.apache.commons.release.plugin.slsa.v1_2.BuildMetadata
hashCode() - Method in class org.apache.commons.release.plugin.slsa.v1_2.DsseEnvelope
hashCode() - Method in class org.apache.commons.release.plugin.slsa.v1_2.Provenance
hashCode() - Method in class org.apache.commons.release.plugin.slsa.v1_2.ResourceDescriptor
hashCode() - Method in class org.apache.commons.release.plugin.slsa.v1_2.RunDetails
hashCode() - Method in class org.apache.commons.release.plugin.slsa.v1_2.Signature
hashCode() - Method in class org.apache.commons.release.plugin.slsa.v1_2.Statement
HEADER_FILE_NAME - Static variable in class org.apache.commons.release.plugin.mojos.CommonsDistributionStagingMojo: The name of the file generated from the HEADER.vm Velocity template to be checked into the dist SVN repo.
HeaderHtmlVelocityDelegate - Class in org.apache.commons.release.plugin.velocity: Generates the HEADER.html file that accompanies the release in the distribution area.
HeaderHtmlVelocityDelegate() - Constructor for class org.apache.commons.release.plugin.velocity.HeaderHtmlVelocityDelegate: The private constructor to be used by the HeaderHtmlVelocityDelegate.HeaderHtmlVelocityDelegateBuilder.
HeaderHtmlVelocityDelegate.HeaderHtmlVelocityDelegateBuilder - Class in org.apache.commons.release.plugin.velocity: A builder class for instantiation of the HeaderHtmlVelocityDelegate.
HeaderHtmlVelocityDelegateBuilder() - Constructor for class org.apache.commons.release.plugin.velocity.HeaderHtmlVelocityDelegate.HeaderHtmlVelocityDelegateBuilder: Private constructor so that we can have a proper builder pattern.

I

id - Variable in class org.apache.commons.release.plugin.slsa.v1_2.Builder: Identifier URI of the builder.
initDirectory(Log, File) - Static method in class org.apache.commons.release.plugin.SharedFunctions: Cleans and then initializes an empty directory that is given by the workingDirectory parameter.
internalParameters - Variable in class org.apache.commons.release.plugin.slsa.v1_2.BuildDefinition: Parameters set by the build platform.
invocationId - Variable in class org.apache.commons.release.plugin.slsa.v1_2.BuildMetadata: Identifier for this build invocation.
isDistModule - Variable in class org.apache.commons.release.plugin.mojos.CommonsDistributionDetachmentMojo: A parameter to generally avoid running unless it is specifically turned on by the consuming module.
isDistModule - Variable in class org.apache.commons.release.plugin.mojos.CommonsDistributionStagingMojo: A parameter to generally avoid running unless it is specifically turned on by the consuming module.
isDistModule - Variable in class org.apache.commons.release.plugin.mojos.CommonsSiteCompressionMojo: Deprecated.

A parameter to generally avoid running unless it is specifically turned on by the consuming module.
isDistModule - Variable in class org.apache.commons.release.plugin.mojos.CommonsStagingCleanupMojo: A parameter to generally avoid running unless it is specifically turned on by the consuming module.

K

keyid - Variable in class org.apache.commons.release.plugin.slsa.v1_2.Signature: Hint for which key was used to sign; unset is treated as empty.

L

listNotHiddenFilesAndDirectories(File, List) - Method in class org.apache.commons.release.plugin.mojos.CommonsDistributionStagingMojo: Lists all directories and files in a flat list.

M

mediaType - Variable in class org.apache.commons.release.plugin.slsa.v1_2.ResourceDescriptor: Media type of the resource.
metadata - Variable in class org.apache.commons.release.plugin.slsa.v1_2.RunDetails: Metadata about the build invocation.

N

name - Variable in class org.apache.commons.release.plugin.slsa.v1_2.ResourceDescriptor: Human-readable name of the resource.

O

org.apache.commons.release.plugin - package org.apache.commons.release.plugin: Base package for the commons-release-plugin.
org.apache.commons.release.plugin.mojos - package org.apache.commons.release.plugin.mojos: This package contains all the Maven mojos for the commons-release-plugin.
org.apache.commons.release.plugin.slsa.v1_2 - package org.apache.commons.release.plugin.slsa.v1_2: SLSA 1.2 Build Attestation Models.
org.apache.commons.release.plugin.velocity - package org.apache.commons.release.plugin.velocity: Contains classes that render Velocity templates to a Writer.
Overview - Section in package org.apache.commons.release.plugin.slsa.v1_2

P

password - Variable in class org.apache.commons.release.plugin.mojos.CommonsDistributionStagingMojo: The password associated with CommonsDistributionStagingMojo.username.
password - Variable in class org.apache.commons.release.plugin.mojos.CommonsStagingCleanupMojo: The password associated with CommonsDistributionStagingMojo.username.
payload - Variable in class org.apache.commons.release.plugin.slsa.v1_2.DsseEnvelope: Serialized statement bytes, Base64-encoded in JSON.
PAYLOAD_TYPE - Static variable in class org.apache.commons.release.plugin.slsa.v1_2.DsseEnvelope: The payload type URI for in-toto attestation statements.
payloadType - Variable in class org.apache.commons.release.plugin.slsa.v1_2.DsseEnvelope: Content type identifying the format of DsseEnvelope.payload.
predicate - Variable in class org.apache.commons.release.plugin.slsa.v1_2.Statement: The provenance predicate.
PREDICATE_TYPE - Static variable in class org.apache.commons.release.plugin.slsa.v1_2.Provenance: Predicate type URI used in the in-toto Statement wrapping this provenance.
predicateType - Variable in class org.apache.commons.release.plugin.slsa.v1_2.Statement: URI identifying the type of the predicate.
project - Variable in class org.apache.commons.release.plugin.mojos.CommonsDistributionDetachmentMojo: The Maven project context injection so that we can access the project variables.
project - Variable in class org.apache.commons.release.plugin.mojos.CommonsDistributionStagingMojo: The MavenProject object is essentially the context of the Maven build at a given time.
project - Variable in class org.apache.commons.release.plugin.mojos.CommonsStagingCleanupMojo: The MavenProject object is essentially the context of the Maven build at a given time.
Provenance - Class in org.apache.commons.release.plugin.slsa.v1_2: Root predicate of an SLSA v1.2 provenance attestation, describing what was built and how.
Provenance() - Constructor for class org.apache.commons.release.plugin.slsa.v1_2.Provenance: Creates a new Provenance instance.
Provenance(BuildDefinition, RunDetails) - Constructor for class org.apache.commons.release.plugin.slsa.v1_2.Provenance: Creates a new Provenance with the given build definition and run details.
putAttachedArtifactInSha512Map(Artifact) - Method in class org.apache.commons.release.plugin.mojos.CommonsDistributionDetachmentMojo: Computes the SHA-512 hash of an attached artifact and stores it in the map.
putFileInSha512Map(String, File) - Method in class org.apache.commons.release.plugin.mojos.CommonsDistributionDetachmentMojo: Computes a file's SHA-512 hash and stores it under its release artifact name.

R

README_FILE_NAME - Static variable in class org.apache.commons.release.plugin.mojos.CommonsDistributionStagingMojo: The name of the file generated from the README.vm Velocity template to be checked into the dist SVN repo.
ReadmeHtmlVelocityDelegate - Class in org.apache.commons.release.plugin.velocity: Generates the README.html file that accompanies the release in the distribution area.
ReadmeHtmlVelocityDelegate(String, String, String) - Constructor for class org.apache.commons.release.plugin.velocity.ReadmeHtmlVelocityDelegate: The private constructor to be used by the ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder.
ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder - Class in org.apache.commons.release.plugin.velocity: A builder class for instantiation of the ReadmeHtmlVelocityDelegate.
ReadmeHtmlVelocityDelegateBuilder() - Constructor for class org.apache.commons.release.plugin.velocity.ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder: Private constructor for using the builder through the ReadmeHtmlVelocityDelegate.builder() method.
releaseNotesFile - Variable in class org.apache.commons.release.plugin.mojos.CommonsDistributionStagingMojo: The location of the RELEASE-NOTES.txt file such that multi-module builds can configure it.
render(Writer) - Method in class org.apache.commons.release.plugin.velocity.HeaderHtmlVelocityDelegate: Renders the HEADER.vm Velocity template to the supplied writer.
render(Writer) - Method in class org.apache.commons.release.plugin.velocity.ReadmeHtmlVelocityDelegate: Renders the README.vm Velocity template with the variables constructed with the ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder.
requireNonNull(T) - Static method in class org.apache.commons.release.plugin.SharedFunctions: Checks that the specified object reference is not null.
requireNonNull(T, String) - Static method in class org.apache.commons.release.plugin.SharedFunctions: Checks that the specified object reference is not null and throws a customized MojoExecutionException if it is.
requireNonNull(T, Supplier) - Static method in class org.apache.commons.release.plugin.SharedFunctions: Checks that the specified object reference is not null and throws a customized MojoExecutionException if it is.
resolvedDependencies - Variable in class org.apache.commons.release.plugin.slsa.v1_2.BuildDefinition: Artifacts the build depends on, specified by URI and digest.
ResourceDescriptor - Class in org.apache.commons.release.plugin.slsa.v1_2: Description of an artifact or resource referenced in the build, identified by URI and cryptographic digest.
ResourceDescriptor() - Constructor for class org.apache.commons.release.plugin.slsa.v1_2.ResourceDescriptor: Creates a new ResourceDescriptor instance.
ResourceDescriptor(String, Map) - Constructor for class org.apache.commons.release.plugin.slsa.v1_2.ResourceDescriptor: Creates a new ResourceDescriptor with the given URI and digest.
runDetails - Variable in class org.apache.commons.release.plugin.slsa.v1_2.Provenance: Details about the build invocation.
RunDetails - Class in org.apache.commons.release.plugin.slsa.v1_2: Details about the build invocation: the builder identity, execution metadata, and any byproduct artifacts.
RunDetails() - Constructor for class org.apache.commons.release.plugin.slsa.v1_2.RunDetails: Creates a new RunDetails instance.
RunDetails(Builder, BuildMetadata) - Constructor for class org.apache.commons.release.plugin.slsa.v1_2.RunDetails: Creates a new RunDetails with the given builder and metadata.

S

setAnnotations(Map) - Method in class org.apache.commons.release.plugin.slsa.v1_2.ResourceDescriptor: Sets additional key-value metadata about the resource.
setArtifactId(String) - Method in class org.apache.commons.release.plugin.velocity.ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder: Sets the Maven artifact ID for the ReadmeHtmlVelocityDelegate.
setAuthentication(ScmProviderRepository, String, Settings, SettingsDecrypter, String, String) - Static method in class org.apache.commons.release.plugin.SharedFunctions: Sets authentication information on the specified ScmProviderRepository.
setBaseDir(File) - Method in class org.apache.commons.release.plugin.mojos.CommonsDistributionStagingMojo: Sets the CommonsDistributionStagingMojo.baseDir field for use in unit tests.
setBuildDefinition(BuildDefinition) - Method in class org.apache.commons.release.plugin.slsa.v1_2.Provenance: Sets the build definition describing all inputs that produced the build output.
setBuilder(Builder) - Method in class org.apache.commons.release.plugin.slsa.v1_2.RunDetails: Sets the builder that executed the invocation.
setBuilderDependencies(List) - Method in class org.apache.commons.release.plugin.slsa.v1_2.Builder: Sets the orchestrator dependencies that may affect provenance generation or security guarantees.
setBuildType(String) - Method in class org.apache.commons.release.plugin.slsa.v1_2.BuildDefinition: Sets the URI indicating what type of build was performed.
setByproducts(List) - Method in class org.apache.commons.release.plugin.slsa.v1_2.RunDetails: Sets the artifacts produced as a side effect of the build that are not the primary output.
setContent(byte[]) - Method in class org.apache.commons.release.plugin.slsa.v1_2.ResourceDescriptor: Sets the raw contents of the resource.
setDigest(Map) - Method in class org.apache.commons.release.plugin.slsa.v1_2.ResourceDescriptor: Sets the map of cryptographic digest algorithms to their hex-encoded values.
setDownloadLocation(String) - Method in class org.apache.commons.release.plugin.slsa.v1_2.ResourceDescriptor: Sets the download URI for the resource.
setExternalParameters(Map) - Method in class org.apache.commons.release.plugin.slsa.v1_2.BuildDefinition: Sets the inputs passed to the build.
setFinishedOn(OffsetDateTime) - Method in class org.apache.commons.release.plugin.slsa.v1_2.BuildMetadata: Sets the timestamp of when the build completed.
setId(String) - Method in class org.apache.commons.release.plugin.slsa.v1_2.Builder: Sets the identifier of the builder.
setInternalParameters(Map) - Method in class org.apache.commons.release.plugin.slsa.v1_2.BuildDefinition: Sets the parameters set by the build platform.
setInvocationId(String) - Method in class org.apache.commons.release.plugin.slsa.v1_2.BuildMetadata: Sets the identifier for this build invocation.
setKeyid(String) - Method in class org.apache.commons.release.plugin.slsa.v1_2.Signature: Sets the key identifier hint.
setMediaType(String) - Method in class org.apache.commons.release.plugin.slsa.v1_2.ResourceDescriptor: Sets the media type of the resource.
setMetadata(BuildMetadata) - Method in class org.apache.commons.release.plugin.slsa.v1_2.RunDetails: Sets the metadata about the build invocation.
setName(String) - Method in class org.apache.commons.release.plugin.slsa.v1_2.ResourceDescriptor: Sets the name of the resource.
setPayload(byte[]) - Method in class org.apache.commons.release.plugin.slsa.v1_2.DsseEnvelope: Sets the serialized payload bytes.
setPayloadType(String) - Method in class org.apache.commons.release.plugin.slsa.v1_2.DsseEnvelope: Sets the payload type URI.
setPredicate(Provenance) - Method in class org.apache.commons.release.plugin.slsa.v1_2.Statement: Sets the provenance predicate and automatically assigns predicateType to the SLSA provenance v1 URI.
setResolvedDependencies(List) - Method in class org.apache.commons.release.plugin.slsa.v1_2.BuildDefinition: Sets the materials that influenced the build.
setRunDetails(RunDetails) - Method in class org.apache.commons.release.plugin.slsa.v1_2.Provenance: Sets the details about the invocation of the build tool and the environment in which it was run.
setSig(byte[]) - Method in class org.apache.commons.release.plugin.slsa.v1_2.Signature: Sets the raw signature bytes.
setSignatures(List) - Method in class org.apache.commons.release.plugin.slsa.v1_2.DsseEnvelope: Sets the list of signatures over the PAE-encoded payload.
setSiteUrl(String) - Method in class org.apache.commons.release.plugin.velocity.ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder: Sets the site URL for the ReadmeHtmlVelocityDelegate.
setStartedOn(OffsetDateTime) - Method in class org.apache.commons.release.plugin.slsa.v1_2.BuildMetadata: Sets the timestamp of when the build started.
setSubject(List) - Method in class org.apache.commons.release.plugin.slsa.v1_2.Statement: Sets the set of software artifacts that the attestation applies to.
settings - Variable in class org.apache.commons.release.plugin.mojos.CommonsDistributionStagingMojo: Maven Settings.
settings - Variable in class org.apache.commons.release.plugin.mojos.CommonsStagingCleanupMojo: Maven Settings.
settingsDecrypter - Variable in class org.apache.commons.release.plugin.mojos.CommonsDistributionStagingMojo: Maven SettingsDecrypter component.
settingsDecrypter - Variable in class org.apache.commons.release.plugin.mojos.CommonsStagingCleanupMojo: Maven SettingsDecrypter component.
setUri(String) - Method in class org.apache.commons.release.plugin.slsa.v1_2.ResourceDescriptor: Sets the URI identifying the resource.
setVersion(String) - Method in class org.apache.commons.release.plugin.velocity.ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder: Sets the version for the ReadmeHtmlVelocityDelegate.
setVersion(Map) - Method in class org.apache.commons.release.plugin.slsa.v1_2.Builder: Sets the map of build platform component names to their versions.
SharedFunctions - Class in org.apache.commons.release.plugin: Shared static functions for all of our Mojos.
SharedFunctions() - Constructor for class org.apache.commons.release.plugin.SharedFunctions: Prevents instantiation of this utility class.
sig - Variable in class org.apache.commons.release.plugin.slsa.v1_2.Signature: Raw signature bytes of the PAE-encoded payload.
Signature - Class in org.apache.commons.release.plugin.slsa.v1_2: A single cryptographic signature within a DSSE envelope.
Signature() - Constructor for class org.apache.commons.release.plugin.slsa.v1_2.Signature: Creates a new Signature instance.
SIGNATURE_VALIDATOR_NAME - Static variable in class org.apache.commons.release.plugin.mojos.CommonsDistributionStagingMojo: The name of the signature validation shell script to be checked into the dist SVN repo.
signatures - Variable in class org.apache.commons.release.plugin.slsa.v1_2.DsseEnvelope: One or more signatures over the PAE-encoded payload.
siteDirectory - Variable in class org.apache.commons.release.plugin.mojos.CommonsDistributionStagingMojo: The location to which the site gets built when running mvn site.
siteDirectory - Variable in class org.apache.commons.release.plugin.mojos.CommonsSiteCompressionMojo: Deprecated.

The site output directory.
siteUrl - Variable in class org.apache.commons.release.plugin.velocity.ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder: The site URL to use in the README.vm template.
siteUrl - Variable in class org.apache.commons.release.plugin.velocity.ReadmeHtmlVelocityDelegate: The URL of the site that gets set into the README.html.
startedOn - Variable in class org.apache.commons.release.plugin.slsa.v1_2.BuildMetadata: Timestamp when the build started.
Statement - Class in org.apache.commons.release.plugin.slsa.v1_2: In-toto v1 attestation envelope that binds a set of subject artifacts to an SLSA provenance predicate.
Statement() - Constructor for class org.apache.commons.release.plugin.slsa.v1_2.Statement: Creates a new Statement instance.
subject - Variable in class org.apache.commons.release.plugin.slsa.v1_2.Statement: Software artifacts that the attestation applies to.

T

TEMPLATE - Static variable in class org.apache.commons.release.plugin.velocity.HeaderHtmlVelocityDelegate: The location of the Velocity template for this class.
TEMPLATE - Static variable in class org.apache.commons.release.plugin.velocity.ReadmeHtmlVelocityDelegate: The location of the Velocity template for this class.
toString() - Method in class org.apache.commons.release.plugin.slsa.v1_2.BuildDefinition
toString() - Method in class org.apache.commons.release.plugin.slsa.v1_2.Builder
toString() - Method in class org.apache.commons.release.plugin.slsa.v1_2.BuildMetadata
toString() - Method in class org.apache.commons.release.plugin.slsa.v1_2.DsseEnvelope
toString() - Method in class org.apache.commons.release.plugin.slsa.v1_2.Provenance
toString() - Method in class org.apache.commons.release.plugin.slsa.v1_2.ResourceDescriptor
toString() - Method in class org.apache.commons.release.plugin.slsa.v1_2.RunDetails
toString() - Method in class org.apache.commons.release.plugin.slsa.v1_2.Signature
toString() - Method in class org.apache.commons.release.plugin.slsa.v1_2.Statement
TYPE - Static variable in class org.apache.commons.release.plugin.slsa.v1_2.Statement: The in-toto statement schema URI.

U

uri - Variable in class org.apache.commons.release.plugin.slsa.v1_2.ResourceDescriptor: URI identifying the resource.
username - Variable in class org.apache.commons.release.plugin.mojos.CommonsDistributionStagingMojo: The username for the distribution Subversion repository.
username - Variable in class org.apache.commons.release.plugin.mojos.CommonsStagingCleanupMojo: The username for the distribution Subversion repository.

V

version - Variable in class org.apache.commons.release.plugin.slsa.v1_2.Builder: Map of build platform component names to their versions.
version - Variable in class org.apache.commons.release.plugin.velocity.ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder: The Maven version to use in the README.vm template.
version - Variable in class org.apache.commons.release.plugin.velocity.ReadmeHtmlVelocityDelegate: This is supposed to represent the Maven version of the release.

W

workingDirectory - Variable in class org.apache.commons.release.plugin.mojos.CommonsDistributionDetachmentMojo: The working directory in target that we use as a sandbox for the plugin.
workingDirectory - Variable in class org.apache.commons.release.plugin.mojos.CommonsDistributionStagingMojo: The main working directory for the plugin, namely target/commons-release-plugin, but that assumes that we're using the default Maven ${project.build.directory}.
workingDirectory - Variable in class org.apache.commons.release.plugin.mojos.CommonsSiteCompressionMojo: Deprecated.

The working directory for the plugin, which is target/commons-release-plugin when Maven uses the default ${project.build.directory}.
workingDirectory - Variable in class org.apache.commons.release.plugin.mojos.CommonsStagingCleanupMojo: The main working directory for the plugin, namely target/commons-release-plugin, but that assumes that we're using the default Maven ${project.build.directory}.
writeAllArtifactsInSha512PropertiesFile() - Method in class org.apache.commons.release.plugin.mojos.CommonsDistributionDetachmentMojo: Writes the artifacts' SHA-512 hashes to .
writeZipFile(File, File, List) - Method in class org.apache.commons.release.plugin.mojos.CommonsSiteCompressionMojo: Deprecated.

Writes all the files in fileList to a site.zip file in the workingDirectory.

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