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

Class MavenImporterImpl

java.lang.Object

org.jboss.shrinkwrap.resolver.impl.maven.archive.importer.MavenImporterImpl

All Implemented Interfaces:

org.jboss.shrinkwrap.api.Assignable, ConfiguredMavenImporter, MavenImporter, PomlessMavenImporter

public class MavenImporterImpl
extends Object
implements MavenImporter, ConfiguredMavenImporter

Constructor Summary

Constructors

Constructor and Description
MavenImporterImpl(org.jboss.shrinkwrap.api.Archive<?> archive)

Method Summary

Modifier and Type	Method and Description
<TYPE extends org.jboss.shrinkwrap.api.Assignable> TYPE	as(Class<TYPE> type)
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.
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

MavenImporterImpl

public MavenImporterImpl(org.jboss.shrinkwrap.api.Archive<?> archive)

Method Detail

as

public <TYPE extends org.jboss.shrinkwrap.api.Assignable> TYPE as(Class<TYPE> type)

Specified by:

as in interface org.jboss.shrinkwrap.api.Assignable

configureFromClassloaderResource

public ConfiguredMavenImporter configureFromClassloaderResource(String path)
                                                         throws IllegalArgumentException,
                                                                UnsupportedOperationException,
                                                                InvalidConfigurationFileException

Description copied from interface: MavenImporter

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

Specified by:

configureFromClassloaderResource in interface MavenImporter

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

InvalidConfigurationFileException - If the configuration file contents are not in appropriate format

configureFromFile

public ConfiguredMavenImporter configureFromFile(File file)
                                          throws IllegalArgumentException,
                                                 UnsupportedOperationException,
                                                 InvalidConfigurationFileException

Description copied from interface: MavenImporter

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

Specified by:

configureFromFile in interface MavenImporter

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

UnsupportedOperationException - If this ConfigurableResolverSystem does not support configuration by File

InvalidConfigurationFileException - If the configuration file contents are not in appropriate format

configureFromFile

public ConfiguredMavenImporter configureFromFile(String pathToFile)
                                          throws IllegalArgumentException,
                                                 UnsupportedOperationException,
                                                 InvalidConfigurationFileException

Description copied from interface: MavenImporter

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

Specified by:

configureFromFile in interface MavenImporter

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

UnsupportedOperationException - If this ConfigurableResolverSystem does not support configuration by File

InvalidConfigurationFileException - If the configuration file contents are not in appropriate format

configureFromClassloaderResource

public ConfiguredMavenImporter configureFromClassloaderResource(String path,
                                                                ClassLoader cl)
                                                         throws IllegalArgumentException,
                                                                UnsupportedOperationException,
                                                                InvalidConfigurationFileException

Description copied from interface: MavenImporter

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

Specified by:

configureFromClassloaderResource in interface MavenImporter

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

InvalidConfigurationFileException - If the configuration file contents are not in appropriate format

loadPomFromFile

public PomEquippedMavenImporter loadPomFromFile(File pomFile)
                                         throws IllegalArgumentException,
                                                InvalidConfigurationFileException

Description copied from interface: PomlessMavenImporter

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

Specified by:

loadPomFromFile in interface PomlessMavenImporter

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

InvalidConfigurationFileException - If the configuration file contents are not in appropriate format

loadPomFromFile

public PomEquippedMavenImporter loadPomFromFile(File pomFile,
                                                String... profiles)
                                         throws IllegalArgumentException,
                                                InvalidConfigurationFileException

Description copied from interface: PomlessMavenImporter

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

Specified by:

loadPomFromFile in interface PomlessMavenImporter

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

InvalidConfigurationFileException - If the configuration file contents are not in appropriate format

loadPomFromFile

public PomEquippedMavenImporter loadPomFromFile(String pathToPomFile)
                                         throws IllegalArgumentException,
                                                InvalidConfigurationFileException

Description copied from interface: PomlessMavenImporter

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(String)

Specified by:

loadPomFromFile in interface PomlessMavenImporter

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

InvalidConfigurationFileException - If the configuration file contents are not in appropriate format

loadPomFromFile

public PomEquippedMavenImporter loadPomFromFile(String pathToPomFile,
                                                String... profiles)
                                         throws IllegalArgumentException,
                                                InvalidConfigurationFileException

Description copied from interface: PomlessMavenImporter

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(String)

Specified by:

loadPomFromFile in interface PomlessMavenImporter

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

InvalidConfigurationFileException - If the configuration file contents are not in appropriate format

loadPomFromClassLoaderResource

public PomEquippedMavenImporter loadPomFromClassLoaderResource(String pathToPomResource)
                                                        throws IllegalArgumentException,
                                                               InvalidConfigurationFileException

Description copied from interface: PomlessMavenImporter

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().

Specified by:

loadPomFromClassLoaderResource in interface PomlessMavenImporter

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

InvalidConfigurationFileException - If the configuration file contents are not in appropriate format

loadPomFromClassLoaderResource

public PomEquippedMavenImporter loadPomFromClassLoaderResource(String pathToPomResource,
                                                               ClassLoader cl)
                                                        throws IllegalArgumentException,
                                                               InvalidConfigurationFileException

Description copied from interface: PomlessMavenImporter

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.

Specified by:

loadPomFromClassLoaderResource in interface PomlessMavenImporter

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

InvalidConfigurationFileException - If the configuration file contents are not in appropriate format

loadPomFromClassLoaderResource

public PomEquippedMavenImporter loadPomFromClassLoaderResource(String pathToPomResource,
                                                               ClassLoader cl,
                                                               String... profiles)
                                                        throws IllegalArgumentException,
                                                               InvalidConfigurationFileException

Description copied from interface: PomlessMavenImporter

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.

Specified by:

loadPomFromClassLoaderResource in interface PomlessMavenImporter

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

InvalidConfigurationFileException - If the configuration file contents are not in appropriate format

offline

public PomlessMavenImporter offline(boolean offline)

Description copied from interface: PomlessMavenImporter

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

Specified by:

offline in interface PomlessMavenImporter

Parameters:

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

Returns:

Modified PomlessMavenImporter instance

offline

public PomlessMavenImporter offline()

Description copied from interface: PomlessMavenImporter

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

Specified by:

offline in interface PomlessMavenImporter

Returns:

Modified PomlessMavenImporter instance