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

static java.lang.String	BUILD_DESCRIPTION
static java.lang.String	BUILD_KEY
static java.lang.String	BUILD_NAME
static java.lang.String	CHAIN
static java.lang.String	CLONE_JOB
static java.lang.String	EXISTING_STAGE
static java.lang.String	JOB_KEY_TO_CLONE
static java.lang.String	MASTER_JOB
static java.lang.String	MASTER_JOB_KEY Deprecated.
static java.lang.String	NEW_STAGE_MARKER
static java.lang.String	STAGE_DESCRIPTION
static java.lang.String	STAGE_MANUAL
static java.lang.String	STAGE_NAME
static java.lang.String	SUB_BUILD_KEY

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

EXISTING_PROJECT_KEY, NEW_PROJECT_MARKER, PROJECT_KEY, PROJECT_NAME

Method Summary

java.util.List<PlanKey>	createJobAndBranches(BuildConfiguration buildConfiguration, ActionParametersMap actionParametersMap, PlanCreationService.EnablePlan ifPlanEnabled)
java.lang.String	createPlan(BuildConfiguration buildConfiguration, ActionParametersMap actionParametersMap, PlanCreationService.EnablePlan enabled) Deprecated. since 4.0 use @{link #createJobAndBranches}
java.lang.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

Field Detail

CHAIN

static final java.lang.String CHAIN

See Also:

Constant Field Values

MASTER_JOB

static final java.lang.String MASTER_JOB

See Also:

Constant Field Values

NEW_STAGE_MARKER

static final java.lang.String NEW_STAGE_MARKER

See Also:

Constant Field Values

STAGE_NAME

static final java.lang.String STAGE_NAME

See Also:

Constant Field Values

STAGE_DESCRIPTION

static final java.lang.String STAGE_DESCRIPTION

See Also:

Constant Field Values

STAGE_MANUAL

static final java.lang.String STAGE_MANUAL

See Also:

Constant Field Values

EXISTING_STAGE

static final java.lang.String EXISTING_STAGE

See Also:

Constant Field Values

BUILD_KEY

static final java.lang.String BUILD_KEY

See Also:

Constant Field Values

MASTER_JOB_KEY

@Deprecated
static final java.lang.String MASTER_JOB_KEY

Deprecated.

See Also:

Constant Field Values

SUB_BUILD_KEY

static final java.lang.String SUB_BUILD_KEY

See Also:

Constant Field Values

BUILD_NAME

static final java.lang.String BUILD_NAME

See Also:

Constant Field Values

BUILD_DESCRIPTION

static final java.lang.String BUILD_DESCRIPTION

See Also:

Constant Field Values

CLONE_JOB

static final java.lang.String CLONE_JOB

See Also:

Constant Field Values

JOB_KEY_TO_CLONE

static final java.lang.String JOB_KEY_TO_CLONE

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

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

Throws:

PlanCreationDeniedException

PlanCreationException

createPlan

@Deprecated
java.lang.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

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

Throws:

PlanCreationDeniedException

PlanCreationException