Package com.polarion.alm.builder.spi

Interface IBuildArtifactEngineer

All Known Implementing Classes:

AbstractNonMavenBuildArtifactEngineer

public interface IBuildArtifactEngineer

IBuildArtifact engineer.

Should not access any services in the platform, just use components provided by IBuildArtifactEngineer.IEngineeringContext.

Version:

$Revision$ $Date$

Author:

Stepan Roh, Polarion Software

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	IBuildArtifactEngineer.IEngineeringContext	Components and methods necessary for all engineering work.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ATTACHED_VALUE_LOCAL_POM	build artifact's attached value: local pom.xml File

Method Summary

Modifier and Type	Method	Description
void	amendBuildArtifact(IBuildArtifactEngineer.IEngineeringContext context)	Amend (fill in the gaps of) build artifact.
File	createPOMFile(IBuildArtifactEngineer.IEngineeringContext context, String buildDescriptorName, String calculationDescriptorName, File localDir)	Create POM (Project Object Model from Maven 2) file (pom.xml) for given artifact.
List	deriveMavenGoals(IBuildArtifactEngineer.IEngineeringContext context, String buildName)	Derive phases/goals to run during build described by build descriptor of given name.
Collection	expandDerivedBuildDeploymentDefinition(IBuildArtifactEngineer.IEngineeringContext context, IBuildDescriptor.IDerivedBuildDeploymentDefinition derivedDef)	Will transform IBuildDescriptor.IDerivedBuildDeploymentDefinition to IBuildDescriptor.ISimpleBuildDeploymentDefinition (if possible).

Field Details

ATTACHED_VALUE_LOCAL_POM

static final String ATTACHED_VALUE_LOCAL_POM

build artifact's attached value: local pom.xml File

See Also:

• Constant Field Values

Method Details

amendBuildArtifact

void amendBuildArtifact(IBuildArtifactEngineer.IEngineeringContext context)
                 throws GenericBuilderException

Amend (fill in the gaps of) build artifact.

Note that when tag is specified in prepared artifact all operations in ISourceRepository must be done with tagged locations.

Parameters:

context - engineering context

Throws:

IllegalArgumentException - if context is null

GenericBuilderException - if error happens

createPOMFile

File createPOMFile(IBuildArtifactEngineer.IEngineeringContext context,
 String buildDescriptorName,
 String calculationDescriptorName,
 File localDir)
            throws GenericBuilderException

Create POM (Project Object Model from Maven 2) file (pom.xml) for given artifact.

If given artifact already has POM (by nature, not that it seems to exists there), its location is returned and no changes are done.

Passing of build/calculation descriptor name allows to create POM based on build/calculation configuration (needed for some).

Local directory points to the directory corresponding to artifact's repository object's location.

Created POM must be constructed in such a way that if invoked it will auto-invoke POM's of contained artifacts (or it will do the same work as if invoked).

Will set build artifact's attached value ATTACHED_VALUE_LOCAL_POM to returned File.

Parameters:

context - engineering context

buildDescriptorName - build descriptor name or null

calculationDescriptorName - calculation descriptor name or null

localDir - local directory

Returns:

POM file location

Throws:

IllegalArgumentException - if context is null

IllegalArgumentException - if localDir is null

GenericBuilderException - if error happens

deriveMavenGoals

List deriveMavenGoals(IBuildArtifactEngineer.IEngineeringContext context,
 String buildName)

Derive phases/goals to run during build described by build descriptor of given name.

Parameters:

context - engineering context

buildName - build descriptor name

Returns:

List of String phase/goal names or null if not specified

Throws:

IllegalArgumentException - if context is null

IllegalArgumentException - if buildName is null

expandDerivedBuildDeploymentDefinition

Collection expandDerivedBuildDeploymentDefinition(IBuildArtifactEngineer.IEngineeringContext context,
 IBuildDescriptor.IDerivedBuildDeploymentDefinition derivedDef)

Will transform IBuildDescriptor.IDerivedBuildDeploymentDefinition to IBuildDescriptor.ISimpleBuildDeploymentDefinition (if possible).

Unknown derived build deployment artifact name must be ignored.

Parameters:

context - engineering context

derivedDef -

Returns:

Collection of IBuildDescriptor.ISimpleBuildDeploymentDefinitions (not null)

Throws:

IllegalArgumentException - if context is null