Package org.eclipse.steady.tasks

Interface Task

All Known Subinterfaces:

BomTask

All Known Implementing Classes:

AbstractBomTask, AbstractTask

public interface Task

Task interface.

Method Summary

Modifier and Type	Method	Description
void	cleanUp()	Called after execute().
void	configure(VulasConfiguration _cfg)	Called prior to execute().
void	execute()	Performs the actual application analysis.
Set<ProgrammingLanguage>	getLanguage()	The analysis of an application is typically dependent on its ProgrammingLanguages.
void	setApplication(Application _app)	Sets the Application in whose context the task is executed.
void	setGoalClient(GoalClient _client)	Sets the GoalClient in whose context the task is executed.
void	setKnownDependencies(Map<Path,Dependency> _known_dependencies)	Provides the task with application Dependencys that are already known before task execution.
void	setSearchPaths(List<Path> _paths)	Sets one or more file systems Paths that contain application code and/or dependencies.

Method Detail

setGoalClient

void setGoalClient(GoalClient _client)

Sets the GoalClient in whose context the task is executed.

Parameters:

_client - a GoalClient object.

setApplication

void setApplication(Application _app)

Sets the Application in whose context the task is executed.

Parameters:

_app - a Application object.

setSearchPaths

void setSearchPaths(List<Path> _paths)

Sets one or more file systems Paths that contain application code and/or dependencies.

Parameters:

_paths - a List object.

setKnownDependencies

void setKnownDependencies(Map<Path,Dependency> _known_dependencies)

Provides the task with application Dependencys that are already known before task execution. This information may come from build systems or the like, and typically facilitates the task execution.

Parameters:

_known_dependencies - a Map object.

configure

void configure(VulasConfiguration _cfg)
        throws GoalConfigurationException

Called prior to execute().

Parameters:

_cfg - a VulasConfiguration object.

Throws:

GoalConfigurationException

execute

void execute()
      throws GoalExecutionException

Performs the actual application analysis. Right after, task-specific methods can be used to retrieve the analysis results.

Throws:

GoalExecutionException

cleanUp

void cleanUp()

Called after execute().

getLanguage

Set<ProgrammingLanguage> getLanguage()

The analysis of an application is typically dependent on its ProgrammingLanguages. This method returns the ProgrammingLanguages covered by the Task.

Returns:

a Set object.