com.atlassian.bamboo.build.creation

Interface JobCreationService

All Superinterfaces:

PlanCreationService

All Known Implementing Classes:

JobCreationServiceImpl

public interface JobCreationService
extends PlanCreationService

Nested Class Summary

Nested classes/interfaces inherited from interface com.atlassian.bamboo.build.creation.PlanCreationService

PlanCreationService.EnablePlan

Field Summary

Fields

Modifier and Type	Field and Description
static String	BUILD_DESCRIPTION Deprecated. since 5.7 (Use JobCreationConstants instead).
static String	BUILD_KEY Deprecated. since 5.7 (Use JobCreationConstants instead).
static String	BUILD_NAME Deprecated. since 5.7 (Use JobCreationConstants instead).
static String	CHAIN Deprecated. since 5.7 (Use JobCreationConstants instead).
static String	CLONE_JOB Deprecated. since 5.7 (Use JobCreationConstants instead).
static String	EXISTING_STAGE Deprecated. since 5.7 (Use JobCreationConstants instead).
static String	JOB_KEY_TO_CLONE Deprecated. since 5.7 (Use JobCreationConstants instead).
static String	MASTER_JOB Deprecated. since 5.7 (Use JobCreationConstants instead).
static String	NEW_STAGE_MARKER Deprecated. since 5.7 (Use JobCreationConstants instead).
static String	STAGE_DESCRIPTION Deprecated. since 5.7 (Use JobCreationConstants instead).
static String	STAGE_MANUAL Deprecated. since 5.7 (Use JobCreationConstants instead).
static String	STAGE_NAME Deprecated. since 5.7 (Use JobCreationConstants instead).
static String	SUB_BUILD_KEY Deprecated. since 5.7 (Use JobCreationConstants instead).

Fields inherited from interface com.atlassian.bamboo.build.creation.PlanCreationService

EXISTING_PROJECT_KEY, NEW_PROJECT_MARKER, PROJECT_KEY, PROJECT_NAME

Method Summary

Modifier and Type	Method and Description
List<PlanKey>	createJobAndBranches(BuildConfiguration buildConfiguration, ActionParametersMap actionParametersMap, PlanCreationService.EnablePlan ifPlanEnabled)
String	createPlan(BuildConfiguration buildConfiguration, ActionParametersMap actionParametersMap, PlanCreationService.EnablePlan enabled) Deprecated. since 4.0 use @{link #createJobAndBranches}
String	createSingleJob(BuildConfiguration buildConfiguration, ActionParametersMap clonedActionParametersMap, PlanCreationService.EnablePlan planEnabled)
Job	getNewInstance()

Methods inherited from interface com.atlassian.bamboo.build.creation.PlanCreationService

getBuildConfigurationWithDefaults, savePlan, triggerCreationCompleteEvents, validatePlan, validatePlan

Field Detail

CHAIN

@Deprecated
static final String CHAIN

Deprecated. since 5.7 (Use JobCreationConstants instead).

See Also:

Constant Field Values

MASTER_JOB

@Deprecated
static final String MASTER_JOB

Deprecated. since 5.7 (Use JobCreationConstants instead).

See Also:

Constant Field Values

NEW_STAGE_MARKER

@Deprecated
static final String NEW_STAGE_MARKER

Deprecated. since 5.7 (Use JobCreationConstants instead).

See Also:

Constant Field Values

STAGE_NAME

@Deprecated
static final String STAGE_NAME

Deprecated. since 5.7 (Use JobCreationConstants instead).

See Also:

Constant Field Values

STAGE_DESCRIPTION

@Deprecated
static final String STAGE_DESCRIPTION

Deprecated. since 5.7 (Use JobCreationConstants instead).

See Also:

Constant Field Values

STAGE_MANUAL

@Deprecated
static final String STAGE_MANUAL

Deprecated. since 5.7 (Use JobCreationConstants instead).

See Also:

Constant Field Values

EXISTING_STAGE

@Deprecated
static final String EXISTING_STAGE

Deprecated. since 5.7 (Use JobCreationConstants instead).

See Also:

Constant Field Values

BUILD_KEY

@Deprecated
static final String BUILD_KEY

Deprecated. since 5.7 (Use JobCreationConstants instead).

See Also:

Constant Field Values

SUB_BUILD_KEY

@Deprecated
static final String SUB_BUILD_KEY

Deprecated. since 5.7 (Use JobCreationConstants instead).

See Also:

Constant Field Values

BUILD_NAME

@Deprecated
static final String BUILD_NAME

Deprecated. since 5.7 (Use JobCreationConstants instead).

See Also:

Constant Field Values

BUILD_DESCRIPTION

@Deprecated
static final String BUILD_DESCRIPTION

Deprecated. since 5.7 (Use JobCreationConstants instead).

See Also:

Constant Field Values

CLONE_JOB

@Deprecated
static final String CLONE_JOB

Deprecated. since 5.7 (Use JobCreationConstants instead).

See Also:

Constant Field Values

JOB_KEY_TO_CLONE

@Deprecated
static final String JOB_KEY_TO_CLONE

Deprecated. since 5.7 (Use JobCreationConstants instead).

See Also:

Constant Field Values

Method Detail

getNewInstance

Job getNewInstance()

Specified by:

getNewInstance in interface PlanCreationService

Returns:

A new plan instance, concrete type determined by implementation classes

createSingleJob

String createSingleJob(BuildConfiguration buildConfiguration,
                       ActionParametersMap clonedActionParametersMap,
                       PlanCreationService.EnablePlan planEnabled)
                throws PlanCreationDeniedException,
                       PlanCreationException

Throws:

PlanCreationDeniedException

PlanCreationException

createPlan

@Deprecated
String createPlan(@NotNull
                              BuildConfiguration buildConfiguration,
                              @NotNull
                              ActionParametersMap actionParametersMap,
                              @NotNull
                              PlanCreationService.EnablePlan enabled)
                       throws PlanCreationDeniedException,
                              PlanCreationException

Deprecated. since 4.0 use @{link #createJobAndBranches}

This method will also create the job branches

Specified by:

createPlan in interface PlanCreationService

Parameters:

buildConfiguration - of the plan to create

actionParametersMap - containing any other required params NOT in the buildConfiguration

enabled - whether the plan should start enabled or disabled

Returns:

the full key of the created plan

Throws:

PlanCreationDeniedException - if plan creation fails because you already have too many plans.

PlanCreationException - if plan creation fails for any other reason

createJobAndBranches

List<PlanKey> createJobAndBranches(@NotNull
                                   BuildConfiguration buildConfiguration,
                                   @NotNull
                                   ActionParametersMap actionParametersMap,
                                   @NotNull
                                   PlanCreationService.EnablePlan ifPlanEnabled)
                            throws PlanCreationDeniedException,
                                   PlanCreationException

Throws:

PlanCreationDeniedException

PlanCreationException