org.microbean.helm.maven

Class MavenRepositoryChartResolver

java.lang.Object

org.microbean.helm.chart.resolver.AbstractChartResolver

org.microbean.helm.maven.MavenRepositoryChartResolver

public class MavenRepositoryChartResolver
extends AbstractChartResolver

An AbstractChartResolver capable of resolving Helm charts from Maven repositories.

Author:

Laird Nelson

See Also:

resolve(String, String)

Constructor Summary

Constructors

Constructor and Description
MavenRepositoryChartResolver(RepositorySystem repositorySystem, RepositorySystemSession session, List<RemoteRepository> remoteRepositories) Creates a new MavenRepositoryChartResolver.

Method Summary

Modifier and Type	Method and Description
List<RemoteRepository>	getRemoteRepositories() Returns the List of RemoteRepository instances from which resolution will be attempted.
RepositorySystem	getRepositorySystem() Returns the RepositorySystem responsible for performing the actual resolution.
RepositorySystemSession	getSession() Returns the RepositorySystemSession governing resolution.
protected ChartOuterClass.Chart.Builder	loadChart(File chartFile, String packaging) Returns a ChartOuterClass.Chart.Builder representing the Helm chart contained by the supplied regular File.
ChartOuterClass.Chart.Builder	resolve(Artifact chart) Creates and returns a ChartOuterClass.Chart.Builder representing a Helm chart resolvable at the Maven repository coordinates represented by the supplied Artifact.
ChartOuterClass.Chart.Builder	resolve(String coordinatesWithoutVersion, String chartVersion) Creates and returns a ChartOuterClass.Chart.Builder representing a Helm chart resolvable at the given Maven repository coordinates.

Methods inherited from class java.lang.Object

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

Constructor Detail

MavenRepositoryChartResolver

public MavenRepositoryChartResolver(RepositorySystem repositorySystem,
                                    RepositorySystemSession session,
                                    List<RemoteRepository> remoteRepositories)

Creates a new MavenRepositoryChartResolver.

Parameters:

repositorySystem - the RepositorySystem responsible for performing the actual resolution; must not be null

repositorySystemSession - the RepositorySystemSession governing artifact resolution; must not be null

remoteRepositories - a List of RemoteRepository instances from which resolution will be attempted; may be null

Throws:

NullPointerException - if repositorySystem or session is null

See Also:

getRepositorySystem(), getSession(), getRemoteRepositories()

Method Detail

getRepositorySystem

public RepositorySystem getRepositorySystem()

Returns the RepositorySystem responsible for performing the actual resolution.

This method never returns null.

Overrides of this method must not return null.

Returns:

the RepositorySystem responsible for performing the actual resolution; never null

See Also:

MavenRepositoryChartResolver(RepositorySystem, RepositorySystemSession, List)

getSession

public RepositorySystemSession getSession()

Returns the RepositorySystemSession governing resolution.

This method never returns null.

Overrides of this method must not return null.

Returns:

the RepositorySystemSession governing resolution; never null

See Also:

MavenRepositoryChartResolver(RepositorySystem, RepositorySystemSession, List)

getRemoteRepositories

public List<RemoteRepository> getRemoteRepositories()

Returns the List of RemoteRepository instances from which resolution will be attempted.

This method may return null.

Overrides of this method are permitted to return null.

Returns:

the List of RemoteRepository instances from which resolution will be attempted, or null

See Also:

MavenRepositoryChartResolver(RepositorySystem, RepositorySystemSession, List)

resolve

public final ChartOuterClass.Chart.Builder resolve(String coordinatesWithoutVersion,
                                                   String chartVersion)
                                            throws ChartResolverException

Creates and returns a ChartOuterClass.Chart.Builder representing a Helm chart resolvable at the given Maven repository coordinates.

Specified by:

resolve in class AbstractChartResolver

Parameters:

coordinatesWithoutVersion - a String of one of the following forms: groupId:artifactId, groupId:artifactId:packaging, or groupId:artifactId:packaging:classifier; must not be null

chartVersion - the version of the Helm chart artifact to resolve; may be null in which case LATEST will be used instead

Returns:

a non-null ChartOuterClass.Chart.Builder

Throws:

NullPointerException - if coordinatesWithoutVersion is null

ChartResolverException - if coordinatesWithoutVersion is malformed, if either the getRepositorySystem() or getSession() method returns null, if an ArtifactResolutionException was encountered during artifact resolution, or if the loadChart(File, String) method throws a ChartResolverException

See Also:

resolve(Artifact), loadChart(File, String)

resolve

public ChartOuterClass.Chart.Builder resolve(Artifact chart)
                                      throws ChartResolverException

Creates and returns a ChartOuterClass.Chart.Builder representing a Helm chart resolvable at the Maven repository coordinates represented by the supplied Artifact.

This method never returns null.

Overrides of this method must not return null.

Parameters:

chart - the Artifact representing the Helm chart to resolve; must not be null

Returns:

a non-null ChartOuterClass.Chart.Builder

Throws:

NullPointerException - if chart is null

ChartResolverException - if either the getRepositorySystem() or getSession() method returns null, if an ArtifactResolutionException was encountered during artifact resolution, or if the loadChart(File, String) method throws a ChartResolverException

See Also:

loadChart(File, String)

loadChart

protected ChartOuterClass.Chart.Builder loadChart(File chartFile,
                                                  String packaging)
                                           throws ChartResolverException

Returns a ChartOuterClass.Chart.Builder representing the Helm chart contained by the supplied regular File.

This method never returns null.

Overrides of this method must not return null.

This implementation will return a ChartOuterClass.Chart.Builder provided that the supplied File is either a GZIP-encoded tape archive or a ZIP archive. Overrides should feel free to expand these capabilities.

Parameters:

chartFile - the File containing a Helm chart; must not be null

packaging - the kind of archive or other packaging mechanism that the supplied chartFile value is; must not be null; examples include tgz, tar.gz, zip and the like; overrides of this method may use this parameter to help in determining how to read the supplied chartFile

Returns:

a non-null ChartOuterClass.Chart.Builder, usually but not necessarily as produced by an AbstractChartLoader implementation

Throws:

NullPointerException - if chartFile or packaging is null

ChartResolverException - if the chart could not be loaded for any reason

See Also:

resolve(String, String)