gov.va.vinci.leo

Class CommandLineClient

java.lang.Object

gov.va.vinci.leo.CommandLineClient

public class CommandLineClient
extends Object

An example UIMA AS Client that takes command line arguments for its configuration.

Constructor Summary

Constructors

Constructor and Description
CommandLineClient(File clientConfigFile, File readerConfig, File[] listenerConfigFiles) Initialize the client using groovy config files for the client, reader, and one or more listeners.
CommandLineClient(String[] args)

Method Summary

Modifier and Type	Method and Description
String	defaultClientConfig() The default client config file.
String	defaultCollectionReaderConfig() The default collection reader config file.
String[]	defaultListenerConfig() The default listener config files.
static List<org.apache.uima.aae.client.UimaAsBaseCallbackListener>	getListeners(File... configs) Parse the groovy config files, and return the listener objects that are defined in them.
static LeoCollectionReaderInterface	getReader(File config) Parse the groovy config file, and return the reader object.
static void	main(String[] args) Main method for java execution.
static void	printUsage() Print the command line usage statement to the console and exit.
void	runClient() Actual run method that configures and runs the client.
protected Client	setClientProperties(Client leoClient) Set the client properties, such as brokerURL, from a pre-loaded groovy config file.

Methods inherited from class java.lang.Object

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

Constructor Detail

CommandLineClient

public CommandLineClient(String[] args)

CommandLineClient

public CommandLineClient(File clientConfigFile,
                         File readerConfig,
                         File[] listenerConfigFiles)

Initialize the client using groovy config files for the client, reader, and one or more listeners.

Parameters:

clientConfigFile - client groovy config file.

readerConfig - reader groovy config file.

listenerConfigFiles - array of groovy config files for one or more listeners.

Method Detail

defaultClientConfig

public String defaultClientConfig()

The default client config file.

Returns:

the path to the default client config file if not overridden on the command line.

defaultCollectionReaderConfig

public String defaultCollectionReaderConfig()

The default collection reader config file.

Returns:

the path to the default collection reader config file if not overridden on the command line.

defaultListenerConfig

public String[] defaultListenerConfig()

The default listener config files.

Returns:

the path to the default listener config files if not overridden on the command line.

getListeners

public static List<org.apache.uima.aae.client.UimaAsBaseCallbackListener> getListeners(File... configs)
                                                                                throws MalformedURLException

Parse the groovy config files, and return the listener objects that are defined in them.

Parameters:

configs - the groovy config files to slurp

Returns:

the list of listeners that are defined in the groovy configs.

Throws:

MalformedURLException - if the configuration file url that was set is invalid.

getReader

public static LeoCollectionReaderInterface getReader(File config)
                                              throws MalformedURLException

Parse the groovy config file, and return the reader object. This must be a LeoCollectionReaderInterface.

Parameters:

config - the groovy config file to slurp

Returns:

the reader defined in the groovy config.

Throws:

MalformedURLException - if the configuration file url that was set is invalid.

setClientProperties

protected Client setClientProperties(Client leoClient)
                              throws MalformedURLException,
                                     NoSuchMethodException,
                                     IllegalAccessException,
                                     InvocationTargetException

Set the client properties, such as brokerURL, from a pre-loaded groovy config file.

Parameters:

leoClient - Client object to configure.

Returns:

Reference to the configured Client.

Throws:

MalformedURLException - if the configuration file url that was set is invalid.

InvocationTargetException - if the groovy config refers to objects not in the classpath.

IllegalAccessException - if there is a rights issue accessing settings from the groovy config.

NoSuchMethodException

runClient

public void runClient()

Actual run method that configures and runs the client.

main

public static void main(String[] args)
                 throws org.kohsuke.args4j.CmdLineException

Main method for java execution.

Parameters:

args - list of String arguments for the program.

Throws:

org.kohsuke.args4j.CmdLineException - if there is an error parsing the command line arguments.

printUsage

public static void printUsage()

Print the command line usage statement to the console and exit.