Index: lams_tool_deploy/src/java/org/lamsfoundation/lams/tool/deploy/AddWebAppToApplicationXmlTask.java =================================================================== diff -u -rb9682e51114d632fd77ff0feabf3f2de634744bd -rabb3194da8bc2d0b6a661e486fd007aa03412ffc --- lams_tool_deploy/src/java/org/lamsfoundation/lams/tool/deploy/AddWebAppToApplicationXmlTask.java (.../AddWebAppToApplicationXmlTask.java) (revision b9682e51114d632fd77ff0feabf3f2de634744bd) +++ lams_tool_deploy/src/java/org/lamsfoundation/lams/tool/deploy/AddWebAppToApplicationXmlTask.java (.../AddWebAppToApplicationXmlTask.java) (revision abb3194da8bc2d0b6a661e486fd007aa03412ffc) @@ -25,7 +25,7 @@ import org.w3c.dom.Element; /** - * Ant Task to add a web application entry to an EAR application XML + * Task to add a web application entry to an EAR application XML * @author chris */ public class AddWebAppToApplicationXmlTask extends UpdateApplicationXmlTask Index: lams_tool_deploy/src/java/org/lamsfoundation/lams/tool/deploy/DBTask.java =================================================================== diff -u -rb9682e51114d632fd77ff0feabf3f2de634744bd -rabb3194da8bc2d0b6a661e486fd007aa03412ffc --- lams_tool_deploy/src/java/org/lamsfoundation/lams/tool/deploy/DBTask.java (.../DBTask.java) (revision b9682e51114d632fd77ff0feabf3f2de634744bd) +++ lams_tool_deploy/src/java/org/lamsfoundation/lams/tool/deploy/DBTask.java (.../DBTask.java) (revision abb3194da8bc2d0b6a661e486fd007aa03412ffc) @@ -30,7 +30,7 @@ import org.apache.commons.io.FileUtils; /** - * + * parent of database related tasks * @author chris */ public abstract class DBTask implements Task Index: lams_tool_deploy/src/java/org/lamsfoundation/lams/tool/deploy/Deploy.java =================================================================== diff -u -rb9682e51114d632fd77ff0feabf3f2de634744bd -rabb3194da8bc2d0b6a661e486fd007aa03412ffc --- lams_tool_deploy/src/java/org/lamsfoundation/lams/tool/deploy/Deploy.java (.../Deploy.java) (revision b9682e51114d632fd77ff0feabf3f2de634744bd) +++ lams_tool_deploy/src/java/org/lamsfoundation/lams/tool/deploy/Deploy.java (.../Deploy.java) (revision abb3194da8bc2d0b6a661e486fd007aa03412ffc) @@ -22,7 +22,7 @@ package org.lamsfoundation.lams.tool.deploy; /** - * Tool Deployer + * Tool Deployer Main Class * @author chris */ public class Deploy @@ -34,6 +34,7 @@ } /** + * Runs the Deploy * @param args the command line arguments */ public static void main(String[] args) throws Exception Index: lams_tool_deploy/src/java/org/lamsfoundation/lams/tool/deploy/DeployConfig.java =================================================================== diff -u -rb9682e51114d632fd77ff0feabf3f2de634744bd -rabb3194da8bc2d0b6a661e486fd007aa03412ffc --- lams_tool_deploy/src/java/org/lamsfoundation/lams/tool/deploy/DeployConfig.java (.../DeployConfig.java) (revision b9682e51114d632fd77ff0feabf3f2de634744bd) +++ lams_tool_deploy/src/java/org/lamsfoundation/lams/tool/deploy/DeployConfig.java (.../DeployConfig.java) (revision abb3194da8bc2d0b6a661e486fd007aa03412ffc) @@ -134,8 +134,9 @@ } /** - * Getter for property toolWebAppPath. - * @return Value of property toolWebAppPath. + * The value to be used in the web-uri element of the application xml + * for the tool being deployed. + * @return Value of property toolWebAppUri. */ public String getToolWebUri() @@ -146,7 +147,8 @@ } /** - * Getter for property toolContextRoot. + * The value to be used in the context-root element of the application xml + * for the tool being deployed. * @return Value of property toolContextRoot. */ public String getToolContextRoot() @@ -156,7 +158,7 @@ } /** - * Getter for property lamsEarPath. + * The path to the lasm ear. * @return Value of property lamsEarPath. */ public String getLamsEarPath() @@ -166,7 +168,7 @@ } /** - * Getter for property toolIinsertScriptPath. + * The path to the sql script that inserts the lams_tool record. * @return Value of property toolIinsertScriptPath. */ public String getToolInsertScriptPath() @@ -178,7 +180,7 @@ } /** - * Getter for property libraryInsertScriptPath. + * The path to the sql script that inserts that lams_learning_library record. * @return Value of property libraryInsertScriptPath. */ public String getToolLibraryInsertScriptPath() @@ -190,7 +192,7 @@ } /** - * Getter for property toolActivityInsertScriptPath. + * The path to the sql script that inserts the lams_learning_activity record. * @return Value of property toolActivityInsertScriptPath. */ public String getToolActivityInsertScriptPath() @@ -201,7 +203,8 @@ } /** - * Getter for property toolTablesScriptPath. + * The path to the sql script that creates the tools tables and inserts + * any required data. * @return Value of property toolTablesScriptPath. */ public String getToolTablesScriptPath() @@ -212,7 +215,8 @@ } /** - * Getter for property deployFiles. + * The list of files that need to be nmoved to the lams ear + * to deploy the tool. * @return Value of property deployFiles. */ public List getDeployFiles() @@ -222,7 +226,7 @@ } /** - * Getter for property dbUsername. + * The username for the lams db. * @return Value of property dbUsername. */ public String getDbUsername() @@ -232,7 +236,7 @@ } /** - * Getter for property dbPassword. + * The password for the lams db. * @return Value of property dbPassword. */ public String getDbPassword() @@ -242,7 +246,7 @@ } /** - * Getter for property dbDriverClass. + * The class name of the JDBC driver to use. * @return Value of property dbDriverClass. */ public String getDbDriverClass() @@ -252,7 +256,7 @@ } /** - * Getter for property dbDriverURL. + * The URL for the JDBC driver to connect with. * @return Value of property dbDriverURL. */ public String getDbDriverUrl() Index: lams_tool_deploy/src/java/org/lamsfoundation/lams/tool/deploy/DeployException.java =================================================================== diff -u -ra174a94fcb9db22380a89926f460afbef0216c91 -rabb3194da8bc2d0b6a661e486fd007aa03412ffc --- lams_tool_deploy/src/java/org/lamsfoundation/lams/tool/deploy/DeployException.java (.../DeployException.java) (revision a174a94fcb9db22380a89926f460afbef0216c91) +++ lams_tool_deploy/src/java/org/lamsfoundation/lams/tool/deploy/DeployException.java (.../DeployException.java) (revision abb3194da8bc2d0b6a661e486fd007aa03412ffc) @@ -7,7 +7,7 @@ package org.lamsfoundation.lams.tool.deploy; /** - * + * Exception thrown by deployment process. * @author chris */ public class DeployException extends java.lang.RuntimeException Index: lams_tool_deploy/src/java/org/lamsfoundation/lams/tool/deploy/DeployFilesTask.java =================================================================== diff -u -rb9682e51114d632fd77ff0feabf3f2de634744bd -rabb3194da8bc2d0b6a661e486fd007aa03412ffc --- lams_tool_deploy/src/java/org/lamsfoundation/lams/tool/deploy/DeployFilesTask.java (.../DeployFilesTask.java) (revision b9682e51114d632fd77ff0feabf3f2de634744bd) +++ lams_tool_deploy/src/java/org/lamsfoundation/lams/tool/deploy/DeployFilesTask.java (.../DeployFilesTask.java) (revision abb3194da8bc2d0b6a661e486fd007aa03412ffc) @@ -26,7 +26,7 @@ import org.apache.commons.io.FileUtils; /** - * Copies the required file to the lams ear directory. + * Deploys required files to the lams ear. * @author chris */ public class DeployFilesTask extends FilesTask Index: lams_tool_deploy/src/java/org/lamsfoundation/lams/tool/deploy/FilesTask.java =================================================================== diff -u -rb9682e51114d632fd77ff0feabf3f2de634744bd -rabb3194da8bc2d0b6a661e486fd007aa03412ffc --- lams_tool_deploy/src/java/org/lamsfoundation/lams/tool/deploy/FilesTask.java (.../FilesTask.java) (revision b9682e51114d632fd77ff0feabf3f2de634744bd) +++ lams_tool_deploy/src/java/org/lamsfoundation/lams/tool/deploy/FilesTask.java (.../FilesTask.java) (revision abb3194da8bc2d0b6a661e486fd007aa03412ffc) @@ -26,7 +26,7 @@ import org.apache.commons.io.FileUtils; /** - * Copies the required file to the lams ear directory. + * Parent of Tasks that deal with the deploy files. * @author chris */ public abstract class FilesTask implements Task @@ -48,7 +48,7 @@ } /** - * Setter for property lamsEarPath. + * Sets the path to the lams ear. * @param lamsEarPath New value of property lamsEarPath. */ public void setLamsEarPath(String lamsEarPath) @@ -58,7 +58,7 @@ } /** - * Setter for property deployFiles. + * Sets the list of file paths to operate on. * @param deployFiles New value of property deployFiles. */ public void setDeployFiles(List deployFiles) Index: lams_tool_deploy/src/java/org/lamsfoundation/lams/tool/deploy/Task.java =================================================================== diff -u -rb9682e51114d632fd77ff0feabf3f2de634744bd -rabb3194da8bc2d0b6a661e486fd007aa03412ffc --- lams_tool_deploy/src/java/org/lamsfoundation/lams/tool/deploy/Task.java (.../Task.java) (revision b9682e51114d632fd77ff0feabf3f2de634744bd) +++ lams_tool_deploy/src/java/org/lamsfoundation/lams/tool/deploy/Task.java (.../Task.java) (revision abb3194da8bc2d0b6a661e486fd007aa03412ffc) @@ -22,10 +22,15 @@ package org.lamsfoundation.lams.tool.deploy; /** - * + * Defines a Task in the tool deploy or undeploy process. * @author chris */ public interface Task { + /** + * Executes the task. + * @throws DeployException if Task cannot be executed. + * + */ public void execute() throws DeployException; } Index: lams_tool_deploy/src/java/org/lamsfoundation/lams/tool/deploy/ToolDBActivateTask.java =================================================================== diff -u -rb9682e51114d632fd77ff0feabf3f2de634744bd -rabb3194da8bc2d0b6a661e486fd007aa03412ffc --- lams_tool_deploy/src/java/org/lamsfoundation/lams/tool/deploy/ToolDBActivateTask.java (.../ToolDBActivateTask.java) (revision b9682e51114d632fd77ff0feabf3f2de634744bd) +++ lams_tool_deploy/src/java/org/lamsfoundation/lams/tool/deploy/ToolDBActivateTask.java (.../ToolDBActivateTask.java) (revision abb3194da8bc2d0b6a661e486fd007aa03412ffc) @@ -27,7 +27,7 @@ import org.apache.commons.dbutils.DbUtils; /** - * Ant task runs the creates & inserts for the LAMS aand Tool DB tables + * Task activates tool records int the lams db. * @author chris * * @@ -90,7 +90,7 @@ } /** - * Setter for property toolId. + * Sets the id of the tool to activate. * @param toolId New value of property toolId. */ public void setToolId(long toolId) @@ -100,7 +100,7 @@ } /** - * Setter for property learningLibraryId. + * Sets the id of the tools library. * @param learningLibraryId New value of property learningLibraryId. */ public void setLearningLibraryId(long learningLibraryId)