org.microbean.helm.chart.repository

Class ChartRepositoryRepository

java.lang.Object

org.microbean.helm.chart.resolver.AbstractChartResolver

org.microbean.helm.chart.repository.ChartRepositoryRepository

@Experimental
public class ChartRepositoryRepository
extends AbstractChartResolver

A repository of ChartRepository instances, normally built from a Helm repositories.yaml file.

Author:

Laird Nelson

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ChartRepositoryRepository.ChartRepositoryFactory A factory for ChartRepository instances.

Constructor Summary

Constructors

Constructor and Description
ChartRepositoryRepository(Set<? extends ChartRepository> chartRepositories) Creates a new ChartRepositoryRepository.

Method Summary

Modifier and Type	Method and Description
static ChartRepositoryRepository	fromHelmRepositoriesYaml() Creates and returns a new ChartRepositoryRepository from the contents of a repositories.yaml file typically located in the ~/.helm/repository directory.
static ChartRepositoryRepository	fromHelmRepositoriesYaml(boolean reifyHelmHomeIfNecessary) Creates and returns a new ChartRepositoryRepository from the contents of a repositories.yaml file typically located in the ~/.helm/repository directory.
static ChartRepositoryRepository	fromYaml(InputStream stream) Creates and returns a new ChartRepositoryRepository from the contents of a repositories.yaml file represented by the supplied InputStream.
static ChartRepositoryRepository	fromYaml(InputStream stream, boolean reifyHelmHomeIfNecessary) Creates and returns a new ChartRepositoryRepository from the contents of a repositories.yaml file represented by the supplied InputStream.
static ChartRepositoryRepository	fromYaml(InputStream stream, Path archiveCacheDirectory, Path indexCacheDirectory) Creates and returns a new ChartRepositoryRepository from the contents of a repositories.yaml file represented by the supplied InputStream.
static ChartRepositoryRepository	fromYaml(InputStream stream, Path archiveCacheDirectory, Path indexCacheDirectory, boolean reifyHelmHomeIfNecessary) Creates and returns a new ChartRepositoryRepository from the contents of a repositories.yaml file represented by the supplied InputStream.
static ChartRepositoryRepository	fromYaml(InputStream stream, Path archiveCacheDirectory, Path indexCacheDirectory, boolean reifyHelmHomeIfNecessary, ChartRepositoryRepository.ChartRepositoryFactory factory) Creates and returns a new ChartRepositoryRepository from the contents of a repositories.yaml file represented by the supplied InputStream.
static ChartRepositoryRepository	fromYaml(InputStream stream, Path archiveCacheDirectory, Path indexCacheDirectory, ChartRepositoryRepository.ChartRepositoryFactory factory) Creates and returns a new ChartRepositoryRepository from the contents of a repositories.yaml file represented by the supplied InputStream.
Set<ChartRepository>	getChartRepositories() Returns the non-null immutable Set of ChartRepository instances managed by this ChartRepositoryRepository.
ChartRepository	getChartRepository(String name) Returns the ChartRepository managed by this ChartRepositoryRepository with the supplied name, or null if there is no such ChartRepository.
ChartOuterClass.Chart.Builder	resolve(String chartName, String chartVersion) Uses the supplied chartName and chartVersion parameters to find an appropriate Helm chart and returns it in the form of a Chart.Builder object.
ChartOuterClass.Chart.Builder	resolve(String repositoryName, String chartName, String chartVersion) Uses the supplied repositoryName, chartName and chartVersion parameters to find an appropriate Helm chart and returns it in the form of a Chart.Builder object.

Methods inherited from class java.lang.Object

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

Constructor Detail

ChartRepositoryRepository

public ChartRepositoryRepository(Set<? extends ChartRepository> chartRepositories)

Creates a new ChartRepositoryRepository.

Parameters:

chartRepositories - the Set of ChartRepository instances to be managed by this ChartRepositoryRepository; may be null; copied by value

See Also:

getChartRepositories()

Method Detail

getChartRepositories

public final Set<ChartRepository> getChartRepositories()

Returns the non-null immutable Set of ChartRepository instances managed by this ChartRepositoryRepository.

Returns:

the non-null immutable Set of ChartRepository instances managed by this ChartRepositoryRepository

getChartRepository

public ChartRepository getChartRepository(String name)

Returns the ChartRepository managed by this ChartRepositoryRepository with the supplied name, or null if there is no such ChartRepository.

Parameters:

name - the name of the ChartRepository to return; must not be null

Returns:

the ChartRepository managed by this ChartRepositoryRepository with the supplied name, or null

Throws:

NullPointerException - if name is null

resolve

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

Uses the supplied chartName and chartVersion parameters to find an appropriate Helm chart and returns it in the form of a Chart.Builder object.

Implementations of this method may return null.

