org.springframework.boot.buildpack.platform.build

Class AbstractBuildLog

java.lang.Object

org.springframework.boot.buildpack.platform.build.AbstractBuildLog

All Implemented Interfaces:

BuildLog

public abstract class AbstractBuildLog
extends Object
implements BuildLog

Base class for BuildLog implementations.

Since:

2.3.0

Author:

Phillip Webb, Scott Frederick, Andrey Shlykov

Constructor Summary

Constructors

Constructor and Description
AbstractBuildLog()

Method Summary

Modifier and Type	Method and Description
void	executedLifecycle(BuildRequest request) Log that the lifecycle has executed.
void	executingLifecycle(BuildRequest request, org.springframework.boot.buildpack.platform.build.LifecycleVersion version, VolumeName buildCacheVolume) Log that the lifecycle is executing.
protected abstract Consumer<TotalProgressEvent>	getProgressConsumer(String message)
protected void	log()
protected abstract void	log(String message)
void	pulledBuilder(BuildRequest request, Image image) Deprecated.
void	pulledImage(Image image, org.springframework.boot.buildpack.platform.build.ImageType imageType) Log that an image has been pulled.
void	pulledRunImage(BuildRequest request, Image image) Deprecated.
Consumer<TotalProgressEvent>	pullingBuilder(BuildRequest request, ImageReference imageReference) Deprecated.
Consumer<TotalProgressEvent>	pullingImage(ImageReference imageReference, org.springframework.boot.buildpack.platform.build.ImageType imageType) Log that an image is being pulled.
Consumer<TotalProgressEvent>	pullingRunImage(BuildRequest request, ImageReference imageReference) Deprecated.
void	pushedImage(ImageReference imageReference) Log that an image has been pushed.
Consumer<TotalProgressEvent>	pushingImage(ImageReference imageReference) Log that an image is being pushed.
Consumer<LogUpdateEvent>	runningPhase(BuildRequest request, String name) Log that a specific phase is running.
void	skippingPhase(String name, String reason) Log that a specific phase is being skipped.
void	start(BuildRequest request) Log that a build is starting.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.boot.buildpack.platform.build.BuildLog

to, toSystemOut

Constructor Detail

AbstractBuildLog

public AbstractBuildLog()

Method Detail

start

public void start(BuildRequest request)

Description copied from interface: BuildLog

Log that a build is starting.

Specified by:

start in interface BuildLog

Parameters:

request - the build request

pullingBuilder

@Deprecated
public Consumer<TotalProgressEvent> pullingBuilder(BuildRequest request,
                                                               ImageReference imageReference)

Deprecated.

Description copied from interface: BuildLog

Log that the builder image is being pulled.

Specified by:

pullingBuilder in interface BuildLog

Parameters:

request - the build request

imageReference - the builder image reference

Returns:

a consumer for progress update events

pulledBuilder

@Deprecated
public void pulledBuilder(BuildRequest request,
                                      Image image)

Deprecated.

Description copied from interface: BuildLog

Log that the builder image has been pulled.

Specified by:

pulledBuilder in interface BuildLog

Parameters:

request - the build request

image - the builder image that was pulled

pullingRunImage

@Deprecated
public Consumer<TotalProgressEvent> pullingRunImage(BuildRequest request,
                                                                ImageReference imageReference)

Deprecated.

Description copied from interface: BuildLog

Log that a run image is being pulled.

Specified by:

pullingRunImage in interface BuildLog

Parameters:

request - the build request

imageReference - the run image reference

Returns:

a consumer for progress update events

pulledRunImage

@Deprecated
public void pulledRunImage(BuildRequest request,
                                       Image image)

Deprecated.

Description copied from interface: BuildLog

Log that a run image has been pulled.

Specified by:

pulledRunImage in interface BuildLog

Parameters:

request - the build request

image - the run image that was pulled

pullingImage

public Consumer<TotalProgressEvent> pullingImage(ImageReference imageReference,
                                                 org.springframework.boot.buildpack.platform.build.ImageType imageType)

Description copied from interface: BuildLog

Log that an image is being pulled.

Specified by:

pullingImage in interface BuildLog

Parameters:

imageReference - the image reference

imageType - the image type

Returns:

a consumer for progress update events

pulledImage

public void pulledImage(Image image,
                        org.springframework.boot.buildpack.platform.build.ImageType imageType)

Description copied from interface: BuildLog

Log that an image has been pulled.

Specified by:

pulledImage in interface BuildLog

Parameters:

image - the image that was pulled

imageType - the image type that was pulled

pushingImage

public Consumer<TotalProgressEvent> pushingImage(ImageReference imageReference)

Description copied from interface: BuildLog

Log that an image is being pushed.

Specified by:

pushingImage in interface BuildLog

Parameters:

imageReference - the image reference

Returns:

a consumer for progress update events

pushedImage

public void pushedImage(ImageReference imageReference)

Description copied from interface: BuildLog

Log that an image has been pushed.

Specified by:

pushedImage in interface BuildLog

Parameters:

imageReference - the image reference

executingLifecycle

public void executingLifecycle(BuildRequest request,
                               org.springframework.boot.buildpack.platform.build.LifecycleVersion version,
                               VolumeName buildCacheVolume)

Description copied from interface: BuildLog

Log that the lifecycle is executing.

Specified by:

executingLifecycle in interface BuildLog

Parameters:

request - the build request

version - the lifecycle version

buildCacheVolume - the name of the build cache volume in use

runningPhase

public Consumer<LogUpdateEvent> runningPhase(BuildRequest request,
                                             String name)

Description copied from interface: BuildLog

Log that a specific phase is running.

Specified by:

runningPhase in interface BuildLog

Parameters:

request - the build request

name - the name of the phase

Returns:

a consumer for log updates

skippingPhase

public void skippingPhase(String name,
                          String reason)

Description copied from interface: BuildLog

Log that a specific phase is being skipped.

Specified by:

skippingPhase in interface BuildLog

Parameters:

name - the name of the phase

reason - the reason the phase is skipped

executedLifecycle

public void executedLifecycle(BuildRequest request)

Description copied from interface: BuildLog

Log that the lifecycle has executed.

Specified by:

executedLifecycle in interface BuildLog

Parameters:

request - the build request

log

protected void log()

log

protected abstract void log(String message)

getProgressConsumer

protected abstract Consumer<TotalProgressEvent> getProgressConsumer(String message)