org.apache.maven.plugin.resources.remote
Class ProcessRemoteResourcesMojo

java.lang.Object
  extended by org.apache.maven.plugin.AbstractMojo
      extended by org.apache.maven.plugin.resources.remote.ProcessRemoteResourcesMojo
All Implemented Interfaces:
org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

public class ProcessRemoteResourcesMojo
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".


Field Summary
protected  java.io.File basedir
          Used for calculation of execution-root for runOnlyAtExecutionRoot.
protected  org.apache.maven.ProjectDependenciesResolver dependencyResolver
           
protected  java.lang.String encoding
          The character encoding scheme to be applied when filtering resources.
protected  java.lang.String excludeArtifactIds
          Comma separated list of Artifact names too exclude.
protected  java.lang.String excludeGroupIds
          Comma separated list of GroupId Names to exclude.
protected  java.lang.String excludeScope
          Scope to exclude.
protected  boolean excludeTransitive
          If we should exclude transitive dependencies
protected  java.util.List<java.lang.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.
protected  java.lang.String includeArtifactIds
          Comma separated list of Artifact names to include.
protected  java.lang.String includeGroupIds
          Comma separated list of GroupIds to include.
protected  java.lang.String includeScope
          Scope to include.
protected  boolean runOnlyAtExecutionRoot
          If true, only generate resources in the directory of the root project in a multimodule build.
protected  boolean useDefaultFilterDelimiters
           
 
Fields inherited from interface org.apache.maven.plugin.Mojo
ROLE
 
Constructor Summary
ProcessRemoteResourcesMojo()
           
 
Method Summary
protected  void configureVelocityContext(org.apache.velocity.VelocityContext context)
           
protected  boolean copyResourceIfExists(java.io.File file, java.lang.String relFileName, org.apache.velocity.VelocityContext context)
           
 void execute()
           
protected  java.util.List<org.apache.maven.project.MavenProject> getProjects()
           
protected  java.util.Map<org.apache.maven.model.Organization,java.util.List<org.apache.maven.project.MavenProject>> getProjectsSortedByOrganization(java.util.List<org.apache.maven.project.MavenProject> projects)
           
protected  org.apache.maven.model.Model getSupplement(org.codehaus.plexus.util.xml.Xpp3Dom supplementModelXml)
           
protected  org.apache.maven.model.Model mergeModels(org.apache.maven.model.Model parent, org.apache.maven.model.Model child)
           
protected  void processResourceBundles(RemoteResourcesClassLoader classLoader, org.apache.velocity.VelocityContext context)
           
protected  void validate()
           
 
Methods inherited from class org.apache.maven.plugin.AbstractMojo
getLog, getPluginContext, setLog, setPluginContext
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

filterDelimiters

protected java.util.List<java.lang.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

protected boolean useDefaultFilterDelimiters
Since:
1.1

runOnlyAtExecutionRoot

protected boolean runOnlyAtExecutionRoot
If true, only generate resources in the directory of the root project in a multimodule build. Dependencies from all modules will be aggregated before resource-generation takes place.

Since:
1.1

basedir

protected java.io.File basedir
Used for calculation of execution-root for runOnlyAtExecutionRoot.


encoding

protected java.lang.String encoding
The character encoding scheme to be applied when filtering resources.


includeScope

protected java.lang.String includeScope
Scope to include. An Empty string indicates all scopes (default).

Since:
1.0

excludeScope

protected java.lang.String excludeScope
Scope to exclude. An Empty string indicates no scopes (default).

Since:
1.0

excludeArtifactIds

protected java.lang.String excludeArtifactIds
Comma separated list of Artifact names too exclude.

Since:
1.0

includeArtifactIds

protected java.lang.String includeArtifactIds
Comma separated list of Artifact names to include.

Since:
1.0

excludeGroupIds

protected java.lang.String excludeGroupIds
Comma separated list of GroupId Names to exclude.

Since:
1.0

includeGroupIds

protected java.lang.String includeGroupIds
Comma separated list of GroupIds to include.

Since:
1.0

excludeTransitive

protected boolean excludeTransitive
If we should exclude transitive dependencies

Since:
1.0

dependencyResolver

protected org.apache.maven.ProjectDependenciesResolver dependencyResolver
Constructor Detail

ProcessRemoteResourcesMojo

public ProcessRemoteResourcesMojo()
Method Detail

execute

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

getProjects

protected java.util.List<org.apache.maven.project.MavenProject> getProjects()
                                                                     throws org.apache.maven.plugin.MojoExecutionException
Throws:
org.apache.maven.plugin.MojoExecutionException

getProjectsSortedByOrganization

protected java.util.Map<org.apache.maven.model.Organization,java.util.List<org.apache.maven.project.MavenProject>> getProjectsSortedByOrganization(java.util.List<org.apache.maven.project.MavenProject> projects)
                                                                                                                                            throws org.apache.maven.plugin.MojoExecutionException
Throws:
org.apache.maven.plugin.MojoExecutionException

copyResourceIfExists

protected boolean copyResourceIfExists(java.io.File file,
                                       java.lang.String relFileName,
                                       org.apache.velocity.VelocityContext context)
                                throws java.io.IOException,
                                       org.apache.maven.plugin.MojoExecutionException
Throws:
java.io.IOException
org.apache.maven.plugin.MojoExecutionException

validate

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

configureVelocityContext

protected void configureVelocityContext(org.apache.velocity.VelocityContext context)
                                 throws org.apache.maven.plugin.MojoExecutionException
Throws:
org.apache.maven.plugin.MojoExecutionException

processResourceBundles

protected void processResourceBundles(RemoteResourcesClassLoader classLoader,
                                      org.apache.velocity.VelocityContext context)
                               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)


Copyright © 2002-2010 Apache Software Foundation. All Rights Reserved.