Refactored the name of the JAR file.

This commit is contained in:
Keith Armstrong 2025-01-01 16:53:34 -05:00
parent 5286d0b577
commit 9b3cdafc98

View File

@ -1,8 +1,8 @@
# callSoap
# soapClient
## What is callSoap?
## What is soapClient?
callSoap allows you to send data to a SOAP service using an XML template file and an input CSV file. The program takes a configuration file which defines different aspects of the program including:
soapClient.jar allows you to send data to a SOAP service using an XML template file and an input CSV file. The program takes a configuration file which defines different aspects of the program including:
<ul>
<li>SOAP Service URL</li>
@ -16,21 +16,21 @@ callSoap allows you to send data to a SOAP service using an XML template file an
## Command line parameters
### --key
This is the <b>16 character length</b> key which is used to encrypt the password that is stored in the configuration file.
This is the key (must be <b>16 characters</b>) which is used to encrypt the password that is stored in the configuration file.
### --encrypt
This is the value to encrypt using the encryption key. You need to pass both <i>--key</i> and <i>--encrypt</i> in order to get a correct result.
### --props
This is the location of the properties file to be consumed by the program.
### --debug
This is a true / false flag which specifies if the debug information is displayed on the screen. The debug information is <b>always</b> written to the <i>debug.log</i> file.
This is a true/false flag which specifies if the debug information is displayed on the screen. The debug information is <b>always</b> written to the <i>debug.log</i> file.
## Helper scripts
### linux_runner.sh
The bash script listed below can be used to run the program.
### linux_verify.sh
The bash script shown below can be used to verify the contents of the CSV input file.
```bash
#!/bin/bash
@ -38,8 +38,8 @@ The bash script listed below can be used to run the program.
java -cp lib/commons-codec-1.17.1.jar:lib/commons-csv-1.12.0.jar:lib/commons-io-2.18.0.jar:lib/jcommander-1.82.jar:lib/soapClient.jar com.belkast.soap.userVerify
```
### linux_verify.sh
The bash script shown below can be used to verify the contents of the CSV input file.
### linux_runner.sh
The bash script shown below can be used to run the program.
```bash
#!/bin/bash
@ -49,7 +49,7 @@ java -cp lib/commons-codec-1.17.1.jar:lib/commons-csv-1.12.0.jar:lib/commons-io-
## Program components
Do not forget to include the following four JAR files as dependencies when building the program.
Do not forget to include the following four JAR files as dependencies when building the soapClient.JAR.
I use IDEA IntelliJ Community Ediiton when writing JAVA code.