Class AbstractProcessRemoteResourcesMojo

java.lang.Object
org.apache.maven.plugin.AbstractMojo
org.apache.maven.plugin.resources.remote.AbstractProcessRemoteResourcesMojo
All Implemented Interfaces:
org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo
Direct Known Subclasses:
AggregateProcessRemoteResourcesMojo, ProcessRemoteResourcesMojo
public abstract class AbstractProcessRemoteResourcesMojo extends org.apache.maven.plugin.AbstractMojo

Pull down resourceBundles containing remote resources and process the resources contained inside. When that is done, the resources are injected into the current (in-memory) Maven project, making them available to the process-resources phase.

Resources that end in ".vm" are treated as Velocity templates. For those, the ".vm" is stripped off for the final artifact name and it's fed through Velocity to have properties expanded, conditions processed, etc...

Resources that don't end in ".vm" are copied "as is".

This is a support abstract class, with two non-aggregating and aggregating implementations.

  • Field Details

    • TEMPLATE_SUFFIX

      private static final String TEMPLATE_SUFFIX
      See Also:

    • filterDelimiters

      @Parameter protected List<String> filterDelimiters

      In cases where a local resource overrides one from a remote resource bundle, that resource should be filtered if the resource set specifies it. In those cases, this parameter defines the list of delimiters for filterable expressions. These delimiters are specified in the form 'beginToken*endToken'. If no '*' is given, the delimiter is assumed to be the same for start and end.

      So, the default filtering delimiters might be specified as: 

      <delimiters>
  <delimiter>${*}</delimiter>
  <delimiter>@</delimiter>
