com.aspc.remote.application

Class AppCmdLine

java.lang.Object

com.aspc.remote.application.AppCmdLine

Direct Known Subclasses:

App, App, App, AppEatMemory, AppLoad, AppMoveIMAP, AppRestSession, BackupDatabase, BuildDatabases, CheckDuplicateTests, CheckNPEApp, CompareRacApp, CompareServerApp, CompareServerApp, DBaseCmdLine, DeduplicateSelectApp, EchoRequestApp, ExtDBSyncApp, ExtractApp, FetchAll, FileSyncApp, FileSyncRunOnce, InflateApp, MakeBM, MonitorApp, PerformanceCheck, SampleSyncApp, SampleSyncApp, ScanGCLog, SyncInvoices

public abstract class AppCmdLine
extends java.lang.Object

AppCmdLine is the standard command line. THREAD MODE: SINGLE-THREADED command line application

Since:

23 June 1997

Author:

Nigel Leck

Field Summary

Fields

Modifier and Type	Field and Description
protected int	exitStatus The value to return to the OS
static java.lang.String	OPTION_DEBUG command line option to turn on debugging
static java.lang.String	OPTION_HELP command line option help
static java.lang.String	OPTION_HOME command line option home
static java.lang.String	OPTION_REMOTE_URL command line option to set the remote URL
static java.lang.String	PROPERTY_REMOTE_URL the system property for the remote URL

Constructor Summary

Constructors

Constructor and Description
AppCmdLine()

Method Summary

Modifier and Type	Method and Description
protected void	abort(java.lang.String message, java.lang.Exception exp) abort the program
protected void	abortShowHelp(java.lang.Exception e) abort showing the help
protected void	addExtraOptions(org.apache.commons.cli.Options options) add extra command line options
void	execute(java.lang.String[] args) execute the program
void	getExtraPars(java.util.Properties p) Deprecated. NO LONGER USED
void	handleArgs(java.util.Properties p) Deprecated. NO LONGER USED
void	handleCommandLine(org.apache.commons.cli.CommandLine line) handle the command line args
void	init() init the program
abstract void	process() process ( extend this method)
static void	setDefaults() set up the defaults
void	setExitFlg(boolean flag) set exit or not flag

Methods inherited from class java.lang.Object

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

Field Detail

OPTION_HELP

public static final java.lang.String OPTION_HELP

command line option help

See Also:

Constant Field Values

OPTION_HOME

public static final java.lang.String OPTION_HOME

command line option home

See Also:

Constant Field Values

OPTION_REMOTE_URL

public static final java.lang.String OPTION_REMOTE_URL

command line option to set the remote URL

See Also:

Constant Field Values

OPTION_DEBUG

public static final java.lang.String OPTION_DEBUG

command line option to turn on debugging

See Also:

Constant Field Values

PROPERTY_REMOTE_URL

public static final java.lang.String PROPERTY_REMOTE_URL

the system property for the remote URL

See Also:

Constant Field Values

exitStatus

protected int exitStatus

The value to return to the OS

Constructor Detail

AppCmdLine

public AppCmdLine()

Method Detail

execute

public void execute(@Nonnull
                    java.lang.String[] args)

execute the program

Parameters:

args - the args

setExitFlg

public void setExitFlg(boolean flag)

set exit or not flag

Parameters:

flag - the flag

abort

protected void abort(@Nonnull
                     java.lang.String message,
                     @Nullable
                     java.lang.Exception exp)

abort the program

Parameters:

message - the message to show

exp - the exception

abortShowHelp

protected void abortShowHelp(@Nullable
                             java.lang.Exception e)

abort showing the help

Parameters:

e -

getExtraPars

@Deprecated
public void getExtraPars(@Nonnull
                                     java.util.Properties p)

Deprecated. NO LONGER USED

do not use this method

Parameters:

p - the parameters

addExtraOptions

@OverridingMethodsMustInvokeSuper
protected void addExtraOptions(@Nonnull
                                                                 org.apache.commons.cli.Options options)

add extra command line options

Parameters:

options - the options

init

@OverridingMethodsMustInvokeSuper
public void init()
                                            throws java.lang.Exception

init the program

Throws:

java.lang.Exception - a serious problem

process

public abstract void process()
                      throws java.lang.Exception

process ( extend this method)

Throws:

java.lang.Exception - a serious problem

setDefaults

public static void setDefaults()

set up the defaults

handleArgs

@Deprecated
public void handleArgs(@Nonnull
                                   java.util.Properties p)
                            throws java.lang.Exception

Deprecated. NO LONGER USED

Do not use this method

Parameters:

p - the properties

Throws:

java.lang.Exception - a serious problem

handleCommandLine

@OverridingMethodsMustInvokeSuper
public void handleCommandLine(@Nonnull
                                                                org.apache.commons.cli.CommandLine line)
                                                         throws java.lang.Exception

handle the command line args

Parameters:

line - the command line

Throws:

java.lang.Exception - a serious problem