com.ibm.websphere.management.application.client
Class AppDeploymentTask

java.lang.Object
  |
  +--com.ibm.websphere.management.application.client.AppDeploymentTask
All Implemented Interfaces:
java.io.Serializable
public abstract class AppDeploymentTask
extends java.lang.Object
implements java.io.Serializable

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.
DataSourceFor10CMPBeans (used to specify data source for EJB1.0 beans in an application)
BindJndiForEJBNonMessageBinding (used to specify JNDI names for non MDB EJBs)
MapWebModToVH (used to specify virtual hosts for web modules) etc.
A task contains application specific data that is either shown to the user so that they can change it or is modified programmatically. The task data is a two dimensional array of strings (i.e. a table of strings). The first row of the table contains the column headings that represent specific attributes from application or modules. The rest of the rows contain values of these attributes in a task-specific manner. For example, a task to map web modules to virtual hosts has three columns that are webModule, uri and virtualHost. Each row represents a single web module for which user can read/write virtual host information. For example, the taskData for this task may look like

webModule uri virtualHost
MyModuleName myMod.war+WEB_INF/web.xml default_host
XYModuleName xyMod.war+WEB_INF/web.xml another_host

The contents of task data are very specific to a particular task.

See Also:
Serialized Form

Field Summary
protected  com.ibm.websphere.management.application.client.AppDeploymentController appController
          Controller instance that manages tasks
protected  java.lang.String[] colNames
          Task Column Names
protected  boolean hasHiddenColumns
          Specifies if the task has any hidden columns.
protected  boolean[] hiddenColumns
          Hidden columns.
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[] mutables
          Columns that can be changed
protected  java.lang.String name
          Task Name
protected  boolean[] requiredColumns
          Columns that can not have an empty ("") value
protected  java.lang.String[][] taskData
          Task Data
protected  java.lang.String[] taskValidateErrorMessages
          Error messages generated when task is validated
 
Constructor Summary
AppDeploymentTask(com.ibm.websphere.management.application.client.AppDeploymentController controller)
          Creates an instance of AppDeploymentTask
 
Method Summary
protected  void buildErrorMessages(java.util.Vector error)
           
 com.ibm.websphere.management.application.client.AppDeploymentController getAppDeploymentController()
          Returns AppDeploymentController instance
 java.lang.String[] getColumnNames()
          Returns column names for the task.
 boolean[] getMutableColumns()
          Specifies mutable columns in the task
 boolean getMutableColumns(int i)
          Specifies if a specific column is mutable
 java.lang.String getName()
          Returns task name.
 boolean[] getRequiredColumns()
          Specifies required columns in the task
 boolean getRequiredColumns(int i)
          Returns if value for a specific column is required
 java.lang.String[][] getTaskData()
          Returns task data
 com.ibm.websphere.management.application.client.AppDeploymentMessages getTaskMessages()
          Returns AppDeploymentMessages instance for the task.
 boolean isHiddenColumn(int i)
          Returns if a specific column is hidden
 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.
 void setAppDeploymentController(com.ibm.websphere.management.application.client.AppDeploymentController controller)
          Sets the controller instance
 void setIsSufficientlyDone(boolean b)
          Sets that the task has all the required data
 void setIsTaskDisabled(boolean b)
          Disables the task
 void setTaskData(java.lang.String[][] data)
          Sets task data
 java.lang.String[] validate()
          Validates the task data
protected  void verifyTaskData(java.lang.String[][] data)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

appController

protected transient com.ibm.websphere.management.application.client.AppDeploymentController appController
Controller instance that manages tasks

name

protected java.lang.String name
Task Name

isTaskEmpty

protected boolean isTaskEmpty
Specifies if task has any data in it

isSufficientlyDone

protected boolean isSufficientlyDone
Specifies if task has any required data that is not specified

isTaskDisabled

protected boolean isTaskDisabled
Specifies if task should be shown/changed

