com.google.cloud.tools.jib.frontend

Class JavaLayerConfigurations.Builder

java.lang.Object

com.google.cloud.tools.jib.frontend.JavaLayerConfigurations.Builder

Enclosing class:

JavaLayerConfigurations

public static class JavaLayerConfigurations.Builder
extends Object

Builds with each layer's files.

Method Summary

Modifier and Type	Method and Description
JavaLayerConfigurations.Builder	addDirectoryContents(JavaLayerConfigurations.LayerType layerType, Path sourceRoot, Predicate<Path> pathFilter, AbsoluteUnixPath basePathInContainer) Adds directory contents to a layer selectively (via pathFilter) and recursively.
JavaLayerConfigurations.Builder	addDirectoryContents(JavaLayerConfigurations.LayerType layerType, Path sourceRoot, Predicate<Path> pathFilter, AbsoluteUnixPath basePathInContainer, Map<AbsoluteUnixPath,FilePermissions> permissionsMap) Adds directory contents to a layer selectively (via pathFilter) and recursively.
JavaLayerConfigurations.Builder	addFile(JavaLayerConfigurations.LayerType layerType, Path sourceFile, AbsoluteUnixPath pathInContainer) Adds a file to a layer.
JavaLayerConfigurations.Builder	addFile(JavaLayerConfigurations.LayerType layerType, Path sourceFile, AbsoluteUnixPath pathInContainer, FilePermissions permissions) Adds a file to a layer.
JavaLayerConfigurations	build()

Methods inherited from class java.lang.Object

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

Method Detail

addFile

public JavaLayerConfigurations.Builder addFile(JavaLayerConfigurations.LayerType layerType,
                                               Path sourceFile,
                                               AbsoluteUnixPath pathInContainer)

Adds a file to a layer. Only adds the single source file to the exact path in the container file system. (If the source file is a directory, does not copy its contents but creates only the directory.) See LayerConfiguration.Builder#addEntry for concrete examples about how the file will be placed in the image.

Parameters:

layerType - the layer to add files into

sourceFile - the source file to add to the layer

pathInContainer - the path in the container file system corresponding to the sourceFile

Returns:

this

See Also:

LayerConfiguration.Builder#addEntry(Path, AbsoluteUnixPath)

addFile

public JavaLayerConfigurations.Builder addFile(JavaLayerConfigurations.LayerType layerType,
                                               Path sourceFile,
                                               AbsoluteUnixPath pathInContainer,
                                               @Nullable
                                               FilePermissions permissions)

Adds a file to a layer. Only adds the single source file to the exact path in the container file system. (If the source file is a directory, does not copy its contents but creates only the directory.) See LayerConfiguration.Builder#addEntry for concrete examples about how the file will be placed in the image.

Parameters:

layerType - the layer to add files into

sourceFile - the source file to add to the layer

pathInContainer - the path in the container file system corresponding to the sourceFile

permissions - the file permissions on the container. Use null for defaults (644 for files, 755 for directories)

Returns:

this

See Also:

LayerConfiguration.Builder#addEntry(Path, AbsoluteUnixPath, FilePermissions)

addDirectoryContents

public JavaLayerConfigurations.Builder addDirectoryContents(JavaLayerConfigurations.LayerType layerType,
                                                            Path sourceRoot,
                                                            Predicate<Path> pathFilter,
                                                            AbsoluteUnixPath basePathInContainer)
                                                     throws IOException

Adds directory contents to a layer selectively (via pathFilter) and recursively. sourceRoot must be a directory. Empty directories will always be added regardless of pathFilter, except that sourceRoot is never added.

The contents of sourceRoot will be placed into basePathInContainer. For example, if sourceRoot is /usr/home, /usr/home/passwd exists locally, and basePathInContainer is /etc, then the image will have /etc/passwd.

Parameters:

layerType - the layer to add files into

sourceRoot - root directory whose contents will be added

pathFilter - filter that determines which files (not directories) should be added

basePathInContainer - directory in the layer into which the source contents are added

Returns:

this

Throws:

IOException - error while listing directories

NotDirectoryException - if sourceRoot is not a directory

addDirectoryContents

public JavaLayerConfigurations.Builder addDirectoryContents(JavaLayerConfigurations.LayerType layerType,
                                                            Path sourceRoot,
                                                            Predicate<Path> pathFilter,
                                                            AbsoluteUnixPath basePathInContainer,
                                                            Map<AbsoluteUnixPath,FilePermissions> permissionsMap)
                                                     throws IOException

Adds directory contents to a layer selectively (via pathFilter) and recursively. sourceRoot must be a directory. Empty directories will always be added regardless of pathFilter, except that sourceRoot is never added. Permissions are specified via permissionsMap, which maps from extraction path on the container to file permissions.

Parameters:

layerType - the layer to add files into

sourceRoot - root directory whose contents will be added

pathFilter - filter that determines which files (not directories) should be added

basePathInContainer - directory in the layer into which the source contents are added

permissionsMap - the map from absolute path on container to file permission

Returns:

this

Throws:

IOException - error while listing directories

NotDirectoryException - if sourceRoot is not a directory

build

public JavaLayerConfigurations build()