</delimiters>
      Since the '@' delimiter is the same on both ends, we don't need to specify '@*@' (though we can).
      Since:
      1.1

    • useDefaultFilterDelimiters

      @Parameter(defaultValue="true") protected boolean useDefaultFilterDelimiters
      Since:
      1.1

    • encoding

      @Parameter(property="encoding", defaultValue="${project.build.sourceEncoding}") protected String encoding
      The character encoding scheme to be applied when filtering resources.

    • outputDirectory

      @Parameter(property="outputDirectory", defaultValue="${project.build.directory}/maven-shared-archive-resources") private File outputDirectory
      The directory where processed resources will be placed for packaging.

    • appendedResourcesDirectory

      @Parameter(defaultValue="${basedir}/src/main/appended-resources") private File appendedResourcesDirectory
      The directory containing extra information appended to the generated resources.

    • supplementalModels

      @Parameter private String[] supplementalModels
      Supplemental model data. Useful when processing artifacts with incomplete POM metadata.

      By default, this Mojo looks for supplemental model data in the file "${appendedResourcesDirectory}/supplemental-models.xml".

      Since:
      1.0-alpha-5

    • supplementalModelArtifacts

      @Parameter private List<String> supplementalModelArtifacts
      List of artifacts that are added to the search path when looking for supplementalModels, expressed with groupId:artifactId:version[:type[:classifier]] format.
      Since:
      1.1

    • resourceBundles

      @Parameter(property="resourceBundles", required=true) private List<String> resourceBundles
      The resource bundles that will be retrieved and processed, expressed with groupId:artifactId:version[:type[:classifier]] format.

    • skip

      @Parameter(property="remoteresources.skip", defaultValue="false") private boolean skip
      Skip remote-resource processing
      Since:
      1.0-alpha-5

    • attachToMain

      @Parameter(defaultValue="true", property="attachToMain") private boolean attachToMain
      Attaches the resources to the main build of the project as a resource directory.
      Since:
      1.5

    • attachToTest

      @Parameter(defaultValue="true", property="attachToTest") private boolean attachToTest
      Attaches the resources to the test build of the project as a resource directory.
      Since:
      1.5

    • properties

      @Parameter protected Map<String,String> properties
      Additional properties to be passed to Velocity. Several properties are automatically added:
      • project - the current MavenProject
      • projects - the list of dependency projects
      • projectsSortedByOrganization - the list of dependency projects sorted by organization
      • projectTimespan - the timespan of the current project (requires inceptionYear in pom)
      • locator - the ResourceManager that can be used to retrieve additional resources
      See the javadoc for MavenProject for information about the properties on the MavenProject.

    • includeProjectProperties

      @Deprecated @Parameter(defaultValue="false") protected boolean includeProjectProperties
      Deprecated.
      as Maven Project is available in Velocity context we can simply use $project.properties.propertyName
      Whether to include properties defined in the project when filtering resources.
      Since:
      1.2

    • velocityFilterInMemoryThreshold

      @Deprecated @Parameter(defaultValue="5242880") protected int velocityFilterInMemoryThreshold
      Deprecated.
      not used anymore
      When the result of velocity transformation fits in memory, it is compared with the actual contents on disk to eliminate unnecessary destination file overwrite. This improves build times since further build steps typically rely on the modification date.
      Since:
      1.6

    • mavenSession

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

    • project

      @Parameter(defaultValue="${project}", readonly=true, required=true) protected org.apache.maven.project.MavenProject project
      The current project.

    • includeScope

      @Parameter(property="includeScope", defaultValue="runtime") protected String includeScope
      Scope to include. An Empty string indicates all scopes (default is "runtime").
      Since:
      1.0

    • excludeScope

      @Parameter(property="excludeScope", defaultValue="") protected String excludeScope
      Scope to exclude. An Empty string indicates no scopes (default).
      Since:
      1.0

    • resolveScopes

      @Parameter protected String[] resolveScopes
      When resolving project dependencies, specify the scopes to include. The default is the same as "includeScope" if there are no exclude scopes set. Otherwise, it defaults to "test" to grab all the dependencies so the exclude filters can filter out what is not needed.
      Since:
      1.5

    • excludeArtifactIds

      @Parameter(property="excludeArtifactIds", defaultValue="") protected String excludeArtifactIds
      Comma separated list of Artifact names to exclude.
      Since:
      1.0

    • includeArtifactIds

      @Parameter(property="includeArtifactIds", defaultValue="") protected String includeArtifactIds
      Comma separated list of Artifact names to include.
      Since:
      1.0

    • excludeGroupIds

      @Parameter(property="excludeGroupIds", defaultValue="") protected String excludeGroupIds
      Comma separated list of GroupId Names to exclude.
      Since:
      1.0

    • includeGroupIds

      @Parameter(property="includeGroupIds", defaultValue="") protected String includeGroupIds
      Comma separated list of GroupIds to include.
      Since:
      1.0

    • excludeTransitive

      @Parameter(property="excludeTransitive", defaultValue="false") protected boolean excludeTransitive
      If we should exclude transitive dependencies
      Since:
      1.0

    • outputTimestamp

      @Parameter(defaultValue="${project.build.outputTimestamp}") private String outputTimestamp
      Timestamp for reproducible output archive entries, either formatted as ISO 8601 yyyy-MM-dd'T'HH:mm:ssXXX or as an int representing seconds since the epoch (like SOURCE_DATE_EPOCH).

    • useProjectFiles

      @Parameter(defaultValue="false") private boolean useProjectFiles
      Indicate if project workspace files with the same name should be used instead of the ones from the bundle.
      Since:
      3.3.0

    • supplementModels

      private Map<String, org.apache.maven.model.Model> supplementModels
      Map of artifacts to supplemental project object models.

    • inheritanceAssembler

      private final ModelInheritanceAssembler inheritanceAssembler
      Merges supplemental data model with artifact metadata. Useful when processing artifacts with incomplete POM metadata.

    • velocity

      private org.apache.velocity.app.VelocityEngine velocity

    • repoSystem

      protected final org.eclipse.aether.RepositorySystem repoSystem

    • fileFilter

      private final org.apache.maven.shared.filtering.MavenFileFilter fileFilter
      Filtering support, for local resources that override those in the remote bundle.

    • locator

      private final org.codehaus.plexus.resource.ResourceManager locator

    • projectBuilder

      private final org.apache.maven.project.ProjectBuilder projectBuilder

    • artifactHandlerManager

      private final org.apache.maven.artifact.handler.manager.ArtifactHandlerManager artifactHandlerManager

    • KEY_PROJECTS

      private static final String KEY_PROJECTS
      See Also:

    • KEY_PROJECTS_ORGS

      private static final String KEY_PROJECTS_ORGS
      See Also:

  • Constructor Details

    • AbstractProcessRemoteResourcesMojo

      protected AbstractProcessRemoteResourcesMojo(org.eclipse.aether.RepositorySystem repoSystem, org.apache.maven.shared.filtering.MavenFileFilter fileFilter, org.codehaus.plexus.resource.ResourceManager locator, org.apache.maven.project.ProjectBuilder projectBuilder, org.apache.maven.artifact.handler.manager.ArtifactHandlerManager artifactHandlerManager)

  • Method Details

    • execute

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

    • configureLocator

      private void configureLocator() throws org.apache.maven.plugin.MojoExecutionException
      Throws:
      org.apache.maven.plugin.MojoExecutionException

    • getProjects

      protected List<org.apache.maven.project.MavenProject> getProjects()

    • getAllDependencies

      protected abstract Set<org.apache.maven.artifact.Artifact> getAllDependencies()
      Returns all the transitive hull of all the involved maven projects.

    • getDirectDependencies

      protected abstract Set<org.apache.maven.artifact.Artifact> getDirectDependencies()
      Returns all the direct dependencies of all the involved maven projects.

    • getProjectsSortedByOrganization

      protected Map<org.apache.maven.model.Organization, List<org.apache.maven.project.MavenProject>> getProjectsSortedByOrganization(List<org.apache.maven.project.MavenProject> projects)

    • copyResourceIfExists

      protected boolean copyResourceIfExists(File outputFile, String bundleResourceName, org.apache.velocity.VelocityContext context, String encoding) throws IOException, org.apache.maven.plugin.MojoExecutionException
      Throws:
      IOException
      org.apache.maven.plugin.MojoExecutionException

    • copyProjectRootIfExists

      private boolean copyProjectRootIfExists(File outputFile, String bundleResourceName) throws IOException
      Throws:
      IOException

    • getReader

      private Reader getReader(String readerEncoding, File file) throws IOException
      Throws:
      IOException

    • getWriter

      private Writer getWriter(String writerEncoding, OutputStream outputStream) throws IOException
      Throws:
      IOException

    • setupRequest

      private org.apache.maven.shared.filtering.MavenFileFilterRequest setupRequest(org.apache.maven.model.Resource resource, File source, File file)

    • validate

      protected void validate() throws org.apache.maven.plugin.MojoExecutionException
      Throws:
      org.apache.maven.plugin.MojoExecutionException

    • buildVelocityContext

      protected org.apache.velocity.VelocityContext buildVelocityContext()

    • downloadBundles

      private List<File> downloadBundles(List<String> bundles) throws org.apache.maven.plugin.MojoExecutionException
      Throws:
      org.apache.maven.plugin.MojoExecutionException

    • initalizeClassloader

      private ClassLoader initalizeClassloader(List<File> artifacts) throws org.apache.maven.plugin.MojoExecutionException
      Throws:
      org.apache.maven.plugin.MojoExecutionException

    • processResourceBundles

      protected void processResourceBundles(ClassLoader classLoader, org.apache.velocity.VelocityContext context) throws org.apache.maven.plugin.MojoExecutionException
      Throws:
      org.apache.maven.plugin.MojoExecutionException

    • verifyRequiredProperties

      private void verifyRequiredProperties(RemoteResourcesBundle bundle, URL url) throws org.apache.maven.plugin.MojoExecutionException
      Throws:
      org.apache.maven.plugin.MojoExecutionException

    • getSupplement

      protected org.apache.maven.model.Model getSupplement(org.codehaus.plexus.util.xml.Xpp3Dom supplementModelXml) throws org.apache.maven.plugin.MojoExecutionException
      Throws:
      org.apache.maven.plugin.MojoExecutionException

    • mergeModels

      protected org.apache.maven.model.Model mergeModels(org.apache.maven.model.Model parent, org.apache.maven.model.Model child)

    • generateSupplementMapKey

      private static String generateSupplementMapKey(String groupId, String artifactId)

    • loadSupplements

      private Map<String, org.apache.maven.model.Model> loadSupplements(String[] models) throws org.apache.maven.plugin.MojoExecutionException
      Throws:
      org.apache.maven.plugin.MojoExecutionException

    • getLocationTemp

      private String getLocationTemp(String name)
      Convenience method to get the location of the specified file name.
      Parameters:
      name - the name of the file whose location is to be resolved
      Returns:
      a String that contains the absolute file name of the file