org.finra.herd.tools.common.databridge

Class DataBridgeApp

java.lang.Object

org.finra.herd.tools.common.databridge.DataBridgeApp

Direct Known Subclasses:

DownloaderApp, UploaderApp

public abstract class DataBridgeApp
extends Object

A base class for the uploader and downloader applications. This class is abstract since it is not an actual application that has a main method, but rather provides common base functionality that should be used by an extending class.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DataBridgeApp.ReturnValue The list of possible return values for the application.

Field Summary

Fields

Modifier and Type	Field and Description
static String	BUILD_INFO_STRING_FORMAT
protected Boolean	disableHostnameVerification
protected org.apache.commons.cli.Option	disableHostnameVerificationOpt
protected org.apache.commons.cli.Option	dmRegServerHostOpt
protected org.apache.commons.cli.Option	dmRegServerPortOpt
protected org.apache.commons.cli.Option	enableEnvVariablesOpt
protected org.apache.commons.cli.Option	helpOpt
protected org.apache.commons.cli.Option	httpProxyHostOpt
protected Integer	httpProxyPort
protected org.apache.commons.cli.Option	httpProxyPortOpt
protected org.apache.commons.cli.Option	localPathOpt
protected org.apache.commons.cli.Option	manifestPathOpt
protected Integer	maxThreads
protected org.apache.commons.cli.Option	maxThreadsOpt
protected org.apache.commons.cli.Option	passwordOpt
protected String	regServerHost
protected org.apache.commons.cli.Option	regServerHostOpt
protected Integer	regServerPort
protected org.apache.commons.cli.Option	regServerPortOpt
protected org.apache.commons.cli.Option	s3AccessKeyOpt
protected org.apache.commons.cli.Option	s3EndpointOpt
protected org.apache.commons.cli.Option	s3SecretKeyOpt
protected org.apache.commons.cli.Option	socketTimeoutOpt
protected org.apache.commons.cli.Option	sslOpt
protected Boolean	trustSelfSignedCertificate
protected org.apache.commons.cli.Option	trustSelfSignedCertificateOpt
protected org.apache.commons.cli.Option	usernameOpt
protected Boolean	useSsl
protected org.apache.commons.cli.Option	versionOpt

Constructor Summary

Constructors

Constructor and Description
DataBridgeApp()

Method Summary

Modifier and Type	Method and Description
protected org.springframework.context.ApplicationContext	createApplicationContext() Creates and returns the Spring application context.
abstract ArgumentParser	getArgumentParser() Gets the application argument parser.
abstract DataBridgeApp.ReturnValue	go(String[] args) Runs the application.
protected DataBridgeApp.ReturnValue	parseCommandLineArguments(String[] args, org.springframework.context.ApplicationContext applicationContext) Parses the command line arguments using the specified argument parser.

Methods inherited from class java.lang.Object

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

Field Detail

BUILD_INFO_STRING_FORMAT

public static final String BUILD_INFO_STRING_FORMAT

See Also:

Constant Field Values

s3AccessKeyOpt

protected org.apache.commons.cli.Option s3AccessKeyOpt

s3SecretKeyOpt

protected org.apache.commons.cli.Option s3SecretKeyOpt

s3EndpointOpt

protected org.apache.commons.cli.Option s3EndpointOpt

localPathOpt

protected org.apache.commons.cli.Option localPathOpt

manifestPathOpt

protected org.apache.commons.cli.Option manifestPathOpt

regServerHostOpt

protected org.apache.commons.cli.Option regServerHostOpt

regServerPortOpt

protected org.apache.commons.cli.Option regServerPortOpt

dmRegServerHostOpt

protected org.apache.commons.cli.Option dmRegServerHostOpt

dmRegServerPortOpt

protected org.apache.commons.cli.Option dmRegServerPortOpt

sslOpt

protected org.apache.commons.cli.Option sslOpt

usernameOpt

protected org.apache.commons.cli.Option usernameOpt

passwordOpt

protected org.apache.commons.cli.Option passwordOpt

enableEnvVariablesOpt

protected org.apache.commons.cli.Option enableEnvVariablesOpt

trustSelfSignedCertificateOpt

protected org.apache.commons.cli.Option trustSelfSignedCertificateOpt

disableHostnameVerificationOpt

protected org.apache.commons.cli.Option disableHostnameVerificationOpt

helpOpt

protected org.apache.commons.cli.Option helpOpt

versionOpt

protected org.apache.commons.cli.Option versionOpt

httpProxyHostOpt

protected org.apache.commons.cli.Option httpProxyHostOpt

httpProxyPortOpt

protected org.apache.commons.cli.Option httpProxyPortOpt

maxThreadsOpt

protected org.apache.commons.cli.Option maxThreadsOpt

socketTimeoutOpt

protected org.apache.commons.cli.Option socketTimeoutOpt

useSsl

protected Boolean useSsl

trustSelfSignedCertificate

protected Boolean trustSelfSignedCertificate

disableHostnameVerification

protected Boolean disableHostnameVerification

regServerPort

protected Integer regServerPort

httpProxyPort

protected Integer httpProxyPort

maxThreads

protected Integer maxThreads

regServerHost

protected String regServerHost

Constructor Detail

DataBridgeApp

public DataBridgeApp()

Method Detail

getArgumentParser

public abstract ArgumentParser getArgumentParser()

Gets the application argument parser.

Returns:

the argument parser.

go

public abstract DataBridgeApp.ReturnValue go(String[] args)
                                      throws Exception

Runs the application. This is the main entry into the application class itself and is typically called from a main method.

Parameters:

args - the command line arguments.

Returns:

the application return value.

Throws:

Exception - if any problems were encountered.

parseCommandLineArguments

protected DataBridgeApp.ReturnValue parseCommandLineArguments(String[] args,
                                                              org.springframework.context.ApplicationContext applicationContext)

Parses the command line arguments using the specified argument parser. Common data bridge options will be initialized and added to the argument parser in this method, but any application specific arguments should be added to the argument parser prior to calling this method. Ensure the argParser was set in this class prior to calling this method.

Parameters:

args - the command line arguments.

applicationContext - the Spring application context.

Returns:

the return value if the application should exit or null if the application can continue.

createApplicationContext

protected org.springframework.context.ApplicationContext createApplicationContext()

Creates and returns the Spring application context.

Returns:

the application context