Package com.polarion.alm.builder

Interface IBuilderService

public interface IBuilderService

Builder service.

Author:

Stepan Roh, Polarion Software

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CLEAN_JOB_NAME	Name of job coupled with runCleanJob(String).
static final String	DEFAULT_BUILD_DESCRIPTOR_NAME	default IBuildDescriptor name
static final String	DEFAULT_CALCULATION_DESCRIPTOR_NAME	default ICalculationDescriptor name
static final String	DEFAULT_LOCAL_DEPLOYMENT_SPACE	default local deployment space name
static final String	MASTER_BUILD_JOB_NAME	Name of job coupled with runBuild(IBuildArtifact, String, String, String, String, Properties).

Method Summary

Modifier and Type	Method	Description
boolean	checkIsBuildRunning(IBuild build)	Returns true if the build is still running
IPObjectList<IBuildArtifact>	findBuildArtifacts(IBuildArtifactSelector selector)	Return all build artifacts matching given IBuildArtifactSelector.
void	forceConfigurationReload(IGroupEntity groupEntity)	Forces configuration reload and build artifacts auto-recognition (if configured) for given group entity.
IBuildArtifactEngineerRepository	getBuildArtifactEngineerRepository()	Return associated build artifact engineer repository.
IBuildArtifact	getBuildArtifactForGroupEntity(IGroupEntity groupEntity)	Return build artifact representing given group entity (project or project group).
IBuildArtifactRecognizerRepository	getBuildArtifactRecognizerRepository()	Return associated build artifact recognizer repository.
IPObjectList<IBuildArtifact>	getBuildArtifactsForProject(IProject project)	Return build artifacts for given project.
IBuildExtenderRepository	getBuildExtenderRepository()	Return associated build extender repository.
IBuildInformationRepository	getBuildInformationRepository()	Get build information repository where all builds are stored.
IPObjectList<IBuild>	getBuilds()	Return all available builds (in any state).
IPObjectList<IBuild>	getBuilds(IBuildArtifact artifact)	Return all available builds for given artifact (in any state).
IPObjectList<IBuild>	getBuilds(IProject project)	Return all available builds for given project (in any state).
IBuildsPolicy	getBuildsPolicy()
IJob	getJobForBuild(IBuild build)	Return master job associated with given build.
IReportsRepository	getReportsRepository()	Get reports repository.
IJob	getRunningBuildJob(IBuildArtifact artifact, String buildDescriptorName, String calculationDescriptorName)
IBuild	isBuildRunning(IBuildArtifact artifact, String buildDescriptorName, String calculationDescriptorName)	Deprecated. use getRunningBuildJob(IBuildArtifact, String, String)
IPObjectList<IBuild>	queryBuilds(IBuildArtifact artifact, String query, String sort)	Return all builds (in any state) for given artifact using query and sort criteria.
IPObjectList<IBuild>	queryBuilds(IProject project, String query, String sort)	Return all builds (in any state) for given project using query and sort criteria.
IPObjectList<IBuild>	queryBuilds(String query, String sort)	Return all builds (in any state) using query and sort criteria.
void	removeFinishedBuild(IBuild build)	Removes finished build from IBuildInformationRepository.
IBuild	runBuild(IBuildArtifact artifact, String buildDescriptorName, String calculationDescriptorName, String buildTag, String localDeploymentSpaceName, Properties properties)	Run build.
IJob	runCleanJob(String localDeploymentSpaceName)	Run clean job on given local deployment space.

Field Details

DEFAULT_BUILD_DESCRIPTOR_NAME

static final String DEFAULT_BUILD_DESCRIPTOR_NAME

default IBuildDescriptor name

See Also:

• Constant Field Values

DEFAULT_CALCULATION_DESCRIPTOR_NAME

static final String DEFAULT_CALCULATION_DESCRIPTOR_NAME

default ICalculationDescriptor name

See Also:

• Constant Field Values

DEFAULT_LOCAL_DEPLOYMENT_SPACE