This implementation splits the supplied slash-delimited chartName into a chart repository name and a chart name, uses the chart repository name to locate a suitable ChartRepository, and then calls ChartRepository.resolve(String, String) with the chart name and the supplied chartVersion, and returns the result.

Specified by:

resolve in class AbstractChartResolver

Parameters:

chartName - a slash-separated String whose first component is a chart repository name and whose second component is a Helm chart name; must not be null

chartVersion - the version of the chart to resolve; may be null in which case "latest" semantics are implied

Returns:

a Chart.Builder, or null

Throws:

ChartResolverException - if there was a problem with resolution

See Also:

resolve(String, String, String)

resolve

public ChartOuterClass.Chart.Builder resolve(String repositoryName,
                                             String chartName,
                                             String chartVersion)
                                      throws ChartResolverException

Uses the supplied repositoryName, chartName and chartVersion parameters to find an appropriate Helm chart and returns it in the form of a Chart.Builder object.

This implementation uses the supplied repositoryName to locate a suitable ChartRepository, and then calls ChartRepository.resolve(String, String) with the chart name and the supplied chartVersion, and returns the result.

Parameters:

repositoryName - a chart repository name; must not be null

chartName - a Helm chart name; must not be null

chartVersion - the version of the Helm chart to select; may be null in which case "latest" semantics are implied

Returns:

a Chart.Builder, or null

Throws:

ChartResolverException - if there was a problem with resolution

NullPointerException - if repositoryName or chartName is null

See Also:

getChartRepository(String), ChartRepository.getName(), ChartRepository.resolve(String, String)

fromHelmRepositoriesYaml

public static final ChartRepositoryRepository fromHelmRepositoriesYaml()
                                                                throws IOException,
                                                                       URISyntaxException

Creates and returns a new ChartRepositoryRepository from the contents of a repositories.yaml file typically located in the ~/.helm/repository directory.

This method never returns null.

Returns:

a new ChartRepositoryRepository; never null

Throws:

IOException - if there was a problem reading the file

URISyntaxException - if there was an invalid URI in the file

See Also:

fromHelmRepositoriesYaml(boolean)

fromHelmRepositoriesYaml

public static final ChartRepositoryRepository fromHelmRepositoriesYaml(boolean reifyHelmHomeIfNecessary)
                                                                throws IOException,
                                                                       URISyntaxException

Creates and returns a new ChartRepositoryRepository from the contents of a repositories.yaml file typically located in the ~/.helm/repository directory.

This method never returns null.

Parameters:

reifyHelmHomeIfNecessary - if true and, for whatever reason, the local Helm home directory structure needs to be partially or entirely created, then this method will attempt to reify it

Returns:

a new ChartRepositoryRepository; never null

Throws:

IOException - if there was a problem reading the file or reifying the local Helm home directory structure

URISyntaxException - if there was an invalid URI in the file

See Also:

fromYaml(InputStream, Path, Path, boolean, ChartRepositoryFactory)

fromYaml

public static final ChartRepositoryRepository fromYaml(InputStream stream)
                                                throws IOException,
                                                       URISyntaxException

Creates and returns a new ChartRepositoryRepository from the contents of a repositories.yaml file represented by the supplied InputStream.

Parameters:

stream - the InputStream to read from; must not be null

Returns:

a new ChartRepositoryRepository; never null

Throws:

IOException - if there was a problem reading the file

URISyntaxException - if there was an invalid URI in the file

See Also:

fromYaml(InputStream, Path, Path, boolean, ChartRepositoryFactory)

fromYaml

public static final ChartRepositoryRepository fromYaml(InputStream stream,
                                                       boolean reifyHelmHomeIfNecessary)
                                                throws IOException,
                                                       URISyntaxException

Creates and returns a new ChartRepositoryRepository from the contents of a repositories.yaml file represented by the supplied InputStream.

Parameters:

stream - the InputStream to read from; must not be null

reifyHelmHomeIfNecessary - if true and, for whatever reason, the local Helm home directory structure needs to be partially or entirely created, then this method will attempt to reify it

Returns:

a new ChartRepositoryRepository; never null

Throws:

IOException - if there was a problem reading the file or reifying the local Helm home directory structure

URISyntaxException - if there was an invalid URI in the file

See Also:

fromYaml(InputStream, Path, Path, boolean, ChartRepositoryFactory)

fromYaml

public static final ChartRepositoryRepository fromYaml(InputStream stream,
                                                       Path archiveCacheDirectory,
                                                       Path indexCacheDirectory)
                                                throws IOException,
                                                       URISyntaxException

Creates and returns a new ChartRepositoryRepository from the contents of a repositories.yaml file represented by the supplied InputStream.

Parameters:

stream - the InputStream to read from; must not be null

archiveCacheDirectory - an absolute Path representing a directory where Helm chart archives may be stored; if null then a Path beginning with the absolute directory represented by the value of the helm.home system property, or the value of the HELM_HOME environment variable, appended with cache/archive will be used instead

