com.dpslink.base.tool

Class AppUpdater

java.lang.Object

com.dpslink.base.tool.AppUpdater

public class AppUpdater
extends java.lang.Object

Update an installed set of application files based on reviewing files from a master server accessed via FTP. This class should be executed from the command line on the machine containing the application in the local directory structure. Configuration comes from AppUpdater.properties which must be found on the classpath - there are no command line parameters, everything is configured from the property file.

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	cvAppBaseDir Deployed application base directory (in local file system)
protected static java.util.Properties	cvConfig Configuration properties loaded from AppUpdater.properties
protected static java.util.ArrayList<java.lang.String>	cvExclude Collection of excluded files/directories as specified in the properties file
protected static org.apache.commons.net.ftp.FTPClient	cvFTP FTP client for interaction with the FTP server
protected static java.lang.String	cvFTPBaseDir Base (starting) directory of the FTP site containing "master" files
static boolean	cvPrompt Flag determines if user will be prompted for each copy operation.
protected static java.text.SimpleDateFormat	dateFormatter Format timestamps for readability
static java.lang.String	FILE_SEP Constant to hold the directory separator character of the local machine.

Constructor Summary

Constructors

Constructor and Description
AppUpdater()

Method Summary

Modifier and Type	Method and Description
protected static boolean	checkPath(java.io.File chkFile) Check the entire path of the given file and create needed parent directories.
protected static void	disconnect() Log out and disconnect from the FTP server.
protected static void	download(org.apache.commons.net.ftp.FTPFile ftpFile, java.io.File localFile) Download a file from the FTP server after confirming action by prompting the user.
protected static boolean	isASCII(java.io.File file) Based on file extension, determine if file is binary or text(ascii).
protected static boolean	logIn(java.lang.String user, java.lang.String password, java.lang.String host) Log in to the FTP server.
static void	main(java.lang.String[] args) Main entry point from the command line.
protected static void	processDir(java.lang.String relativeDir) Process a directory.
protected static void	processFile(java.lang.String relativeDir, org.apache.commons.net.ftp.FTPFile ftpFile) Process a directory.
protected static java.lang.String	prompt(java.lang.String promptStr) Prompt the user and get the user's response.

Methods inherited from class java.lang.Object

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

Field Detail

cvFTP

protected static org.apache.commons.net.ftp.FTPClient cvFTP

FTP client for interaction with the FTP server

cvFTPBaseDir

protected static java.lang.String cvFTPBaseDir

Base (starting) directory of the FTP site containing "master" files

cvAppBaseDir

protected static java.lang.String cvAppBaseDir

Deployed application base directory (in local file system)

dateFormatter

protected static java.text.SimpleDateFormat dateFormatter

Format timestamps for readability

cvConfig

protected static java.util.Properties cvConfig

Configuration properties loaded from AppUpdater.properties

cvExclude

protected static java.util.ArrayList<java.lang.String> cvExclude

Collection of excluded files/directories as specified in the properties file

FILE_SEP

public static final java.lang.String FILE_SEP

Constant to hold the directory separator character of the local machine.

cvPrompt

public static boolean cvPrompt

Flag determines if user will be prompted for each copy operation.

Constructor Detail

AppUpdater

public AppUpdater()

Method Detail

main

public static void main(java.lang.String[] args)

Main entry point from the command line.

Parameters:

args - (String[]) Command line arguments. Ignored.

processDir

protected static void processDir(java.lang.String relativeDir)
                          throws java.lang.Exception

Process a directory. If the directory has been excluded, it will be bypassed. Otherwise, the list of files and directories in this directory are listed and processed based on type.

Parameters:

relativeDir - (String) Relative (from the base) directory to process.

Throws:

java.lang.Exception

processFile

protected static void processFile(java.lang.String relativeDir,
                                  org.apache.commons.net.ftp.FTPFile ftpFile)
                           throws java.lang.Exception

Process a directory. Checks if file has been excluded and bypasses it if so. Otherwise checks for existance of the file in the local file system. If exists, checks to see if master(ftp) copy of the file is newer. If file doesn't exist or master is newer, then this might need to be downloaded from the FTP server and placed in the local file system.

Parameters:

relativeDir - (String) Relative (from the base) directory to process.

ftpFile - (FTPFile) File information from the FTP server.

Throws:

java.lang.Exception

download

protected static void download(org.apache.commons.net.ftp.FTPFile ftpFile,
                               java.io.File localFile)
                        throws java.lang.Exception

Download a file from the FTP server after confirming action by prompting the user. Timestamp on the new local copy of the file will be set to the same as the FTP file.

Parameters:

ftpFile - (FTPFile) File information from the FTP server.

localFile - (File) The destination local file.

Throws:

java.lang.Exception

isASCII

protected static boolean isASCII(java.io.File file)

Based on file extension, determine if file is binary or text(ascii).

Parameters:

file - (File) The file.

Returns:

boolean - true if the file is a text based type.

logIn

protected static boolean logIn(java.lang.String user,
                               java.lang.String password,
                               java.lang.String host)

Log in to the FTP server.

Parameters:

user - (String) User id.

password - (String) Password.

host - (String) Host name of the FTP server.

Returns:

boolean - true If success.

disconnect

protected static void disconnect()

Log out and disconnect from the FTP server.

prompt

protected static java.lang.String prompt(java.lang.String promptStr)

Prompt the user and get the user's response.

Parameters:

promptStr - (String) The prompt.

Returns:

String - The user's response entered on the command line.

checkPath

protected static boolean checkPath(java.io.File chkFile)

Check the entire path of the given file and create needed parent directories.

Parameters:

chkFile - (File) File whose parent directories to confirm.

Returns:

boolean - Success or failure flag.