com.atlassian.bamboo.task

Interface RuntimeTaskDataProvider

All Known Implementing Classes:

ArtifactDownloaderRuntimeDataProvider, CommandTaskRuntimeDataProvider

@PublicApi
 @ExperimentalApi
public interface RuntimeTaskDataProvider

Method Summary

Modifier and Type	Method and Description
default Map<String,WhitelistedSerializable>	createRuntimeTaskData(RuntimeTaskDefinition taskDefinition, CommonContext commonContext) Server side pre-build action that may be implemented by task.
Map<String,String>	populateRuntimeTaskData(TaskDefinition taskDefinition, CommonContext commonContext) Server side pre-build action that may be implemented by task.
void	processRuntimeTaskData(RuntimeTaskDefinition taskDefinition, CommonContext commonContext) Server side post-build action that may be implemented by task.
default void	processRuntimeTaskData(TaskDefinition taskDefinition, CommonContext commonContext) Deprecated. since 5.9 use processRuntimeTaskData(RuntimeTaskDefinition, CommonContext)

Method Detail

populateRuntimeTaskData

@NotNull
Map<String,String> populateRuntimeTaskData(@NotNull
                                                    TaskDefinition taskDefinition,
                                                    @NotNull
                                                    CommonContext commonContext)

Server side pre-build action that may be implemented by task. Custom data for task execution evaluated on server should be returned for this method and will be accessible for task execution on agent Data are accessible in TaskContext.getRuntimeTaskContext()

Parameters:

commonContext -

Returns:

custom data for agent side task execution

createRuntimeTaskData

@NotNull
default Map<String,WhitelistedSerializable> createRuntimeTaskData(@NotNull
                                                                           RuntimeTaskDefinition taskDefinition,
                                                                           @NotNull
                                                                           CommonContext commonContext)

Server side pre-build action that may be implemented by task. Custom data for task execution evaluated on server should be returned for this method and will be accessible for task execution on agent Data are accessible in CommonTaskContext.getRuntimeTaskData() It's guaranteed that this method is called after populateRuntimeTaskData(TaskDefinition, CommonContext), and that calling RuntimeTaskDefinition.getRuntimeContext() inside implementation will yield previously populated context.

Parameters:

commonContext -

Returns:

custom data for agent side task execution

Since:

5.10

processRuntimeTaskData

@Deprecated
default void processRuntimeTaskData(@NotNull
                                                TaskDefinition taskDefinition,
                                                @NotNull
                                                CommonContext commonContext)

Deprecated. since 5.9 use processRuntimeTaskData(RuntimeTaskDefinition, CommonContext)

Server side post-build action that may be implemented by task. May be used to process custom data returned by task, or to clean up data that may be left by previous call Data are accessible in commonContext.getRuntimeTaskContext().getRuntimeContextForTask( TaskDefinition taskDefinition)

Parameters:

taskDefinition -

commonContext -

processRuntimeTaskData

void processRuntimeTaskData(@NotNull
                            RuntimeTaskDefinition taskDefinition,
                            @NotNull
                            CommonContext commonContext)

Server side post-build action that may be implemented by task. May be used to process custom data returned by task, or to clean up data that may be left by previous call. Data is accessible in RuntimeTaskDefinition.getRuntimeContext() and/or RuntimeTaskDefinition.getRuntimeData()

Parameters:

taskDefinition -

commonContext -