org.jboss.shrinkwrap.resolver.impl.maven
Class MavenDependencyShortcutImpl

java.lang.Object
  org.jboss.shrinkwrap.resolver.impl.maven.MavenDependencyShortcutImpl

All Implemented Interfaces:

EffectivePomMavenDependencyShortcut, MavenDependencyShortcut, ResolverEntryPoint<MavenDependencyShortcut>

public class MavenDependencyShortcutImpl
extends Object
implements MavenDependencyShortcut

Shortcut API implementation for Maven artifact builder which holds and construct dependencies and is able to resolve them into ShrinkWrap archives.

Author:

Samuel Santos

Constructor Summary

MavenDependencyShortcutImpl()

Method Summary

Collection<org.jboss.shrinkwrap.api.GenericArchive>	dependencies(String... coordinates) Resolves dependencies for dependency builder.
org.jboss.shrinkwrap.api.GenericArchive	dependency(String coordinates) Resolves dependency for dependency builder.
File	resolveAsFile(String coordinates) Resolves dependency for dependency builder.
File[]	resolveAsFiles(String... coordinates) Resolves dependencies for dependency builder.
EffectivePomMavenDependencyShortcut	withPom(String path) Loads remote repositories for a POM file.

Methods inherited from class java.lang.Object

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

Constructor Detail

MavenDependencyShortcutImpl

public MavenDependencyShortcutImpl()

Method Detail

dependency

public org.jboss.shrinkwrap.api.GenericArchive dependency(String coordinates)
                                                   throws ResolutionException

Resolves dependency for dependency builder.

Specified by:

dependency in interface EffectivePomMavenDependencyShortcut

Parameters:

coordinates - Coordinates specified to a created artifact, specified in an implementation-specific format.

Returns:

An archive of the resolved artifact.

Throws:

ResolutionException - If artifact coordinates are wrong or if version cannot be determined.

{@link - IllegalArgumentException} If target archive view is not supplied

dependencies

public Collection<org.jboss.shrinkwrap.api.GenericArchive> dependencies(String... coordinates)
                                                                 throws ResolutionException

Resolves dependencies for dependency builder.

Specified by:

dependencies in interface EffectivePomMavenDependencyShortcut

Parameters:

coordinates - A list of coordinates specified to the created artifacts, specified in an implementation-specific format.

Returns:

An array of archives which contains resolved artifacts.

Throws:

ResolutionException - If artifact coordinates are wrong or if version cannot be determined.

{@link - IllegalArgumentException} If target archive view is not supplied

resolveAsFile

public File resolveAsFile(String coordinates)
                   throws ResolutionException

Resolves dependency for dependency builder.

Specified by:

resolveAsFile in interface EffectivePomMavenDependencyShortcut

Parameters:

coordinates - Coordinates specified to a created artifact, specified in an implementation-specific format.

Returns:

A File which contain resolved artifact.

Throws:

ResolutionException - If artifact could not be resolved

resolveAsFiles

public File[] resolveAsFiles(String... coordinates)
                      throws ResolutionException

Resolves dependencies for dependency builder.

Specified by:

resolveAsFiles in interface EffectivePomMavenDependencyShortcut

Parameters:

coordinates - A list of coordinates specified to the created artifacts, specified in an implementation-specific format.

Returns:

An array of Files which contains resolved artifacts

Throws:

ResolutionException - If artifact could not be resolved

withPom

public EffectivePomMavenDependencyShortcut withPom(String path)
                                            throws ResolutionException

Loads remote repositories for a POM file. If repositories are defined in the parent of the POM file and there are accessible via local file system, they are set as well. These remote repositories are used to resolve the artifacts during dependency resolution. Additionally, it loads dependencies defined in the POM file model in an internal cache, which can be later used to resolve an artifact without explicitly specifying its version.

Specified by:

withPom in interface MavenDependencyShortcut

Parameters:

path - A path to the POM file, must not be null or empty

Returns:

A dependency builder with remote repositories set according to the content of POM file.

Throws:

ResolutionException - If artifact coordinates are wrong or if version cannot be determined.