VCSMS Client

Project Setup

Integrated Development Environment (IDE)

Download and Install any Java capable IDE or text editor

• Eclipse
• VS Code | Java Docs
  • Java Extension Pack
    • Language Support for Java Extension
    • Debugger for Java

Java Development Kit (JDK)

Download and Install a Java Development Kit - version 8+ is required

• AdoptOpenJdk
• Oracle Java JDK
• RedHat Open JDK

Java Virtual Machine (JVM)

Download and Install a Java Runtime (often comes bundled with a JDK)

• Hotspot
• Open J9

Project File Structure

vcsms-client/
├── src/main/java/gov/nist/healthcare/vcsms
│   ├── domain                              # class models for domain objects
│   ├── example
│   │   └── Main.java                       # app entry point
│   ├── exception
│   ├── service                             # service methods
│   │   ├── impl                            # service method implementations
│   │   │   ├── MyNameStrategy.java
│   │   │   ├── NISTVCSMSClientImpl.java
│   │   │   ├── VCSMSClientImpl.java
│   │   │   └── VCSMSFTPClientImpl.java
│   │   ├── NISTVCSMSClient.java            # NIST Method Signatures
│   │   ├── VCSMSClient.java                # VCSMS Method Signatures
│   │   └── VSMSFTPClient.java              # FTP Method Signatures
├── pom.xml                                 # Project Object Model used by Maven to build the project
└── readme.md

Config Section

1. Create the file config.properties in the following directory src/main/java/gov/nist/healthcare/vcsms/example/ (it contains secrets so it is excluded via the `.gitignore)
2. Copy and Paste the code block below into the file and update the values with the ones you've been provided (You should have been provided values for each of the keys, but please contact your point of contact or CDC VCSMS Support Email: [email protected] for more info):

ROOT_PATH = vaccinecodeset.cdc.gov/SymedicalDistributionREST/api/distributionext/
ROOT_PATH_CCA = vaccinecodeset.cdc.gov/SymedicalDistributionREST
GROUP_MNEMONIC = ****
NODE_ID = ****
Zip_Password = ****
FTP_HOST = ftp://sftp.cdc.gov
FTP_HOST_CCA = sftp.cdc.gov
USERNAME = ****
FTP_Port = ****
PASSWORD = ****
DOWNLOAD_LOCATION = ****
RESOURCE_ID = ****

Acronyms

• VCSMS - Vaccine Code Set Management Services
• NIST - National Institute of Standards and Technology
• CDC - Centers for Disease Control and Prevention
• JDK - Java Development Kit
• JVM - Java Virtual Machine
• API - Application Programming Interface
• REST - Representational State Transfer
• FTP - File Tranfer Protocol

Additional Resources

• How to create and read config.properties file in Java