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:
ContextEnabled, Mojo, LogChute

@Mojo(name="process",
      defaultPhase=GENERATE_RESOURCES,
      threadSafe=true)
public class ProcessRemoteResourcesMojo
extends AbstractMojo
implements LogChute

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  File basedir
          Used for calculation of execution-root for runOnlyAtExecutionRoot.
protected  ProjectDependenciesResolver dependencyResolver
           
protected  String encoding
          The character encoding scheme to be applied when filtering resources.
protected  String excludeArtifactIds
          Comma separated list of Artifact names too exclude.
protected  String excludeGroupIds
          Comma separated list of GroupId Names to exclude.
protected  String excludeScope
          Scope to exclude.
protected  boolean excludeTransitive
          If we should exclude transitive dependencies
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.
protected  String includeArtifactIds
          Comma separated list of Artifact names to include.
protected  String includeGroupIds
          Comma separated list of GroupIds to include.
protected  boolean includeProjectProperties
          Whether to include properties defined in the project when filtering resources.
protected  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.velocity.runtime.log.LogChute
DEBUG_ID, DEBUG_PREFIX, ERROR_ID, ERROR_PREFIX, INFO_ID, INFO_PREFIX, TRACE_ID, TRACE_PREFIX, WARN_ID, WARN_PREFIX
 
Fields inherited from interface org.apache.maven.plugin.Mojo
ROLE
 
Constructor Summary
ProcessRemoteResourcesMojo()
           
 
Method Summary
protected  void configureVelocityContext(VelocityContext context)
           
protected  boolean copyResourceIfExists(File file, String relFileName, VelocityContext context)
           
 void execute()
           
protected  List<MavenProject> getProjects()
           
protected  Map<Organization,List<MavenProject>> getProjectsSortedByOrganization(List<MavenProject> projects)
           
protected  Model getSupplement(Xpp3Dom supplementModelXml)
           
 void init(RuntimeServices rs)
           
 boolean isLevelEnabled(int level)
           
 void log(int level, String message)
           
 void log(int level, String message, Throwable t)
           
protected  Model mergeModels(Model parent, Model child)
           
protected  void processResourceBundles(RemoteResourcesClassLoader classLoader, 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

@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

runOnlyAtExecutionRoot

@Parameter(defaultValue="false")
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

@Parameter(defaultValue="${basedir}",
           readonly=true,
           required=true)
protected File basedir
Used for calculation of execution-root for runOnlyAtExecutionRoot.


encoding

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


includeProjectProperties

@Parameter(defaultValue="false")
protected boolean includeProjectProperties
Whether to include properties defined in the project when filtering resources.

Since:
1.2

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

excludeArtifactIds

@Parameter(property="excludeArtifactIds",
           defaultValue="")
protected String excludeArtifactIds
Comma separated list of Artifact names too 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

dependencyResolver

@Component(hint="default")
protected ProjectDependenciesResolver dependencyResolver
Constructor Detail

ProcessRemoteResourcesMojo

public ProcessRemoteResourcesMojo()
Method Detail

execute

public void execute()
             throws MojoExecutionException
Specified by:
execute in interface Mojo
Throws:
MojoExecutionException

getProjects

protected List<MavenProject> getProjects()
                                  throws MojoExecutionException
Throws:
MojoExecutionException

getProjectsSortedByOrganization

protected Map<Organization,List<MavenProject>> getProjectsSortedByOrganization(List<MavenProject> projects)
                                                                        throws MojoExecutionException
Throws:
MojoExecutionException

copyResourceIfExists

protected boolean copyResourceIfExists(File file,
                                       String relFileName,
                                       VelocityContext context)
                                throws IOException,
                                       MojoExecutionException
Throws:
IOException
MojoExecutionException

validate

protected void validate()
                 throws MojoExecutionException
Throws:
MojoExecutionException

configureVelocityContext

protected void configureVelocityContext(VelocityContext context)
                                 throws MojoExecutionException
Throws:
MojoExecutionException

processResourceBundles

protected void processResourceBundles(RemoteResourcesClassLoader classLoader,
                                      VelocityContext context)
                               throws MojoExecutionException
Throws:
MojoExecutionException

getSupplement

protected Model getSupplement(Xpp3Dom supplementModelXml)
                       throws MojoExecutionException
Throws:
MojoExecutionException

mergeModels

protected Model mergeModels(Model parent,
                            Model child)

init

public void init(RuntimeServices rs)
          throws Exception
Specified by:
init in interface LogChute
Throws:
Exception

log

public void log(int level,
                String message)
Specified by:
log in interface LogChute

log

public void log(int level,
                String message,
                Throwable t)
Specified by:
log in interface LogChute

isLevelEnabled

public boolean isLevelEnabled(int level)
Specified by:
isLevelEnabled in interface LogChute


Copyright © 2002-2013 The Apache Software Foundation. All Rights Reserved.