Package org.eclipse.steady.goals

Class AbstractGoal

java.lang.Object

org.eclipse.steady.goals.AbstractGoal

All Implemented Interfaces:

Runnable

Direct Known Subclasses:

AbstractAppGoal, AbstractSpaceGoal

public abstract class AbstractGoal
extends Object
implements Runnable

Represents the execution of a goal, which is triggered by client components such as the CLI and the Maven plugin. There exist different types of goals, e.g., GoalType.CLEAN or GoalType.A2C. Goal executions can be started and stopped manually using the methods start(), stop(), stop(Exception) and upload(boolean). Goal executions can also be executed automatically using the methods executeSync() or executeAsync(), which results in the sequential execution of the above-mentioned methods start(), etc. Subclasses typically override the methods prepareExecution, executeTasks and cleanAfterExecution. See VULAS-204 in case we run into problems related to special characters in paths.

Field Summary

Fields

Modifier and Type	Field	Description
protected static String[]	CLASS_EXT	Constant CLASS_EXT
protected static String[]	JAR_EXT	Constant JAR_EXT
protected static String[]	JAR_WAR_EXT	Constant JAR_WAR_EXT
protected static String[]	WAR_EXT	Constant WAR_EXT

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractGoal(GoalType _goal)	Constructor for AbstractGoal.
protected	AbstractGoal(GoalType _goal, boolean _monitor_mem)	Constructor for AbstractGoal.

Method Summary

Modifier and Type	Method	Description
void	addGoalStats(String _key, double _val)	addGoalStats.
void	addGoalStats(String _key, int _val)	addGoalStats.
void	addGoalStats(String _key, long _val)	addGoalStats.
void	addGoalStats(String _prefix, Map<String,Long> _stats)	addGoalStats.
protected void	checkPreconditions()	CAN be overridden in subclasses.
protected void	cleanAfterExecution()	Empty implementation.
void	executeAsync()	executeAsync.
void	executeSync()	executeSync.
protected abstract void	executeTasks()	MUST be overridden in subclasses to implement the goal-specific tasks.
protected VulasConfiguration	getConfiguration()	Returns the configuration of this goal execution.
GoalClient	getGoalClient()	getGoalClient.
GoalContext	getGoalContext()	Returns the context of this goal execution.
GoalType	getGoalType()	Getter for the field goalType.
String	getId()	Getter for the field id.
protected Object	getResultObject()	Empty implementation.
protected void	prepareExecution()	Cleans the cache of the BackendConnector.
void	run()	run.
boolean	runsIn(GoalClient _client)	Returns true if this AbstractGoal is executed in the given GoalClient, false otherwise.
AbstractGoal	setConfiguration(VulasConfiguration _c)	Setter for the field configuration.
void	setGoalClient(GoalClient _client)	setGoalClient.
void	setGoalContext(GoalContext _ctx)	Setter for the field goalContext.
void	setObserver(ExecutionObserver observer)	Setter for the field observer.
protected void	skipGoalUpload()	skipGoalUpload.
void	start()	Starts the goal execution.
void	stop()	Stops the goal execution, i.e., takes the time and stops the monitoring thread (if any).
void	stop(Exception _e)	Stops the goal execution in response to the provided exception.
String	toJson()	Creates a JSON string representing this goal execution.
String	toString()	toString.
boolean	upload(boolean _before)	Uploads the JSON presentation of this goal execution to the backend.

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_EXT

protected static final String[] CLASS_EXT

Constant CLASS_EXT

JAR_EXT

protected static final String[] JAR_EXT

Constant JAR_EXT

WAR_EXT

protected static final String[] WAR_EXT

Constant WAR_EXT

JAR_WAR_EXT

protected static final String[] JAR_WAR_EXT

Constant JAR_WAR_EXT

Constructor Detail

AbstractGoal

protected AbstractGoal(GoalType _goal)

Constructor for AbstractGoal.

Parameters:

_goal - a GoalType object.

AbstractGoal

protected AbstractGoal(GoalType _goal,
                       boolean _monitor_mem)

Constructor for AbstractGoal.

Parameters:

_goal - a GoalType object.

_monitor_mem - a boolean.

