org.jboss.shrinkwrap.resolver.impl.maven.archive.packaging

Class WarPackagingProcessor

java.lang.Object

org.jboss.shrinkwrap.resolver.impl.maven.archive.packaging.AbstractCompilingProcessor<org.jboss.shrinkwrap.api.spec.WebArchive>

org.jboss.shrinkwrap.resolver.impl.maven.archive.packaging.WarPackagingProcessor

All Implemented Interfaces:

PackagingProcessor<org.jboss.shrinkwrap.api.spec.WebArchive>

public class WarPackagingProcessor
extends AbstractCompilingProcessor<org.jboss.shrinkwrap.api.spec.WebArchive>
implements PackagingProcessor<org.jboss.shrinkwrap.api.spec.WebArchive>

Packaging processor for Maven projects of WAR packaging type

Author:

Karel Piwko

Field Summary

Fields

Modifier and Type	Field and Description
static String	MAVEN_WAR_PLUGIN_KEY

Fields inherited from class org.jboss.shrinkwrap.resolver.impl.maven.archive.packaging.AbstractCompilingProcessor

session

Constructor Summary

Constructors

Constructor and Description
WarPackagingProcessor()

Method Summary

Modifier and Type	Method and Description
WarPackagingProcessor	configure(org.jboss.shrinkwrap.api.Archive<?> archive, MavenWorkingSession session) Configures packaging processor by passing Maven working session and original archive
protected org.jboss.shrinkwrap.api.Filter<org.jboss.shrinkwrap.api.ArchivePath>	createFilter(WarPluginConfiguration configuration)
protected String[]	getFilesToIncludes(File baseDir, String[] includes, String[] excludes) Returns the file to copy.
org.jboss.shrinkwrap.api.spec.WebArchive	getResultingArchive() Returns archive as a ShrinkWrap archive
boolean	handles(PackagingType packagingType) Check that packagingType is supported by this packaging processor
WarPackagingProcessor	importBuildOutput(MavenResolutionStrategy strategy) Compiles, packages and resolve dependencies for the project.

Methods inherited from class org.jboss.shrinkwrap.resolver.impl.maven.archive.packaging.AbstractCompilingProcessor

compile, configure, hasGeneratedName

Methods inherited from class java.lang.Object

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

Field Detail

MAVEN_WAR_PLUGIN_KEY

public static final String MAVEN_WAR_PLUGIN_KEY

See Also:

Constant Field Values

Constructor Detail

WarPackagingProcessor

public WarPackagingProcessor()

Method Detail

handles

public boolean handles(PackagingType packagingType)

Description copied from interface: PackagingProcessor

Check that packagingType is supported by this packaging processor

Specified by:

handles in interface PackagingProcessor<org.jboss.shrinkwrap.api.spec.WebArchive>

Returns:

configure

public WarPackagingProcessor configure(org.jboss.shrinkwrap.api.Archive<?> archive,
                                       MavenWorkingSession session)

Description copied from interface: PackagingProcessor

Configures packaging processor by passing Maven working session and original archive

Specified by:

configure in interface PackagingProcessor<org.jboss.shrinkwrap.api.spec.WebArchive>

Parameters:

archive - Original archive holder

session - Current Maven working session

Returns:

Modified instance for chaining

getResultingArchive

public org.jboss.shrinkwrap.api.spec.WebArchive getResultingArchive()

Description copied from interface: PackagingProcessor

Returns archive as a ShrinkWrap archive

Specified by:

getResultingArchive in interface PackagingProcessor<org.jboss.shrinkwrap.api.spec.WebArchive>

Returns:

importBuildOutput

public WarPackagingProcessor importBuildOutput(MavenResolutionStrategy strategy)
                                        throws IllegalArgumentException,
                                               UnsupportedOperationException

Description copied from interface: PackagingProcessor

Compiles, packages and resolve dependencies for the project. Uses strategy to define what dependencies will be packaged into project.

Specified by:

importBuildOutput in interface PackagingProcessor<org.jboss.shrinkwrap.api.spec.WebArchive>

Parameters:

strategy - The strategy defining objects to be packaged

Returns:

Throws:

IllegalArgumentException - If strategy is null

UnsupportedOperationException

createFilter

protected org.jboss.shrinkwrap.api.Filter<org.jboss.shrinkwrap.api.ArchivePath> createFilter(WarPluginConfiguration configuration)

getFilesToIncludes

protected String[] getFilesToIncludes(File baseDir,
                                      String[] includes,
                                      String[] excludes)

Returns the file to copy. If the includes are null or empty, the default includes are used.

Parameters:

baseDir - the base directory to start from

includes - the includes

excludes - the excludes

Returns:

the files to copy