indexCacheDirectory - an absolute Path representing a directory that the supplied cachedIndexPath parameter value will be considered to be relative to; will be ignored and hence may be null if the supplied cachedIndexPath parameter value Path.isAbsolute()

Returns:

a new ChartRepositoryRepository; never null

Throws:

IOException - if there was a problem reading the file

URISyntaxException - if there was an invalid URI in the file

See Also:

fromYaml(InputStream, Path, Path, boolean, ChartRepositoryFactory)

fromYaml

public static final ChartRepositoryRepository fromYaml(InputStream stream,
                                                       Path archiveCacheDirectory,
                                                       Path indexCacheDirectory,
                                                       boolean reifyHelmHomeIfNecessary)
                                                throws IOException,
                                                       URISyntaxException

Creates and returns a new ChartRepositoryRepository from the contents of a repositories.yaml file represented by the supplied InputStream.

Parameters:

stream - the InputStream to read from; must not be null

archiveCacheDirectory - an absolute Path representing a directory where Helm chart archives may be stored; if null then a Path beginning with the absolute directory represented by the value of the helm.home system property, or the value of the HELM_HOME environment variable, appended with cache/archive will be used instead

indexCacheDirectory - an absolute Path representing a directory that the supplied cachedIndexPath parameter value will be considered to be relative to; will be ignored and hence may be null if the supplied cachedIndexPath parameter value Path.isAbsolute()

reifyHelmHomeIfNecessary - if true and, for whatever reason, the local Helm home directory structure needs to be partially or entirely created, then this method will attempt to reify it

Returns:

a new ChartRepositoryRepository; never null

Throws:

IOException - if there was a problem reading the file or reifying the local Helm home directory structure

URISyntaxException - if there was an invalid URI in the file

See Also:

fromYaml(InputStream, Path, Path, boolean, ChartRepositoryFactory)

fromYaml

public static final ChartRepositoryRepository fromYaml(InputStream stream,
                                                       Path archiveCacheDirectory,
                                                       Path indexCacheDirectory,
                                                       ChartRepositoryRepository.ChartRepositoryFactory factory)
                                                throws IOException,
                                                       URISyntaxException

Creates and returns a new ChartRepositoryRepository from the contents of a repositories.yaml file represented by the supplied InputStream.

Parameters:

stream - the InputStream to read from; must not be null

archiveCacheDirectory - an absolute Path representing a directory where Helm chart archives may be stored; if null then a Path beginning with the absolute directory represented by the value of the helm.home system property, or the value of the HELM_HOME environment variable, appended with cache/archive will be used instead

indexCacheDirectory - an absolute Path representing a directory that the supplied cachedIndexPath parameter value will be considered to be relative to; will be ignored and hence may be null if the supplied cachedIndexPath parameter value Path.isAbsolute()

factory - a ChartRepositoryRepository.ChartRepositoryFactory that can create ChartRepository instances; may be null in which case the ChartRepository.ChartRepository(String, URI, Path, Path, Path) constructor will be used instead

Returns:

a new ChartRepositoryRepository; never null

Throws:

IOException - if there was a problem reading the file

URISyntaxException - if there was an invalid URI in the file

See Also:

fromYaml(InputStream, Path, Path, boolean, ChartRepositoryFactory)

fromYaml

public static final ChartRepositoryRepository fromYaml(InputStream stream,
                                                       Path archiveCacheDirectory,
                                                       Path indexCacheDirectory,
                                                       boolean reifyHelmHomeIfNecessary,
                                                       ChartRepositoryRepository.ChartRepositoryFactory factory)
                                                throws IOException,
                                                       URISyntaxException

Creates and returns a new ChartRepositoryRepository from the contents of a repositories.yaml file represented by the supplied InputStream.

Parameters:

stream - the InputStream to read from; must not be null

archiveCacheDirectory - an absolute Path representing a directory where Helm chart archives may be stored; if null then a Path beginning with the absolute directory represented by the value of the helm.home system property, or the value of the HELM_HOME environment variable, appended with cache/archive will be used instead

indexCacheDirectory - an absolute Path representing a directory that the supplied cachedIndexPath parameter value will be considered to be relative to; will be ignored and hence may be null if the supplied cachedIndexPath parameter value Path.isAbsolute()

reifyHelmHomeIfNecessary - if true and, for whatever reason, the local Helm home directory structure needs to be partially or entirely created, then this method will attempt to reify it

factory - a ChartRepositoryRepository.ChartRepositoryFactory that can create ChartRepository instances; may be null in which case the ChartRepository.ChartRepository(String, URI, Path, Path, Path) constructor will be used instead

Returns:

a new ChartRepositoryRepository; never null

Throws:

IOException - if there was a problem reading the file or reifying the local Helm home directory structure

URISyntaxException - if there was an invalid URI in the file