Class InstallFileMojo

java.lang.Object
org.apache.maven.plugin.AbstractMojo
org.apache.maven.plugins.install.InstallFileMojo
All Implemented Interfaces:
org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo
@Mojo(name="install-file", requiresProject=false, aggregator=true, threadSafe=true) public class InstallFileMojo extends org.apache.maven.plugin.AbstractMojo
Installs a file in the local repository.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private String
    artifactId
    ArtifactId of the artifact to be installed.
    private String
    classifier
    Classifier type of the artifact to be installed.
    private static final Pattern
    ENCODING_PSEUDO_ATTR
    The encoding pseudo-attribute of an XML declaration.
    private String
    extension
    Extension of the artifact to be installed.
    private File
    file
    The file to be installed in the local repository.
    private Boolean
    generatePom
    Generate a minimal POM for the artifact if none is supplied via the parameter pomFile.
    private String
    groupId
    GroupId of the artifact to be installed.
    private static final String
    ILLEGAL_VERSION_CHARS
     
    private static final Predicate<String>
    IS_EMPTY
     
    private static final Predicate<JarEntry>
    IS_POM_ENTRY
     
    private static final Predicate<String>
    IS_POM_PACKAGING
     
    private File
    javadoc
    The bundled API docs for the artifact.
    private File
    localRepositoryPath
    The path for a specific local repository directory.
    private final org.slf4j.Logger
    log
     
    private static final String
    LS
     
    private String
    packaging
    Packaging type of the artifact to be installed.
    private static final Pattern
    POM_ENTRY_PATTERN
     
    private File
    pomFile
    Location of an existing POM file to be installed alongside the main artifact, given by the file parameter.
    private final org.eclipse.aether.RepositorySystem
    repositorySystem
     
    private org.apache.maven.execution.MavenSession
    session
     
    private File
    sources
    The bundled sources for the artifact.
    private String
    version
    Version of the artifact to be installed.

    Fields inherited from interface org.apache.maven.plugin.Mojo

    ROLE

  • Constructor Summary

    Constructors
    Constructor
    Description
    InstallFileMojo(org.eclipse.aether.RepositorySystem repositorySystem)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    private Charset
    charsetOrFail(String name, String entryName)
    Resolves a detected or declared encoding name, failing closed if this JVM cannot decode it.
    private boolean
    contentDiffers(File existing, File candidate)
    Returns true if the two files exist with different content, or cannot be compared (fail-closed for warning purposes).
    private void
    crossCheckOperatorCoordinates(String entryName, org.apache.maven.model.Model model)
    Cross-checks every operator-supplied coordinate (groupId, artifactId, version) against the effective values declared by the embedded POM and fails on any mismatch.
    private Charset
    detectXmlCharset(byte[] bytes, String entryName)
    Detects the character encoding of raw XML bytes the way an XML parser is required to (XML 1.0 Appendix F): byte-order mark first, then the byte pattern of a leading <?xml, then the encoding pseudo-attribute of the XML declaration, defaulting to UTF-8.
    void
    execute()
     
    private org.apache.maven.model.Model
    generateModel()
    Generates a minimal model from the user-supplied artifact information.
    private File
    generatePomFile()
    Generates a (temporary) POM file from the plugin configuration.
    private File
    getLocalRepositoryFile(org.eclipse.aether.RepositorySystemSession session, org.eclipse.aether.artifact.Artifact artifact)
    Gets the path of the specified artifact within the local repository.
    private File
    getPomLocalRepositoryFile(org.eclipse.aether.RepositorySystemSession session, org.eclipse.aether.artifact.Artifact artifact)
    Gets the path of the specified artifact POM within the local repository.
    private boolean
    isValidGroupId(String groupId)
    Returns true if passed in string is a valid Maven groupId: a valid ID whose dot-separated segments are all non-empty.
    private boolean
    isValidId(String id)
    Returns true if passed in string is "valid Maven ID" (artifactId or packaging): non-empty, not consisting solely of '.' characters (so it can never form a ./.. path segment in the local repository layout), and using only allowed characters.
    private boolean
    isValidVersion(String version)
    Returns true if passed in string is "valid Maven (simple.
    private void
    processModel(org.apache.maven.model.Model model)
    Populates missing mojo parameters from the specified POM.
    private File
    readingPomFromJarFile()
     
    private org.apache.maven.model.Model
    readModel(File pomFile)
    Parses a POM.
    private void
    rejectDoctype(Path embeddedPom, String entryName)
    Defense-in-depth pre-screen for the JAR embedded POM: the entry is wire-origin, potentially attacker-authored XML, and it is handed to MavenXpp3Reader whose DTD and external-entity posture this plugin can neither configure nor guarantee across core versions.
    private void
    validateEmbeddedPomEntryPath(String entryName, org.apache.maven.model.Model model)
    Verifies that the <groupId>/<artifactId> components of the matched META-INF/maven/<groupId>/<artifactId>/pom.xml entry path agree with the effective coordinates declared by the embedded POM itself.
    private void
    verifyContainment(org.eclipse.aether.RepositorySystemSession repoSession, File artifactLocalFile)
    Defense in depth: verifies that the composed layout path stays inside the local repository.

    Methods inherited from class org.apache.maven.plugin.AbstractMojo

    getLog, getPluginContext, setLog, setPluginContext

    Methods inherited from class Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • LS

      private static final String LS

    • ILLEGAL_VERSION_CHARS

      private static final String ILLEGAL_VERSION_CHARS
      See Also:

    • ENCODING_PSEUDO_ATTR

      private static final Pattern ENCODING_PSEUDO_ATTR
      The encoding pseudo-attribute of an XML declaration.

    • log

      private final org.slf4j.Logger log

    • repositorySystem

      private final org.eclipse.aether.RepositorySystem repositorySystem

    • session

      @Parameter(defaultValue="${session}", required=true, readonly=true) private org.apache.maven.execution.MavenSession session

    • groupId

      @Parameter(property="groupId") private String groupId
      GroupId of the artifact to be installed. Retrieved from POM file if one is specified or extracted from pom.xml in jar if available.

    • artifactId

      @Parameter(property="artifactId") private String artifactId
      ArtifactId of the artifact to be installed. Retrieved from POM file if one is specified or extracted from pom.xml in jar if available.

    • version

      @Parameter(property="version") private String version
      Version of the artifact to be installed. Retrieved from POM file if one is specified or extracted from pom.xml in jar if available.

    • packaging

      @Parameter(property="packaging") private String packaging
      Packaging type of the artifact to be installed. Retrieved from POM file if one is specified or extracted from pom.xml in jar if available.

    • classifier

      @Parameter(property="classifier") private String classifier
      Classifier type of the artifact to be installed. For example, "sources" or "javadoc". Defaults to none which means this is the project's main artifact.
      Since:
      2.2

    • extension

      @Parameter(property="extension") private String extension
      Extension of the artifact to be installed. If set, will override plugin own logic to detect extension. If not set, as Maven expected, packaging determines the artifact extension.
      Since:
      3.1.3

    • file

      @Parameter(property="file", required=true) private File file
      The file to be installed in the local repository.

    • javadoc

      @Parameter(property="javadoc") private File javadoc
      The bundled API docs for the artifact.
      Since:
      2.3

    • sources

      @Parameter(property="sources") private File sources
      The bundled sources for the artifact.
      Since:
      2.3

    • pomFile

      @Parameter(property="pomFile") private File pomFile
      Location of an existing POM file to be installed alongside the main artifact, given by the file parameter.
      Since:
      2.1

    • generatePom

      @Parameter(property="generatePom") private Boolean generatePom
      Generate a minimal POM for the artifact if none is supplied via the parameter pomFile. Defaults to true if there is no existing POM in the local repository yet.
      Since:
      2.1

    • localRepositoryPath

      @Parameter(property="localRepositoryPath") private File localRepositoryPath
      The path for a specific local repository directory. If not specified the local repository path configured in the Maven settings will be used.
      Since:
      2.2

    • IS_EMPTY

      private static final Predicate<String> IS_EMPTY

    • IS_POM_PACKAGING

      private static final Predicate<String> IS_POM_PACKAGING

    • POM_ENTRY_PATTERN

      private static final Pattern POM_ENTRY_PATTERN

    • IS_POM_ENTRY

      private static final Predicate<JarEntry> IS_POM_ENTRY

  • Constructor Details

    • InstallFileMojo

      @Inject public InstallFileMojo(org.eclipse.aether.RepositorySystem repositorySystem)

  • Method Details

    • execute

      public void execute() throws org.apache.maven.plugin.MojoExecutionException, org.apache.maven.plugin.MojoFailureException
      Throws:
      org.apache.maven.plugin.MojoExecutionException
      org.apache.maven.plugin.MojoFailureException

    • readingPomFromJarFile

      private File readingPomFromJarFile() throws org.apache.maven.plugin.MojoExecutionException
      Throws:
      org.apache.maven.plugin.MojoExecutionException

    • readModel

      private org.apache.maven.model.Model readModel(File pomFile) throws org.apache.maven.plugin.MojoExecutionException
      Parses a POM.
      Parameters:
      pomFile - The path of the POM file to parse, must not be null.
      Returns:
      The model from the POM file, never null.
      Throws:
      org.apache.maven.plugin.MojoExecutionException - If the POM could not be parsed.

    • rejectDoctype

      private void rejectDoctype(Path embeddedPom, String entryName) throws org.apache.maven.plugin.MojoExecutionException
      Defense-in-depth pre-screen for the JAR embedded POM: the entry is wire-origin, potentially attacker-authored XML, and it is handed to MavenXpp3Reader whose DTD and external-entity posture this plugin can neither configure nor guarantee across core versions. A valid POM never carries a DOCTYPE declaration, so any embedded POM containing one is rejected before it reaches the parser. The scan is encoding-aware: the bytes are decoded with the same charset an XML parser is required to autodetect (BOM / first-bytes / encoding pseudo-attribute, XML 1.0 Appendix F), so a UTF-16 or UTF-32 document cannot smuggle a NUL-interleaved DOCTYPE past a naive single-byte scan. This intentionally does not apply to the operator's own -DpomFile.
      Parameters:
      embeddedPom - the temporary file holding the extracted entry, must not be null
      entryName - the name of the matched JAR entry, must not be null
      Throws:
      org.apache.maven.plugin.MojoExecutionException - if the content contains a DOCTYPE declaration or cannot be read

    • detectXmlCharset

      private Charset detectXmlCharset(byte[] bytes, String entryName) throws org.apache.maven.plugin.MojoExecutionException
      Detects the character encoding of raw XML bytes the way an XML parser is required to (XML 1.0 Appendix F): byte-order mark first, then the byte pattern of a leading <?xml, then the encoding pseudo-attribute of the XML declaration, defaulting to UTF-8.
      Parameters:
      bytes - the raw entry bytes, must not be null
      entryName - the name of the matched JAR entry, for error messages
      Returns:
      the detected charset, never null
      Throws:
      org.apache.maven.plugin.MojoExecutionException - if the detected/declared encoding is unsupported

    • charsetOrFail

      private Charset charsetOrFail(String name, String entryName) throws org.apache.maven.plugin.MojoExecutionException
      Resolves a detected or declared encoding name, failing closed if this JVM cannot decode it.
      Throws:
      org.apache.maven.plugin.MojoExecutionException

    • validateEmbeddedPomEntryPath

      private void validateEmbeddedPomEntryPath(String entryName, org.apache.maven.model.Model model) throws org.apache.maven.plugin.MojoExecutionException
      Verifies that the <groupId>/<artifactId> components of the matched META-INF/maven/<groupId>/<artifactId>/pom.xml entry path agree with the effective coordinates declared by the embedded POM itself.
      Parameters:
      entryName - the name of the matched JAR entry, must not be null
      model - the model parsed from that entry, must not be null
      Throws:
      org.apache.maven.plugin.MojoExecutionException - if the entry path does not match the model

    • crossCheckOperatorCoordinates

      private void crossCheckOperatorCoordinates(String entryName, org.apache.maven.model.Model model) throws org.apache.maven.plugin.MojoExecutionException
      Cross-checks every operator-supplied coordinate (groupId, artifactId, version) against the effective values declared by the embedded POM and fails on any mismatch.
      Parameters:
      entryName - the name of the matched JAR entry, must not be null
      model - the model parsed from that entry, must not be null
      Throws:
      org.apache.maven.plugin.MojoExecutionException - if an operator-supplied coordinate disagrees with the embedded POM

    • contentDiffers

      private boolean contentDiffers(File existing, File candidate)
      Returns true if the two files exist with different content, or cannot be compared (fail-closed for warning purposes). Uses byte-by-byte comparison since Files.mismatch() is not available on Java 8.

    • verifyContainment

      private void verifyContainment(org.eclipse.aether.RepositorySystemSession repoSession, File artifactLocalFile) throws org.apache.maven.plugin.MojoExecutionException
      Defense in depth: verifies that the composed layout path stays inside the local repository.
      Throws:
      org.apache.maven.plugin.MojoExecutionException

    • processModel

      private void processModel(org.apache.maven.model.Model model)
      Populates missing mojo parameters from the specified POM.
      Parameters:
      model - The POM to extract missing artifact coordinates from, must not be null.

    • generateModel

      private org.apache.maven.model.Model generateModel()
      Generates a minimal model from the user-supplied artifact information.
      Returns:
      The generated model, never null.

    • generatePomFile

      private File generatePomFile() throws org.apache.maven.plugin.MojoExecutionException
      Generates a (temporary) POM file from the plugin configuration. It's the responsibility of the caller to delete the generated file when no longer needed.
      Returns:
      The path to the generated POM file, never null.
      Throws:
      org.apache.maven.plugin.MojoExecutionException - If the POM file could not be generated.

    • getLocalRepositoryFile

      private File getLocalRepositoryFile(org.eclipse.aether.RepositorySystemSession session, org.eclipse.aether.artifact.Artifact artifact)
      Gets the path of the specified artifact within the local repository. Note that the returned path need not exist (yet).

    • getPomLocalRepositoryFile

      private File getPomLocalRepositoryFile(org.eclipse.aether.RepositorySystemSession session, org.eclipse.aether.artifact.Artifact artifact)
      Gets the path of the specified artifact POM within the local repository. Note that the returned path need not exist (yet).

    • isValidId

      private boolean isValidId(String id)
      Returns true if passed in string is "valid Maven ID" (artifactId or packaging): non-empty, not consisting solely of '.' characters (so it can never form a ./.. path segment in the local repository layout), and using only allowed characters.

    • isValidGroupId

      private boolean isValidGroupId(String groupId)
      Returns true if passed in string is a valid Maven groupId: a valid ID whose dot-separated segments are all non-empty. Leading, trailing or consecutive dots would produce empty path segments after the dots-to-directories transform of the local repository layout.

    • isValidVersion

      private boolean isValidVersion(String version)
      Returns true if passed in string is "valid Maven (simple. non range, expression, etc) version": non-empty, not consisting solely of '.' characters, and free of illegal characters.