Top level modules
The following is a listing of the modules in the source tree, along with a short description of their contents. Similar information can be found by browsing each Maven page for each module. This is merely meant to be a quick overview. Each module reference links to its home in our SourceForge repository.
Modules containing the sstp
prefix relates to the Streamlined Sales Tax project. Similarly any module containing the mef
prefix relates to the Modernized e-File project.
The first two modules listed are not actual Maven modules, but contain important files related to the Gateway project. For most situations it is recommended that the config
directory is present for development and testing on local machines where the Gateway will be built.
- config
- Contains configuration for building the Gateway for specific states/hosts.
- extras
- This directory is also not a module and contains various resources such as the main logo, formatting tools, sample SOAP data etc.
- gateway
- Parent project, contains information inherited by all other modules, repository settings, developer info, and this website.
- gateway-client
- Client used to communicate with all Gateway web services.
- selenium
- Module to be deployed with EAR that provides application testing. Allows simulation of use-cases against portal.
- gateway-monitor
- Mozilla Firefox extention for viewing status of Gateway via ping.
- ora-utils
- Implementation of Database interface using Oracle, requires Oracle JDBC jar.
- config-manager
- A side project to allow a graphical interface for basic configuration of Gateway (Work in progress).
- doxia-sf-macros
- Doxia macros for generating site content based on Source Forge RSS feeds.
- base-server
- Contains common code for server operations.
- base-client
- Schema to generate xml classes to be used in Java for reading client configuration xml files.
- base-client-gui
- Common components used to build graphical user interface for client applications.
- base-utils
- Utility classes to assist with I/O, XML processing, and other common functionality, look here before you write any utility methods!
- base-portal
- Utilities used by portal beans and configuration classes to allow
- gateway-ear-jboss
- Builds a .ear file that deploys the Gateway through JBoss.
- gateway-har
- Builds a .har file that configures the hibernate database used by the Gateway.
- jaas-sar
- Builds a .sar file that configures the Gateway's login service.
- dbtest
- Used for testing database Connectivity.
- logger
- Servlet that enables storing and retrieving of log messages to database.
- maven-vttax-skin
- Module that configures the look of this Gateway website.
- mock-objects
- Provides "fake" or "dummy" objects needed for testing only to avoid creating a full-blown runtime environment.
- mef-base
- Common code used by MeF implementation.
- mef-client-portal
- Portal used to display MeF submission information to business users.
- mef-server-war
- Test server implementation that simulates IRS web service responses, used for client testing.
- sql-base-vt
- Base clases used for Vermont's conversion of transmission data to SQL.
- sql-server-vt
- Web service that provides transmissions as SQL entries.
- sstp-base
- Contains common classes used by SSTP implementation.
- sstp-reg-server
- Simulated registration server for testing.
- sstp-server
- Gateway SSTP webservice implementation.
- sstp-server-portal
- Gateway SSTP web portal for submission of data to state service.
- sstp-server-processor
- Used for processing SSTP transmissions upon arrival at Gateway.
- version-bump
- Command-line utility for coordinated bumping of module versions. Runs recursively to update dependencies to refer to new module versions.
- xmlbeans-maven-pom
- Contains Java class representations of Maven POM 4.0 schema elements.