Method Detail

getId

public String getId()

Getter for the field id.

Returns:

a String object.

setObserver

public void setObserver(ExecutionObserver observer)

Setter for the field observer.

Parameters:

observer - a ExecutionObserver object.

getGoalType

public GoalType getGoalType()

Getter for the field goalType.

Returns:

a GoalType object.

getGoalClient

public GoalClient getGoalClient()

getGoalClient.

Returns:

a GoalClient object.

setGoalClient

public void setGoalClient(GoalClient _client)

setGoalClient.

Parameters:

_client - a GoalClient object.

runsIn

public boolean runsIn(GoalClient _client)

Returns true if this AbstractGoal is executed in the given GoalClient, false otherwise.

Parameters:

_client - a GoalClient object.

Returns:

a boolean.

executeAsync

public final void executeAsync()

executeAsync.

run

public final void run()

run.

Specified by:

run in interface Runnable

executeSync

public final void executeSync()
                       throws GoalConfigurationException,
                              GoalExecutionException

executeSync.

Throws:

GoalConfigurationException - if any.

GoalExecutionException - if any.

getConfiguration

protected final VulasConfiguration getConfiguration()

Returns the configuration of this goal execution. If the configuration has not been set before, a new instance of VulasConfiguration is created and returned. As such, the configuration settings of different goal executions can be isolated.

Returns:

a VulasConfiguration object.

setConfiguration

public final AbstractGoal setConfiguration(VulasConfiguration _c)

Setter for the field configuration.

Parameters:

_c - a VulasConfiguration object.

Returns:

a AbstractGoal object.

getGoalContext

public final GoalContext getGoalContext()

Returns the context of this goal execution. If the context has not been set before, it is constructed by reading tenant, space and app information from the configuration obtained from getConfiguration().

Returns:

a GoalContext object.

setGoalContext

public final void setGoalContext(GoalContext _ctx)

Setter for the field goalContext.

Parameters:

_ctx - a GoalContext 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.

Throws:

GoalConfigurationException - if any.

checkPreconditions

protected void checkPreconditions()
                           throws GoalConfigurationException

CAN be overridden in subclasses.

Throws:

GoalConfigurationException - if any.

executeTasks

protected abstract void executeTasks()
                              throws Exception

MUST be overridden in subclasses to implement the goal-specific tasks.

Throws:

Exception - if any.

cleanAfterExecution

protected void cleanAfterExecution()

Empty implementation. CAN be overridden in subclasses in order to perform goal-specific clean-up.

getResultObject

protected Object getResultObject()

Empty implementation.

Returns:

a Object object.

start

public void start()
           throws GoalConfigurationException

Starts the goal execution.

Throws:

GoalConfigurationException - if any.

stop

public void stop()

Stops the goal execution, i.e., takes the time and stops the monitoring thread (if any).

stop

public void stop(Exception _e)

Stops the goal execution in response to the provided exception.

Parameters:

_e - a Exception object.

See Also:

stop()

addGoalStats

public void addGoalStats(String _prefix,
                         Map<String,Long> _stats)

addGoalStats.

Parameters:

_prefix - a String object.

_stats - a Map object.

addGoalStats

public void addGoalStats(String _key,
                         long _val)

addGoalStats.

Parameters:

_key - a String object.

_val - a long.

addGoalStats

public void addGoalStats(String _key,
                         int _val)

addGoalStats.

Parameters:

_key - a String object.

_val - a int.

addGoalStats

public void addGoalStats(String _key,
                         double _val)

addGoalStats.

Parameters:

_key - a String object.

_val - a double.

toString

public String toString()

toString.

Overrides:

toString in class Object

Returns:

a String object.

toJson

public String toJson()
              throws IllegalStateException

Creates a JSON string representing this goal execution.

Returns:

a String object.

Throws:

IllegalStateException

skipGoalUpload

protected final void skipGoalUpload()

skipGoalUpload.

upload

public boolean upload(boolean _before)

Uploads the JSON presentation of this goal execution to the backend. Returns true if everything went fine (upload succeeded or is not necessary), false otherwise.

Parameters:

_before - a boolean.

Returns:

a boolean.