Package com.atlassian.bamboo.task
Interface RuntimeTaskDataProvider
-
- All Known Implementing Classes:
ArtifactDownloaderRuntimeDataProvider
,CommandTaskRuntimeDataProvider
@PublicApi @ExperimentalApi public interface RuntimeTaskDataProvider
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods Modifier and Type Method Description default @NotNull Map<String,WhitelistedSerializable>
createRuntimeTaskData(@NotNull RuntimeTaskDefinition taskDefinition, @NotNull CommonContext commonContext)
Server side pre-build action that may be implemented by task.@NotNull Map<String,String>
populateRuntimeTaskData(@NotNull TaskDefinition taskDefinition, @NotNull CommonContext commonContext)
Server side pre-build action that may be implemented by task.void
processRuntimeTaskData(@NotNull RuntimeTaskDefinition taskDefinition, @NotNull CommonContext commonContext)
Server side post-build action that may be implemented by task.default void
processRuntimeTaskData(@NotNull TaskDefinition taskDefinition, @NotNull CommonContext commonContext)
Deprecated.
-
-
-
Method Detail
-
populateRuntimeTaskData
@NotNull @NotNull Map<String,String> populateRuntimeTaskData(@NotNull @NotNull TaskDefinition taskDefinition, @NotNull @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 inTaskContext.getRuntimeTaskContext()
- Parameters:
commonContext
-- Returns:
- custom data for agent side task execution
-
createRuntimeTaskData
@NotNull default @NotNull Map<String,WhitelistedSerializable> createRuntimeTaskData(@NotNull @NotNull RuntimeTaskDefinition taskDefinition, @NotNull @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 inCommonTaskContext.getRuntimeTaskData()
It's guaranteed that this method is called afterpopulateRuntimeTaskData(TaskDefinition, CommonContext)
, and that callingRuntimeTaskDefinition.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 @NotNull TaskDefinition taskDefinition, @NotNull @NotNull CommonContext commonContext)
Deprecated.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 @NotNull RuntimeTaskDefinition taskDefinition, @NotNull @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 inRuntimeTaskDefinition.getRuntimeContext()
and/orRuntimeTaskDefinition.getRuntimeData()
- Parameters:
taskDefinition
-commonContext
-
-
-