taskData

protected java.lang.String[][] taskData
Task Data

colNames

protected java.lang.String[] colNames
Task Column Names

taskValidateErrorMessages

protected java.lang.String[] taskValidateErrorMessages
Error messages generated when task is validated

mutables

protected boolean[] mutables
Columns that can be changed

requiredColumns

protected boolean[] requiredColumns
Columns that can not have an empty ("") value

hiddenColumns

protected boolean[] hiddenColumns
Hidden columns. These should not be shown by the tool that displays the tasks to the end user.

hasHiddenColumns

protected boolean hasHiddenColumns
Specifies if the task has any hidden columns.

Constructor Detail

AppDeploymentTask

public AppDeploymentTask(com.ibm.websphere.management.application.client.AppDeploymentController controller)
Creates an instance of AppDeploymentTask

Parameters:
controller - The AppDeploymentController instance.
Method Detail

setAppDeploymentController

public void setAppDeploymentController(com.ibm.websphere.management.application.client.AppDeploymentController controller)
Sets the controller instance

Parameters:
controller - The AppDeploymentController instance.

getName

public java.lang.String getName()
Returns task name.

Returns:
task name

isTaskEmpty

public boolean isTaskEmpty()
Specifies if task has any data.

Returns:
true if task has no data; false otherwise

isTaskDisabled

public boolean isTaskDisabled()
Specifies if task should be shown or changed

Returns:
true if task should not be shown; false otherwise

isSufficientlyDone

public boolean isSufficientlyDone()
Specifies if task has all the required columns populated

Returns:
true if task has all the required data; false otherwise

setIsTaskDisabled

public void setIsTaskDisabled(boolean b)
Disables the task

setIsSufficientlyDone

public void setIsSufficientlyDone(boolean b)
Sets that the task has all the required data

getColumnNames

public java.lang.String[] getColumnNames()
Returns column names for the task. These column names also appear as the first row of the task.

Returns:
Task column names.

getMutableColumns

public boolean[] getMutableColumns()
Specifies mutable columns in the task

Returns:
an array of boolean values for columns specifying if they are mutable

getMutableColumns

public boolean getMutableColumns(int i)
Specifies if a specific column is mutable

Returns:
true if ith column is mutable; false otherwise

getRequiredColumns

public boolean[] getRequiredColumns()
Specifies required columns in the task

Returns:
an array of boolean values specifying column values are required

getRequiredColumns

public boolean getRequiredColumns(int i)
Returns if value for a specific column is required

Returns:
true if the specific column must have a value; false otherwise

isHiddenColumn

public boolean isHiddenColumn(int i)
Returns if a specific column is hidden

Returns:
true if the specific column should not be shown; false otherwise

getTaskData

public java.lang.String[][] getTaskData()
Returns task data

Returns:
task data

setTaskData

public void setTaskData(java.lang.String[][] data)
                 throws AppDeploymentException
Sets task data

AppDeploymentException

verifyTaskData

protected void verifyTaskData(java.lang.String[][] data)
                       throws AppDeploymentException
AppDeploymentException

validate

public java.lang.String[] validate()
Validates the task data

Returns:
an array of error messages; null otherwise

buildErrorMessages

protected void buildErrorMessages(java.util.Vector error)

getTaskMessages

public com.ibm.websphere.management.application.client.AppDeploymentMessages getTaskMessages()
Returns AppDeploymentMessages instance for the task. The AppDeploymentMessages instance can provide translated message information such as task description etc.

Returns:
AppDeploymentMessages instance

getAppDeploymentController

public com.ibm.websphere.management.application.client.AppDeploymentController getAppDeploymentController()
Returns AppDeploymentController instance

Returns:
AppDeploymentController instance

 

WebSphere is a trademark of the IBM Corporation in the United States, other countries, or both.

 

IBM is a trademark of the IBM Corporation in the United States, other countries, or both.