org.jboss.dtf.testframework.coordinator.actions
Class PerformAction

java.lang.Object
  org.jboss.dtf.testframework.coordinator.Action
      org.jboss.dtf.testframework.coordinator.actions.PerformAction

Direct Known Subclasses:

StartAction

public class PerformAction
extends Action

Field Summary

protected java.lang.String[]	_jvmParameterList
protected java.lang.String	_location
protected java.lang.String	_nameList
protected java.lang.String[]	_parameterList
protected java.lang.String	_runtimeId
protected java.lang.String	_taskId

Fields inherited from class org.jboss.dtf.testframework.coordinator.Action

_actionType, LOCATION_ALL, LOCATION_DEPENDENT, LOCATION_INDEPENDENT, LOCATION_SPECIFIC, LOCATION_STRINGS, PERFORM_TASK, START_TASK, TERMINATE_TASK, WAIT_FOR_TASK

Constructor Summary

PerformAction(java.lang.String id, java.lang.String runtimeId, java.lang.String location, java.lang.String[] parameterList, java.lang.String[] jvmParameterList, java.lang.String nameList)

Method Summary

java.lang.String	getAssociatedNameList() Retrieves the name list for this action, throws an exception if no name list is associated with this action.
java.lang.String	getAssociatedRuntimeTaskId() Retrieves the associated runtime task id., if one doesn't exist an exception is thrown.
java.lang.String	getAssociatedTaskId() Retrieves the task id.
java.lang.String[]	getJVMParameterList() Retrieves the parameters to be passed to the JVM that executes this action, if no parameters are associated with this action then an exception is thrown.
java.lang.String	getLocation() Retrieves the location value associated with this action, if the action type doesn't have an associated location an exception is thrown.
java.lang.String[]	getParameterList() Retrieves the parameters to be passed to this action, if no parameters are associated with this action then an exception is thrown.
static PerformAction	getPerformAction(Element actionElement)
Element	serializeToXML() Create an XML element which represents this action
void	setAssociatedRuntimeTaskId(java.lang.String runtimeId) Set the runtime id associated with this task.
void	setAssociatedTaskId(java.lang.String taskId) Sets the task id.
void	setJVMParameterList(java.lang.String[] parameters) Sets the JVM parameters to be passed to this task.
void	setLocation(java.lang.String location) Sets the location value associated with this action.
void	setParameterList(java.lang.String[] parameters) Set the parameters to be passed to this task.
java.lang.String	toString()

Methods inherited from class org.jboss.dtf.testframework.coordinator.Action

getLocationType, getType

Methods inherited from class java.lang.Object

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

Field Detail

_taskId

protected java.lang.String _taskId

_runtimeId

protected java.lang.String _runtimeId

_location

protected java.lang.String _location

_parameterList

protected java.lang.String[] _parameterList

_jvmParameterList

protected java.lang.String[] _jvmParameterList

_nameList

protected java.lang.String _nameList

Constructor Detail

PerformAction

public PerformAction(java.lang.String id,
                     java.lang.String runtimeId,
                     java.lang.String location,
                     java.lang.String[] parameterList,
                     java.lang.String[] jvmParameterList,
                     java.lang.String nameList)

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getAssociatedTaskId

public java.lang.String getAssociatedTaskId()
                                     throws NoAssociatedData

Retrieves the task id. associated with this action, if the action type doesn't have an associated task id. an exception is thrown.

Specified by:

getAssociatedTaskId in class Action

Returns:

The associated task id

Throws:

NoAssociatedData - Thrown if there is no associated task id.

setAssociatedTaskId

public void setAssociatedTaskId(java.lang.String taskId)

Sets the task id. associated with this action.

Parameters:

taskId - The task id to associate with this task.

getLocation

public java.lang.String getLocation()
                             throws NoAssociatedData

Retrieves the location value associated with this action, if the action type doesn't have an associated location an exception is thrown.

Specified by:

getLocation in class Action

Returns:

The associated location value

Throws:

NoAssociatedData - Thrown if there is no associated task id.

setLocation

public void setLocation(java.lang.String location)

Sets the location value associated with this action.

Parameters:

location - The associated location value

getParameterList

public java.lang.String[] getParameterList()
                                    throws NoAssociatedData

Retrieves the parameters to be passed to this action, if no parameters are associated with this action then an exception is thrown.

Specified by:

getParameterList in class Action

Returns:

The parameters to be passed to this action

Throws:

NoAssociatedData - Thrown if there are no parameters for this action.

setParameterList

public void setParameterList(java.lang.String[] parameters)

Set the parameters to be passed to this task.

Parameters:

parameters - The parameters to be passed to this task.

getJVMParameterList

public java.lang.String[] getJVMParameterList()
                                       throws NoAssociatedData

Retrieves the parameters to be passed to the JVM that executes this action, if no parameters are associated with this action then an exception is thrown.

Specified by:

getJVMParameterList in class Action

Returns:

The parameters to be passed to the JVM

Throws:

NoAssociatedData - Thrown if there are no parameters to pass to the JVM.

setJVMParameterList

public void setJVMParameterList(java.lang.String[] parameters)

Sets the JVM parameters to be passed to this task.

Parameters:

parameters - The JVM parameters to be passed to this task.

getAssociatedRuntimeTaskId

public java.lang.String getAssociatedRuntimeTaskId()
                                            throws NoAssociatedData

Retrieves the associated runtime task id., if one doesn't exist an exception is thrown.

Specified by:

getAssociatedRuntimeTaskId in class Action

Returns:

The associated runtime task id.

Throws:

NoAssociatedData - Thrown if there is no associated runtime task id.

setAssociatedRuntimeTaskId

public void setAssociatedRuntimeTaskId(java.lang.String runtimeId)

Set the runtime id associated with this task.

Parameters:

runtimeId - The runtime id. to set.

getAssociatedNameList

public java.lang.String getAssociatedNameList()
                                       throws NoAssociatedData

Retrieves the name list for this action, throws an exception if no name list is associated with this action.

Specified by:

getAssociatedNameList in class Action

Returns:

The name list associated with this action.

Throws:

NoAssociatedData - Thrown if there is no associated name list.

serializeToXML

public Element serializeToXML()
                       throws NoAssociatedData

Create an XML element which represents this action

Specified by:

serializeToXML in class Action

Returns:

The XML element representing this action.

Throws:

NoAssociatedData

getPerformAction

public static PerformAction getPerformAction(Element actionElement)