static final String DEFAULT_LOCAL_DEPLOYMENT_SPACE

default local deployment space name

See Also:

• Constant Field Values

MASTER_BUILD_JOB_NAME

static final String MASTER_BUILD_JOB_NAME

Name of job coupled with runBuild(IBuildArtifact, String, String, String, String, Properties). See also IMasterBuildJobUnit.

See Also:

• Constant Field Values

CLEAN_JOB_NAME

static final String CLEAN_JOB_NAME

Name of job coupled with runCleanJob(String). See also ICleanJobUnit.

See Also:

• Constant Field Values

Method Details

getBuildArtifactsForProject

IPObjectList<IBuildArtifact> getBuildArtifactsForProject(IProject project)

Return build artifacts for given project.

Project's own build artifact (see getBuildArtifactForGroupEntity(IGroupEntity)) is not amongst returned artifacts.

Parameters:

project - project

Returns:

IPObjectList of IBuildArtifacts (not null)

Throws:

IllegalArgumentException - if project is null

getBuildArtifactForGroupEntity

IBuildArtifact getBuildArtifactForGroupEntity(IGroupEntity groupEntity)

Return build artifact representing given group entity (project or project group).

Parameters:

groupEntity - group entity

Returns:

build artifact (not null)

Throws:

IllegalArgumentException - if groupEntity is null

findBuildArtifacts

IPObjectList<IBuildArtifact> findBuildArtifacts(IBuildArtifactSelector selector)

Return all build artifacts matching given IBuildArtifactSelector.

Will return getBuildArtifactForGroupEntity(IGroupEntity) if it matches given selector.

Parameters:

selector - selector

Returns:

IPObjectList of IBuildArtifacts (not null)

Throws:

IllegalArgumentException - if selector is null

runBuild

IBuild runBuild(IBuildArtifact artifact,
 String buildDescriptorName,
 String calculationDescriptorName,
 String buildTag,
 String localDeploymentSpaceName,
 Properties properties)
         throws GenericBuilderException

Run build.

If build tag is supplied, it is used instead of IBuildDescriptor.getBuildTag().

This is a shortcut for invocation of job MASTER_BUILD_JOB_NAME and finding proper IBuild instance.

Parameters:

artifact - artifact

buildDescriptorName - build descriptor name (use DEFAULT_BUILD_DESCRIPTOR_NAME for default and null for skipping the build phase)

calculationDescriptorName - build descriptor name (use DEFAULT_CALCULATION_DESCRIPTOR_NAME for default and null for skipping the calculation phase)

buildTag - build tag (may be null)

localDeploymentSpaceName - name of local deployment space (use DEFAULT_LOCAL_DEPLOYMENT_SPACE for default integration build and null for standalone build)

properties - additional build/calculation properties (can be null)

Returns:

IBuild representing running (or at least scheduled) build

Throws:

IllegalArgumentException - if artifact is null

GenericBuilderException - if something goes wrong or build is not defined

isBuildRunning

@Deprecated
IBuild isBuildRunning(IBuildArtifact artifact,
 String buildDescriptorName,
 String calculationDescriptorName)

Deprecated.

use getRunningBuildJob(IBuildArtifact, String, String)

getRunningBuildJob

IJob getRunningBuildJob(IBuildArtifact artifact,
 String buildDescriptorName,
 String calculationDescriptorName)

Parameters:

artifact - artifact

buildDescriptorName - build descriptor name

calculationDescriptorName - build descriptor name

Returns:

job or null if there is no running or waiting build with given buildDescriptorName or calculationDescriptorName

Throws:

IllegalArgumentException - if artifact is null

Since:

3.7.3

runCleanJob

IJob runCleanJob(String localDeploymentSpaceName)
          throws GenericBuilderException

Run clean job on given local deployment space.

It is permitted to try to clean up missing deployment space.

Parameters:

