top.marchand.xml.maven.catalog

Class Catalog

java.lang.Object

org.apache.maven.plugin.AbstractMojo

top.marchand.xml.maven.catalog.Catalog

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

@Mojo(name="catalog",
      defaultPhase=PROCESS_RESOURCES,
      requiresDependencyResolution=COMPILE)
public class Catalog
extends org.apache.maven.plugin.AbstractMojo

Generates a catalog, based on dependency tree, where each dependency is re-written to the jar URL.

Field Summary

Fields

Modifier and Type	Field and Description
static String[]	ALLOWED_REWRITES
static String[]	ALLOWED_URI_PATTERNS
String	catalogFileName The catalog file.
List<DelegateEntry>	delegatesPublic Allows to add <delegatePublic /> entries to generated catalog.
List<DelegateEntry>	delegatesSystem Allows to add <delegateSystem /> entries to generated catalog.
List<DelegateEntry>	delegatesURI Allows to add <delegateURI /> entries to generated catalog.
List<String>	excludes List of artifacts to exclude.
boolean	generateOxygenCatalog Allows to generate a special catalog for Oxygen, where jar:file:/ URIs are transformed to zip:file:/ URIs.
List<String>	generates The entries to add in catalog.
boolean	includeCurrentArtifact If true, current artifact (the project which is actually built) will be included in catalog.
List<String>	includes List of artifacts to include.
List<String>	nextCatalogs The next catalog to add to catalog.
org.apache.maven.project.MavenProject	project Current project
boolean	removeDoctype If set to true, removes the DOCTYPE from catalog file.
static String	SCHEME
List<String>	uriPatterns The URI patterns to generate.

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

ROLE

Constructor Summary

Constructors

Constructor and Description
Catalog()

Method Summary

Modifier and Type	Method and Description
protected String	buildPattern(String pattern, String groupId, String artifactId, String version)
void	execute()
protected boolean	shouldProcessDependency(org.apache.maven.shared.dependency.graph.DependencyNode dn)
protected void	writeCatalogEntry(XMLStreamWriter writer, String entry, RewriteSystemModel rsm)
protected void	writeDelegateEntry(XMLStreamWriter writer, String delegate, DelegateEntry entry)

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

SCHEME

public static final transient String SCHEME

See Also:

Constant Field Values

project

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

Current project

catalogFileName

@Parameter(defaultValue="catalog.xml")
public String catalogFileName

The catalog file. It is always a path relative to ${project.basedir}.

uriPatterns

@Parameter
public List<String> uriPatterns

The URI patterns to generate. Valid values are :

Kind of patterns and URIs

pattern	URI form
standard	dependency:/goupId+artifactId/path/to/file.xml
full	dependency:/groupId+artifactId$version/path/to/file.xml

generates

@Parameter
public List<String> generates

The entries to add in catalog. If not defined, <rewriteURI/> and <rewriteSystem/> will be generated.

includeCurrentArtifact

@Parameter
public boolean includeCurrentArtifact

If true, current artifact (the project which is actually built) will be included in catalog. This does not depend on includes and excludes

nextCatalogs

@Parameter
public List<String> nextCatalogs

The next catalog to add to catalog. If null, no <nextCatalog/> will be added.

excludes

@Parameter
public List<String> excludes

List of artifacts to exclude. Each artifact must be specified as groupId:artifactId. Both groupId and artifactId can be replaced by *. excludes and includes are exclusives, and must not be used together. If excludes is specified, all dependencies are used, except the ones that match excludes. Project's artifact is processed neither by excludes nor includes

includes

@Parameter
public List<String> includes

List of artifacts to include. Each artifact must be specified as groupId:artifactId. Both groupId and artifactId can be replaced by *. includes and excludes are exclusives, and must not be used together. If includes is specified, all dependencies that match includes are used. Project's artifact is processed neither by excludes nor includes

delegatesPublic

@Parameter
public List<DelegateEntry> delegatesPublic

Allows to add <delegatePublic /> entries to generated catalog. Each entry should be as :

<delegateEntry>
   <startString>publicIdStartString</startString>
   <catalog>catalog</catalog>
 </delegateEntry>

delegatesSystem

@Parameter
public List<DelegateEntry> delegatesSystem

Allows to add <delegateSystem /> entries to generated catalog. Each entry should be as :

<delegateEntry>
   <startString>systemIdStartString</startString>
   <catalog>catalog</catalog>
 </delegateEntry>

delegatesURI

@Parameter
public List<DelegateEntry> delegatesURI

Allows to add <delegateURI /> entries to generated catalog. Each entry should be as :

<delegateEntry>
   <startString>uriStartString</startString>
   <catalog>catalog</catalog>
 </delegateEntry>

removeDoctype

@Parameter(defaultValue="true")
public boolean removeDoctype

If set to true, removes the DOCTYPE from catalog file. Default is true, so this is a major change since 1.0.6

Since:

1.0.7

generateOxygenCatalog

@Parameter(defaultValue="false")
public boolean generateOxygenCatalog

Allows to generate a special catalog for Oxygen, where jar:file:/ URIs are transformed to zip:file:/ URIs. Oxygen has a special mecanism to load these kind of resources.

ALLOWED_URI_PATTERNS

public static final transient String[] ALLOWED_URI_PATTERNS

ALLOWED_REWRITES

public static final transient String[] ALLOWED_REWRITES

Constructor Detail

Catalog

public Catalog()

Method Detail

execute

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

Throws:

org.apache.maven.plugin.MojoExecutionException

shouldProcessDependency

protected boolean shouldProcessDependency(org.apache.maven.shared.dependency.graph.DependencyNode dn)

buildPattern

protected String buildPattern(String pattern,
                              String groupId,
                              String artifactId,
                              String version)

writeDelegateEntry

protected void writeDelegateEntry(XMLStreamWriter writer,
                                  String delegate,
                                  DelegateEntry entry)
                           throws XMLStreamException,
                                  org.apache.maven.plugin.MojoExecutionException

Throws:

XMLStreamException

org.apache.maven.plugin.MojoExecutionException

writeCatalogEntry

protected void writeCatalogEntry(XMLStreamWriter writer,
                                 String entry,
                                 RewriteSystemModel rsm)
                          throws XMLStreamException,
                                 org.apache.maven.plugin.MojoExecutionException

Throws:

XMLStreamException

org.apache.maven.plugin.MojoExecutionException