Package org.eclipse.steady.goals

Class AbstractAppGoal

java.lang.Object

org.eclipse.steady.goals.AbstractGoal

org.eclipse.steady.goals.AbstractAppGoal

All Implemented Interfaces:

Runnable

Direct Known Subclasses:

BomGoal, CheckverGoal, CleanGoal, ReportGoal, SequenceGoal, TestGoal, UploadGoal

public abstract class AbstractAppGoal
extends AbstractGoal

Represents an analysis goal executed in the context of a given Application. It deals particularly with application code and dependencies.

Field Summary

Fields inherited from class org.eclipse.steady.goals.AbstractGoal

CLASS_EXT, JAR_EXT, JAR_WAR_EXT, WAR_EXT

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractAppGoal(GoalType _type)	Constructor for AbstractAppGoal.

Method Summary

Modifier and Type	Method	Description
void	addAppPath(Path _p)	addAppPath.
void	addAppPaths(Set<Path> _paths)	addAppPaths.
protected Application	getApplicationContext()	getApplicationContext.
List<Path>	getAppPaths()	getAppPaths.
Map<Path,Dependency>	getKnownDependencies()	Returns known Dependencys.
boolean	hasAppPaths()	hasAppPaths.
protected void	prepareExecution()	Cleans the cache of the BackendConnector.
void	setKnownDependencies(Map<Path,Dependency> _paths)	Sets known Dependencys.

Methods inherited from class org.eclipse.steady.goals.AbstractGoal

addGoalStats, addGoalStats, addGoalStats, addGoalStats, checkPreconditions, cleanAfterExecution, executeAsync, executeSync, executeTasks, getConfiguration, getGoalClient, getGoalContext, getGoalType, getId, getResultObject, run, runsIn, setConfiguration, setGoalClient, setGoalContext, setObserver, skipGoalUpload, start, stop, stop, toJson, toString, upload

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AbstractAppGoal

protected AbstractAppGoal(GoalType _type)

Constructor for AbstractAppGoal.

Parameters:

_type - a GoalType object.

Method Detail

getApplicationContext

protected Application getApplicationContext()

getApplicationContext.

Returns:

a Application object.

getKnownDependencies

public Map<Path,Dependency> getKnownDependencies()

Returns known Dependencys.

Returns:

a Map object.

See Also:

setKnownDependencies(Map)

setKnownDependencies

public void setKnownDependencies(Map<Path,Dependency> _paths)

Sets known Dependencys. Typically called by Vulas plugins for build tools (e.g., the Vulas Maven plugin), where app dependencies are described by project meta information (e.g., the pom.xml file).

Parameters:

_paths - a Map object.

prepareExecution

protected void prepareExecution()
                         throws GoalConfigurationException

Cleans the cache of the BackendConnector. CAN be overridden in subclasses to perform additional, goal-specific checks and preparations. Checks whether one or more Paths with application constructs, and one or more Paths with dependencies are available.

Overrides:

prepareExecution in class AbstractGoal

Throws:

GoalConfigurationException - if any.

getAppPaths

public List<Path> getAppPaths()

getAppPaths.

Returns:

a List object.

addAppPath

public void addAppPath(Path _p)
                throws IllegalArgumentException

addAppPath.

Parameters:

_p - a Path object.

Throws:

IllegalArgumentException - if any.

addAppPaths

public void addAppPaths(Set<Path> _paths)
                 throws IllegalArgumentException

addAppPaths.

Parameters:

_paths - a Set object.

Throws:

IllegalArgumentException - if any.

hasAppPaths

public boolean hasAppPaths()

hasAppPaths.

Returns:

a boolean.