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

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) Log that the builder image has been pulled.
void	pulledRunImage(BuildRequest request, Image image) Log that a run image has been pulled.
Consumer<TotalProgressEvent>	pullingBuilder(BuildRequest request, ImageReference imageReference) Log that the builder image is being pulled.
Consumer<TotalProgressEvent>	pullingRunImage(BuildRequest request, ImageReference imageReference) Log that a run image is being pulled.
Consumer<LogUpdateEvent>	runningPhase(BuildRequest request, String name) Log that a specific phase is running.
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

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

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

public void pulledBuilder(BuildRequest request,
                          Image image)

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

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

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

public void pulledRunImage(BuildRequest request,
                           Image image)

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

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

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)