com.edugility.maven.liquibase

Class LiquibaseChangeLogArtifactsProcessor

java.lang.Object

com.edugility.maven.liquibase.LiquibaseChangeLogArtifactsProcessor

All Implemented Interfaces:

ArtifactsProcessor

public class LiquibaseChangeLogArtifactsProcessor
extends Object
implements ArtifactsProcessor

An ArtifactsProcessor for use in conjunction with the artifact-maven-plugin that creates a Liquibase changelog aggregating changelog fragments found in a MavenProject's dependencies.

Author:

Laird Nelson

See Also:

The documentation for the artifact-maven-plugin

Constructor Summary

Constructors

Constructor and Description
LiquibaseChangeLogArtifactsProcessor() Creates a new LiquibaseChangeLogArtifactsProcessor.

Method Summary

Modifier and Type	Method and Description
AggregateChangeLogGenerator	getChangeLogGenerator() Returns the AggregateChangeLogGenerator to be used to generate changelogs.
Collection<String>	getChangeLogResourceNames() Returns the relative names of resources representing Liquibase changelog fragments that this LiquibaseChangeLogArtifactsProcessor will look for.
Collection<? extends Artifact>	process(MavenProject project, Collection<? extends Artifact> artifacts, Log log) Harvests jar: URLs from the supplied resolved Artifacts and lists them in topological order as <include> elements inside a generated Liquibase changelog file.
void	setChangeLogGenerator(AggregateChangeLogGenerator changeLogGenerator) Sets the AggregateChangeLogGenerator to be used to generate changelogs.
void	setChangeLogResourceNames(Collection<String> changeLogResourceNames) Sets the Collection of relative resource names representing Liquibase changelog fragments that this LiquibaseChangeLogArtifactsProcessor will look for.

Methods inherited from class java.lang.Object

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

Constructor Detail

LiquibaseChangeLogArtifactsProcessor

public LiquibaseChangeLogArtifactsProcessor()

Creates a new LiquibaseChangeLogArtifactsProcessor.

Method Detail

getChangeLogGenerator

public AggregateChangeLogGenerator getChangeLogGenerator()

Returns the AggregateChangeLogGenerator to be used to generate changelogs.

This method may return null.

Returns:

an AggregateChangeLogGenerator, or null

See Also:

setChangeLogGenerator(AggregateChangeLogGenerator)

setChangeLogGenerator

public void setChangeLogGenerator(AggregateChangeLogGenerator changeLogGenerator)

Sets the AggregateChangeLogGenerator to be used to generate changelogs.

Parameters:

changeLogGenerator - the new generator to use; may be null in which case a new AggregateChangeLogGenerator will be used internally instead

See Also:

getChangeLogGenerator()

getChangeLogResourceNames

public Collection<String> getChangeLogResourceNames()

Returns the relative names of resources representing Liquibase changelog fragments that this LiquibaseChangeLogArtifactsProcessor will look for.

This method may return null.

Typically, this method returns a singleton Collection containing the text META-INF/liquibase/changelog.xml.

Returns:

a Collection of relative resource names representing Liquibase changelog fragments, or null

See Also:

setChangeLogResourceNames(Collection)

setChangeLogResourceNames

public void setChangeLogResourceNames(Collection<String> changeLogResourceNames)

Sets the Collection of relative resource names representing Liquibase changelog fragments that this LiquibaseChangeLogArtifactsProcessor will look for.

Parameters:

changeLogResourceNames - the names; may be null

See Also:

getChangeLogResourceNames()

process

public Collection<? extends Artifact> process(MavenProject project,
                                              Collection<? extends Artifact> artifacts,
                                              Log log)
                                       throws ArtifactsProcessingException

Harvests jar: URLs from the supplied resolved Artifacts and lists them in topological order as <include> elements inside a generated Liquibase changelog file.

This method never returns null.

Specified by:

process in interface ArtifactsProcessor

Parameters:

project - the MavenProject currently in effect; will not be null

artifacts - a Collection of Artifacts representing the full, transitive set of resolved dependencies of the supplied MavenProject; will not be null

log - a Log for logging to a Maven console; may be null

Returns:

the supplied artifacts

Throws:

ArtifactsProcessingException - if an error occurs

See Also:

ArtifactsProcessor