public abstract class AppDeploymentTask
extends java.lang.Object
implements java.io.Serializable
public myTaskHelper implements AppDeploymentTaskHelper {
private static final String[] COLUMNS = new String[] {
"app.version",
"property.name",
"property.type",
"property.desc",
"property.value"}
public AppDeploymentTask createTask(final AppDeploymentController controller,
final String taskName)
{
AppDeploymentTask task = null;
try {
task = new WASDeploymentTask(controller, "myPropertyTask", COLUMNS,
new boolean[] { true, true, false, false, false }, // required
new boolean[] { false, false, false, false, true }, // mutable
new boolean[] { true, false, false, false, false }); // hidden
} catch (final Exception e) {
RasUtils.logException(e, tc, CLASS_NAME, "createTask", "79", this);
}
return task;
}
}
An AppDeploymentTask instance is a step in the application installation or editing
procedure. Each task has a name which specifies the operation that it performs
e.g. | webModule | uri | virtualHost |
|---|---|---|
| MyModuleName | myMod.war+WEB_INF/web.xml | default_host |
| XYModuleName | xyMod.war+WEB_INF/web.xml | another_host |
WASDeploymentTask,
Serialized Form| Modifier and Type | Field and Description |
|---|---|
protected AppDeploymentController |
appController
Controller instance that manages tasks
|
protected java.lang.String[][] |
clientTaskData
Client task data
|
protected java.lang.String[] |
colNames
Task column names
|
protected boolean |
hasHiddenColumns
Specifies if the task has any hidden columns.
|
protected boolean[] |
hiddenColumns
Hidden columns.
|
static java.lang.String |
HIGHEST_VERSION |
protected boolean |
isSufficientlyDone
Specifies if task has any required data that is not specified
|
protected boolean |
isTaskDisabled
Specifies if task should be shown/changed
|
protected boolean |
isTaskEmpty
Specifies if task has any data in it
|
protected boolean |
isValidationEnabled
Specifies if task should be validated.
|
protected boolean[] |
mutables
Columns that can be changed
|
protected java.lang.String |
name
Task name
|
protected boolean[] |
requiredColumns
Columns that can not have an empty (null or "") value
|
protected java.lang.String[][] |
taskData
Task data
|
protected java.lang.String[] |
taskValidateErrorMessages
Error messages generated when task is validated
|
static int |
VERSION_HIGHEST |
| Constructor and Description |
|---|
AppDeploymentTask(AppDeploymentController controller)
Creates an instance of AppDeploymentTask
|
| Modifier and Type | Method and Description |
|---|---|
protected void |
buildErrorMessages(java.util.Vector<java.lang.String> errorMessages)
Build error messages
|
AppDeploymentController |
getAppDeploymentController()
Returns AppDeploymentController instance
|
java.lang.String |
getCallerVersion()
Returns the major version of the client code that is calling this task.
|
int |
getClientMajorVersion()
Returns the major version of the client code that is calling this task.
|
java.lang.String[][] |
getClientTaskData()
Returns client task data
|
java.lang.String[] |
getColumnNames()
Returns column names for the task.
|
boolean[] |
getMutableColumns()
Returns mutable columns for the task
|
boolean |
getMutableColumns(int index)
Deprecated.
see isMutableColumn(int)
|
java.lang.String |
getName()
Returns task name
|
boolean[] |
getRequiredColumns() |
boolean |
getRequiredColumns(int index)
Deprecated.
see isRequiredColumn(int)
|
java.lang.String[][] |
getTaskData()
Returns task data
|
AppDeploymentMessages |
getTaskMessages()
Returns AppDeploymentMessages instance for the task.
|
boolean |
isClientModuleEnabled()
Returns whether client module is enabled
|
boolean |
isClientModuleEnabled(java.lang.String checkClientModeValue)
Returns whether client module is enabled based on enable client module
option and possibly client mode.
|
boolean |
isHiddenColumn(int index)
Returns if specific column is hidden
|
boolean |
isMutableColumn(int index)
Returns if specific column is mutable
|
boolean |
isRequiredColumn(int index)
Returns if value for specific column is required
|
boolean |
isSufficientlyDone()
Specifies if task has all the required columns populated
|
boolean |
isTaskDisabled()
Specifies if task should be shown or changed
|
boolean |
isTaskEmpty()
Specifies if task has any data
|
boolean |
isValidationEnabled()
Indicates if validation is enabled for task
|
void |
setAppDeploymentController(AppDeploymentController controller)
Sets the controller instance
|
void |
setClientTaskData(java.lang.String[][] data)
Set client task data
|
void |
setIsSufficientlyDone(boolean sufficientlyDone)
Sets that the task has all the required data
|
void |
setIsTaskDisabled(boolean taskDisabled)
Enables or disables the task
|
void |
setTaskData(java.lang.String[][] data)
Set task data
|
void |
setTaskData(java.lang.String[][] data,
boolean skipDependencies)
Set task data
|
void |
setValidationEnabled(boolean status)
Sets status of task validation * * @param status flag to specify that task validation is enabled
|
static java.lang.String[] |
taskDataToTraceObject(java.lang.String label,
java.lang.String[][] taskData) |
java.lang.String |
toString()
Returns a string representation of this object.
|
java.lang.String[] |
validate()
Validates the task data
|
protected void |
verifyTaskData(java.lang.String[][] data)
Verify data
|
public static final int VERSION_HIGHEST
public static final java.lang.String HIGHEST_VERSION
protected transient AppDeploymentController appController
protected java.lang.String name
protected boolean isTaskEmpty
protected boolean isSufficientlyDone
protected boolean isTaskDisabled
protected boolean isValidationEnabled
protected java.lang.String[][] taskData
protected java.lang.String[][] clientTaskData
protected java.lang.String[] colNames
protected java.lang.String[] taskValidateErrorMessages
protected boolean[] mutables
protected boolean[] requiredColumns
protected boolean[] hiddenColumns
protected boolean hasHiddenColumns
public AppDeploymentTask(AppDeploymentController controller)
controller - The AppDeploymentController instance.public static java.lang.String[] taskDataToTraceObject(java.lang.String label,
java.lang.String[][] taskData)
public AppDeploymentController getAppDeploymentController()
public void setAppDeploymentController(AppDeploymentController controller)
controller - The AppDeploymentController instance.public java.lang.String getName()
public java.lang.String[] getColumnNames()
public boolean isTaskEmpty()
public boolean isTaskDisabled()
public void setIsTaskDisabled(boolean taskDisabled)
taskDisabled - flag to disable the taskpublic boolean isSufficientlyDone()
public void setIsSufficientlyDone(boolean sufficientlyDone)
sufficientlyDone - flag to specify that the task has all the required datapublic boolean[] getMutableColumns()
public boolean isMutableColumn(int index)
index - Index of column to check@Deprecated public boolean getMutableColumns(int index)
index - Index of column to checkpublic boolean[] getRequiredColumns()
public boolean isRequiredColumn(int index)
index - Index of column to check@Deprecated public boolean getRequiredColumns(int index)
index - Index of column to checkpublic boolean isHiddenColumn(int index)
index - Index of column to checkpublic boolean isValidationEnabled()
public void setValidationEnabled(boolean status)
public java.lang.String[][] getTaskData()
public void setTaskData(java.lang.String[][] data)
throws com.ibm.websphere.management.application.client.AppDeploymentException
data - task data or nullcom.ibm.websphere.management.application.client.AppDeploymentExceptionpublic void setTaskData(java.lang.String[][] data,
boolean skipDependencies)
throws com.ibm.websphere.management.application.client.AppDeploymentException
data - task data or nullskipDependencies - com.ibm.websphere.management.application.client.AppDeploymentExceptionprotected void verifyTaskData(java.lang.String[][] data)
throws com.ibm.websphere.management.application.client.AppDeploymentException
data - task data or nullcom.ibm.websphere.management.application.client.AppDeploymentExceptionpublic java.lang.String[] validate()
protected void buildErrorMessages(java.util.Vector<java.lang.String> errorMessages)
errorMessages - Vector of error messagespublic AppDeploymentMessages getTaskMessages()
public java.lang.String getCallerVersion()
public int getClientMajorVersion()
public boolean isClientModuleEnabled()
public boolean isClientModuleEnabled(java.lang.String checkClientModeValue)
checkClientModeValue - whether to take into consideration of client
mode to check if client module is enabled. If a client
mode is specified, then do further checking to see whether
the mode is set to the value passed in.public void setClientTaskData(java.lang.String[][] data)
client - task data or nullpublic java.lang.String[][] getClientTaskData()
public java.lang.String toString()
toString in class java.lang.Object