org.jboss.shrinkwrap.resolver.api.maven.archive.importer

Interface MavenImporter

All Superinterfaces:

org.jboss.shrinkwrap.api.Assignable, PomlessMavenImporter

public interface MavenImporter
extends PomlessMavenImporter, org.jboss.shrinkwrap.api.Assignable

MavenImporter is an abstraction of Maven Package phase for ShrinkWrap. It allows to package an archive based on pom.xml file.

Author:

Karel Piwko

Method Summary

Modifier and Type	Method and Description
ConfiguredMavenImporter	configureFromClassloaderResource(String path) Optional operation.
ConfiguredMavenImporter	configureFromClassloaderResource(String path, ClassLoader cl) Optional operation.
ConfiguredMavenImporter	configureFromFile(File file) Optional operation.
ConfiguredMavenImporter	configureFromFile(String pathToFile) Optional operation.

Methods inherited from interface org.jboss.shrinkwrap.resolver.api.maven.archive.importer.PomlessMavenImporter

loadPomFromClassLoaderResource, loadPomFromClassLoaderResource, loadPomFromClassLoaderResource, loadPomFromFile, loadPomFromFile, loadPomFromFile, loadPomFromFile, offline, offline

Methods inherited from interface org.jboss.shrinkwrap.api.Assignable

as

Method Detail

configureFromFile

ConfiguredMavenImporter configureFromFile(File file)
                                   throws IllegalArgumentException,
                                          UnsupportedOperationException,
                                          org.jboss.shrinkwrap.resolver.api.InvalidConfigurationFileException

Optional operation. Configures this MavenImporter from the specified settings.xml file

Parameters:

file - A settings.xml File this MavenImporter should be configured from.

Returns:

This configured MavenImporter

Throws:

IllegalArgumentException - If the file is not specified, is a directory, or does not exist

org.jboss.shrinkwrap.resolver.api.InvalidConfigurationFileException - If the configuration file contents are not in appropriate format

UnsupportedOperationException - If this ConfigurableResolverSystem does not support configuration by File

configureFromFile

ConfiguredMavenImporter configureFromFile(String pathToFile)
                                   throws IllegalArgumentException,
                                          UnsupportedOperationException,
                                          org.jboss.shrinkwrap.resolver.api.InvalidConfigurationFileException

Optional operation. Configures this MavenImporter from the specified settings.xml file at the specified path

Parameters:

pathToFile - A path to a settings.xml file this MavenImporter should be configured from.

Returns:

This configured MavenImporter

Throws:

IllegalArgumentException - If the file is not specified, is a directory, or does not exist

org.jboss.shrinkwrap.resolver.api.InvalidConfigurationFileException - If the configuration file contents are not in appropriate format

UnsupportedOperationException - If this ConfigurableResolverSystem does not support configuration by File

org.jboss.shrinkwrap.resolver.api.InvalidConfigurationFileException - If the configuration file contents are not in appropriate format

configureFromClassloaderResource

ConfiguredMavenImporter configureFromClassloaderResource(String path)
                                                  throws IllegalArgumentException,
                                                         UnsupportedOperationException,
                                                         org.jboss.shrinkwrap.resolver.api.InvalidConfigurationFileException

Optional operation. Configures this MavenImporter from the result of ClassLoader.getResource(String) call using the current Thread.getContextClassLoader()

Parameters:

path - A ClassLoader path to a settings.xml file this MavenImporter should be configured from.

Returns:

This configured MavenImporter

Throws:

IllegalArgumentException - If the either argument is not specified or if the path can not be found

UnsupportedOperationException - If this ConfigurableResolverSystem does not support configuration by ClassLoader resource

org.jboss.shrinkwrap.resolver.api.InvalidConfigurationFileException - If the configuration file contents are not in appropriate format

configureFromClassloaderResource

ConfiguredMavenImporter configureFromClassloaderResource(String path,
                                                         ClassLoader cl)
                                                  throws IllegalArgumentException,
                                                         UnsupportedOperationException,
                                                         org.jboss.shrinkwrap.resolver.api.InvalidConfigurationFileException

Optional operation. Configures this ConfigurableResolverSystem from the result of ClassLoader.getResource(String) using the specified ClassLoader

Parameters:

path - A ClassLoader path to a settings.xml file this MavenImporter should be configured from.

cl - A ClassLoader

Returns:

This configured MavenImporter

Throws:

IllegalArgumentException - If the either argument is not specified or if the path can not be found

UnsupportedOperationException - If this ConfigurableResolverSystem does not support configuration by ClassLoader resource

org.jboss.shrinkwrap.resolver.api.InvalidConfigurationFileException - If the configuration file contents are not in appropriate format