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

Interface PomlessMavenImporter

All Known Subinterfaces:

ConfiguredMavenImporter, MavenImporter

public interface PomlessMavenImporter

Instance of MavenImporter that allows to load configuration from a POM file

Author:

Karel Piwko

Method Summary

Modifier and Type	Method and Description
PomEquippedMavenImporter	loadPomFromClassLoaderResource(String pathToPomResource) Configures the Maven Importer from Project Object Model contained in the POM file located at the specified ClassLoader resource path, loaded by the current Thread.getContextClassLoader().
PomEquippedMavenImporter	loadPomFromClassLoaderResource(String pathToPomResource, ClassLoader cl) Configures the Maven Importer from Project Object Model contained in the POM file located at the specified ClassLoader resource path, loaded by the specified ClassLoader.
PomEquippedMavenImporter	loadPomFromClassLoaderResource(String pathToPomResource, ClassLoader cl, String... profiles) Configures the Maven Importer from Project Object Model contained in the POM file located at the specified ClassLoader resource path, loaded by the specified ClassLoader.
PomEquippedMavenImporter	loadPomFromFile(File pomFile) Configures the Maven Importer from Project Object Model contained in the specified POM File.
PomEquippedMavenImporter	loadPomFromFile(File pomFile, String... profiles) Configures the Maven Importer from Project Object Model contained in the specified POM File.
PomEquippedMavenImporter	loadPomFromFile(String pathToPomFile) Configures the Maven Importer from Project Object Model contained in the POM file located at the specified path.
PomEquippedMavenImporter	loadPomFromFile(String pathToPomFile, String... profiles) Configures the Maven Importer from Project Object Model contained in the POM file located at the specified path.
PomlessMavenImporter	offline() Optional operation.
PomlessMavenImporter	offline(boolean offline) Optional operation.

Method Detail

loadPomFromFile

PomEquippedMavenImporter loadPomFromFile(File pomFile)
                                  throws IllegalArgumentException,
                                         org.jboss.shrinkwrap.resolver.api.InvalidConfigurationFileException

Configures the Maven Importer from Project Object Model contained in the specified POM File.

Parameters:

pomFile - A POM File the maven Importer should be configured from.

Returns:

The configured Maven Importer from the given Project Object Model.

Throws:

IllegalArgumentException - If no file was specified, if the file does not exist or points to a directory

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

loadPomFromFile

PomEquippedMavenImporter loadPomFromFile(File pomFile,
                                         String... profiles)
                                  throws IllegalArgumentException,
                                         org.jboss.shrinkwrap.resolver.api.InvalidConfigurationFileException

Configures the Maven Importer from Project Object Model contained in the specified POM File.

Parameters:

pomFile - A POM File the maven Importer should be configured from.

profiles - Active/inactive profiles

Returns:

The configured Maven Importer from the given Project Object Model.

Throws:

IllegalArgumentException - If no file was specified, if the file does not exist or points to a directory

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

loadPomFromFile

PomEquippedMavenImporter loadPomFromFile(String pathToPomFile)
                                  throws IllegalArgumentException,
                                         org.jboss.shrinkwrap.resolver.api.InvalidConfigurationFileException

Configures the Maven Importer from Project Object Model contained in the POM file located at the specified path. The path will be represented as a new File by means of File.File(String)

Parameters:

pathToPomFile - A path to a POM file the maven Importer should be configured from.

Returns:

The configured Maven Importer from the given Project Object Model.

Throws:

IllegalArgumentException - If no path was specified, or if the path points to a file which does not exist or is a directory

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

loadPomFromFile

PomEquippedMavenImporter loadPomFromFile(String pathToPomFile,
                                         String... profiles)
                                  throws IllegalArgumentException,
                                         org.jboss.shrinkwrap.resolver.api.InvalidConfigurationFileException

Configures the Maven Importer from Project Object Model contained in the POM file located at the specified path. The path will be represented as a new File by means of File.File(String)

Parameters:

pathToPomFile - A path to a POM file the maven Importer should be configured from.

profiles - Active/inactive profiles

Returns:

The configured Maven Importer from the given Project Object Model.

Throws:

IllegalArgumentException - If no path was specified, or if the path points to a file which does not exist or is a directory

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

loadPomFromClassLoaderResource

PomEquippedMavenImporter loadPomFromClassLoaderResource(String pathToPomResource)
                                                 throws IllegalArgumentException,
                                                        org.jboss.shrinkwrap.resolver.api.InvalidConfigurationFileException

Configures the Maven Importer from Project Object Model contained in the POM file located at the specified ClassLoader resource path, loaded by the current Thread.getContextClassLoader().

Parameters:

pathToPomResource - A ClassLoader resource path to a POM filee the maven Importer should be configured from.

Returns:

The configured Maven Importer from the given Project Object Model.

Throws:

IllegalArgumentException - If no path was specified, or if the resource could not be found at the specified path

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

loadPomFromClassLoaderResource

PomEquippedMavenImporter loadPomFromClassLoaderResource(String pathToPomResource,
                                                        ClassLoader cl)
                                                 throws IllegalArgumentException,
                                                        org.jboss.shrinkwrap.resolver.api.InvalidConfigurationFileException

Configures the Maven Importer from Project Object Model contained in the POM file located at the specified ClassLoader resource path, loaded by the specified ClassLoader.

Parameters:

pathToPomResource - A ClassLoader resource path to a POM filee the maven Importer should be configured from.

cl - A ClassLoader

Returns:

The configured Maven Importer from the given Project Object Model.

Throws:

IllegalArgumentException - If no path was specified, no ClassLoader was specified, or if the resource could not be found at the specified path

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

loadPomFromClassLoaderResource

PomEquippedMavenImporter loadPomFromClassLoaderResource(String pathToPomResource,
                                                        ClassLoader cl,
                                                        String... profiles)
                                                 throws IllegalArgumentException,
                                                        org.jboss.shrinkwrap.resolver.api.InvalidConfigurationFileException

Configures the Maven Importer from Project Object Model contained in the POM file located at the specified ClassLoader resource path, loaded by the specified ClassLoader.

Parameters:

pathToPomResource - A ClassLoader resource path to a POM filee the maven Importer should be configured from.

cl - A ClassLoader

profiles - Active/inactive profiles

Returns:

The configured Maven Importer from the given Project Object Model.

Throws:

IllegalArgumentException - If no path was specified, no ClassLoader was specified, any specified profiles are invalid or null, or if the resource could not be found at the specified path

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

offline

PomlessMavenImporter offline(boolean offline)

Optional operation. Sets whether resolution should be done in "offline" (ie. not connected to Internet) mode. By default, resolution is done in online mode

Parameters:

offline - Whether resolution should be done in "offline". By default, resolution is done in online mode.

Returns:

Modified PomlessMavenImporter instance

offline

PomlessMavenImporter offline()

Optional operation. Sets that resolution should be done in "offline" (ie. not connected to Internet) mode. Alias to offline(boolean), passing true as a parameter.

Returns:

Modified PomlessMavenImporter instance