Index

B C D E G H I O P R S T 
All Classes and Interfaces|All Packages|Constant Field Values

B

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 - 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() - 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.
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.

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.
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.
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.

D

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

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
 

G

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.
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.
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

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
 
HeaderHtmlVelocityDelegate - Class in org.apache.commons.release.plugin.velocity
Generates the HEADER.html file that accompanies the release in the distribution area.
HeaderHtmlVelocityDelegate.HeaderHtmlVelocityDelegateBuilder - Class in org.apache.commons.release.plugin.velocity
A builder class for instantiation of the HeaderHtmlVelocityDelegate.

I

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.

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

PAYLOAD_TYPE - Static variable in class org.apache.commons.release.plugin.slsa.v1_2.DsseEnvelope
The payload type URI for in-toto attestation statements.
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.
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.

R

ReadmeHtmlVelocityDelegate - Class in org.apache.commons.release.plugin.velocity
Generates the README.html file that accompanies the release in the distribution area.
ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder - Class in org.apache.commons.release.plugin.velocity
A builder class for instantiation of the ReadmeHtmlVelocityDelegate.
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.
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 - 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.
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.
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.
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.

T

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.
B C D E G H I O P R S T 
All Classes and Interfaces|All Packages|Constant Field Values