Index (Apache Commons Release Plugin 1.2 API)

A B C D E F G I O P R S U W

A

addToZip(File, File, ZipOutputStream) - Method in class org.apache.commons.release.plugin.mojos.CommonsSiteCompressionMojo: Given the directoryToZip we add the file to the zip archive represented by zos.
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.

B

basedir - Variable in class org.apache.commons.release.plugin.mojos.CommonsDistributionStagingMojo: The File that contains a file to the root directory of the working project.
BUFFER_BYTE_SIZE - Static variable in class org.apache.commons.release.plugin.SharedFunctions: I want a buffer that is an array with 1024 elements of bytes.
buildDistBinariesRoot() - Method in class org.apache.commons.release.plugin.mojos.CommonsDistributionStagingMojo: Build the path for the distribution binaries directory.
buildDistSourceRoot() - Method in class org.apache.commons.release.plugin.mojos.CommonsDistributionStagingMojo: Build the path for the distribution source directory.

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 putting those artifacts in the dev distribution location for apache projects.
CommonsDistributionDetachmentMojo() - Constructor for class org.apache.commons.release.plugin.mojos.CommonsDistributionDetachmentMojo
CommonsDistributionStagingMojo - Class in org.apache.commons.release.plugin.mojos: This class checks out the dev distribution location, copies the distributions into that directory structure under the target/commons-release-plugin/scm directory.
CommonsDistributionStagingMojo() - Constructor for class org.apache.commons.release.plugin.mojos.CommonsDistributionStagingMojo
CommonsSiteCompressionMojo - Class in org.apache.commons.release.plugin.mojos: Takes the built ./target/site directory and compresses it to ./target/commons-release-plugin/site.zip.
CommonsSiteCompressionMojo() - Constructor for class org.apache.commons.release.plugin.mojos.CommonsSiteCompressionMojo
copyDistributionsIntoScmDirectoryStructure(File) - 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.
copyReleaseNotesToWorkingDirectory() - Method in class org.apache.commons.release.plugin.mojos.CommonsDistributionStagingMojo: A utility method that takes the RELEASE-NOTES.txt file from the base directory of the project and copies it into CommonsDistributionStagingMojo.workingDirectory.
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.

D

detachedArtifacts - Variable in class org.apache.commons.release.plugin.mojos.CommonsDistributionDetachmentMojo: This list is supposed to hold the maven references to the aformentioned artifacts so that we can upload them to svn after they've been detached from the maven deployment.
dirs - Variable in class org.apache.commons.release.plugin.mojos.CommonsSiteCompressionMojo: A variable for the process of creating the site.zip file.
distCheckoutDirectory - Variable in class org.apache.commons.release.plugin.mojos.CommonsDistributionStagingMojo: The location to which to checkout the dist subversion repository under our working directory, which was given above.
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: The url of the subversion repository to which we wish the artifacts to be staged.
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.

E

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

F

filesToCompress - Variable in class org.apache.commons.release.plugin.mojos.CommonsSiteCompressionMojo: The list of files to compress into the site.zip file.

G

getAllSiteFiles(File, List<File>) - Method in class org.apache.commons.release.plugin.mojos.CommonsSiteCompressionMojo: By default this method iterates across the target/site directory and adds all of the files to the CommonsSiteCompressionMojo.filesToCompress List.
getMd5FilePath(File, File) - Method in class org.apache.commons.release.plugin.mojos.CommonsDistributionDetachmentMojo: A helper method to create a file path for the md5 signature file from a given file.
getSha1FilePath(File, File) - Method in class org.apache.commons.release.plugin.mojos.CommonsDistributionDetachmentMojo: A helper method to create a file path for the sha1 signature file from a given file.

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.
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: A parameter to generally avoid running unless it is specifically turned on by the consuming module.

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 of the maven mojos for the commons-release-plugin.

P

password - Variable in class org.apache.commons.release.plugin.mojos.CommonsDistributionStagingMojo: The password associated with CommonsDistributionStagingMojo.username.
project - Variable in class org.apache.commons.release.plugin.mojos.CommonsDistributionDetachmentMojo: The maven project context injection so that we can get a hold of the variables at hand.
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.

R

releaseNotesFile - Variable in class org.apache.commons.release.plugin.mojos.CommonsDistributionStagingMojo: The location of the RELEASE-NOTES.txt file such that multimodule builds can configure it.

S

scatterZipCreator - Variable in class org.apache.commons.release.plugin.mojos.CommonsSiteCompressionMojo: A second variable for the process of creating the site.zip file.
setBasedir(File) - Method in class org.apache.commons.release.plugin.mojos.CommonsDistributionStagingMojo: This method is the setter for the CommonsDistributionStagingMojo.basedir field, specifically for the usage in the unit tests.
sha1AndMd5SignArtifacts() - Method in class org.apache.commons.release.plugin.mojos.CommonsDistributionDetachmentMojo: A helper method that creates md5 and sha1 signature files for our detached artifacts in the target/commons-release-plugin directory for the purpose of being uploade by the CommonsDistributionStagingMojo.
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: Making the constructor private because the class only contains static methods.
siteDirectory - Variable in class org.apache.commons.release.plugin.mojos.CommonsSiteCompressionMojo

U

username - Variable in class org.apache.commons.release.plugin.mojos.CommonsDistributionStagingMojo: The username for the distribution subversion repository.

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: The working directory for the plugin which, assuming the maven uses the default ${project.build.directory}, this becomes target/commons-release-plugin.
writeZipFile(File, File, List<File>) - Method in class org.apache.commons.release.plugin.mojos.CommonsSiteCompressionMojo: A helper method for writing all of the files in our fileList to a site.zip file in the workingDirectory.

A B C D E F G I O P R S U W