localDeploymentSpaceName - name of local deployment space (use DEFAULT_LOCAL_DEPLOYMENT_SPACE for default integration build (null (standalone space) is not permitted)

Returns:

scheduled job (not null)

Throws:

IllegalArgumentException - if localDeploymentSpaceName is null

GenericBuilderException - if something goes wrong

See Also:

• CLEAN_JOB_NAME
• ICleanJobUnit

getBuildInformationRepository

IBuildInformationRepository getBuildInformationRepository()

Get build information repository where all builds are stored.

Returns:

IBuildInformationRepository instance (not null)

getReportsRepository

IReportsRepository getReportsRepository()

Get reports repository.

Returns:

IReportsRepository instance (not null)

getBuilds

IPObjectList<IBuild> getBuilds()

Return all available builds (in any state).

Returns:

IPObjectList of IBuilds (not null)

getBuilds

IPObjectList<IBuild> getBuilds(IProject project)

Return all available builds for given project (in any state).

Parameters:

project - project to list builds for

Returns:

IPObjectList of IBuilds (not null)

Throws:

IllegalArgumentException - if project is null

getBuilds

IPObjectList<IBuild> getBuilds(IBuildArtifact artifact)

Return all available builds for given artifact (in any state).

Parameters:

artifact - artifact to list builds for

Returns:

IPObjectList of IBuilds (not null)

Throws:

IllegalArgumentException - if artifact is null

queryBuilds

IPObjectList<IBuild> queryBuilds(String query,
 String sort)

Return all builds (in any state) using query and sort criteria.

Parameters:

query -

sort -

Returns:

IPObjectList of IBuilds (not null)

queryBuilds

IPObjectList<IBuild> queryBuilds(IProject project,
 String query,
 String sort)

Return all builds (in any state) for given project using query and sort criteria.

Parameters:

project - project to list builds for

query -

sort -

Returns:

IPObjectList of IBuilds (not null)

Throws:

IllegalArgumentException - if project is null

queryBuilds

IPObjectList<IBuild> queryBuilds(IBuildArtifact artifact,
 String query,
 String sort)

Return all builds (in any state) for given artifact using query and sort criteria.

Parameters:

artifact - artifact to list builds for

query -

sort -

Returns:

IPObjectList of IBuilds (not null)

Throws:

IllegalArgumentException - if artifact is null

removeFinishedBuild

void removeFinishedBuild(IBuild build)

Removes finished build from IBuildInformationRepository.

Parameters:

build - build to remove from BIR

Throws:

IllegalArgumentException - if build is null

IllegalStateException - if build is not finished

getJobForBuild

IJob getJobForBuild(IBuild build)

Return master job associated with given build.

Parameters:

build - build

Returns:

associated job or null if job was already removed

Throws:

IllegalArgumentException - if build is null

forceConfigurationReload

void forceConfigurationReload(IGroupEntity groupEntity)
                       throws GenericBuilderException

Forces configuration reload and build artifacts auto-recognition (if configured) for given group entity.

Parameters:

groupEntity - group entity

Throws:

GenericBuilderException - if something goes wrong

IllegalArgumentException - if groupEntity is null

getBuildArtifactEngineerRepository

IBuildArtifactEngineerRepository getBuildArtifactEngineerRepository()

Return associated build artifact engineer repository.

Part of service provider interface (SPI).

Returns:

repository (not null)

getBuildArtifactRecognizerRepository

IBuildArtifactRecognizerRepository getBuildArtifactRecognizerRepository()

Return associated build artifact recognizer repository.

Part of service provider interface (SPI).

Returns:

repository (not null)

getBuildExtenderRepository

IBuildExtenderRepository getBuildExtenderRepository()

Return associated build extender repository.

Returns:

build extender repository (not null)

getBuildsPolicy

IBuildsPolicy getBuildsPolicy()

Since:

3.7.3

checkIsBuildRunning

boolean checkIsBuildRunning(@NotNull
 IBuild build)

Returns true if the build is still running

Parameters:

build -

Since:

3.7.3