org.microbean.helm.chart.repository

Interface ChartRepositoryRepository.ChartRepositoryFactory

Enclosing class:

ChartRepositoryRepository

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public static interface ChartRepositoryRepository.ChartRepositoryFactory

A factory for ChartRepository instances.

Author:

Laird Nelson

See Also:

ChartRepository

Method Summary

Modifier and Type	Method and Description
ChartRepository	createChartRepository(String name, URI uri, Path archiveCacheDirectory, Path indexCacheDirectory, Path cachedIndexPath) Creates a new ChartRepository and returns it.

Method Detail

createChartRepository

ChartRepository createChartRepository(String name,
                                      URI uri,
                                      Path archiveCacheDirectory,
                                      Path indexCacheDirectory,
                                      Path cachedIndexPath)

Creates a new ChartRepository and returns it.

Parameters:

name - the name of the chart repository; must not be null

uri - the URI to the root of the chart repository; must not be null

archiveCacheDirectory - an absolute Path representing a directory where Helm chart archives may be stored; if null then often 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 is absolute

cachedIndexPath - a Path naming the file that will store a copy of the chart repository's index.yaml file; if null then a Path relative to the absolute directory represented by the value of the helm.home system property, or the value of the HELM_HOME environment variable, and bearing a name consisting of the supplied name suffixed with -index.yaml will often be used instead

Returns:

a new, non-null ChartRepository

Throws:

NullPointerException - if either name or uri is null

IllegalArgumentException - if uri is not absolute, or if there is no existing "Helm home" directory, or if archiveCacheDirectory is non-null and either empty or not Path.isAbsolute()

See Also:

ChartRepository.ChartRepository(String, URI, Path, Path, Path)