AGTEK R & D Wiki

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== AgtekNet Repository Layout ======
The AgtekNet repository contains the java source code, documentation and build and distribution scripts for all the java based Access server and client applications. The repository is stored in the subversion server running on w2kserver2, and can be checked out with the following command:

  svn checkout https://w3kserver2.agtek.com:8443/svn/net/trunk/AgtekNet

The directory "AgtekNet" is the root directory. All build and distribution scripts are based on Apache Ant. The entire suite of applications can be built by executing the following ant command in the AgtekNet directory:

  ant dist

===== Repository Layout =====
The AgtkeNet repository has the following directory structure:

  AgtekNet/
    apps/
      access/
      adminclient/
      adminserver/
      gpssim/
      haulsim/
      storage/
      support/
      time/
      uploader/
    cert/
    cpp/
    dist/
    docs/
    packages/
    protobuf/
    protoc/
      linux/
      win32/
    src/
    test/

===== Directory Descriptions =====

==== apps ====
The apps directory contains one sub-directory for each executable application, client or server.

==== apps/access ====
The apps/access directory contains the ant build script and resources for the AGTEK Access client application.

==== apps/adminclient ====
The apps/adminclient directory contains the web start java application for managing the old C-based Trackwork Server. The adminclient application communicates with an instance of the adminserver.\\
**This application will not be needed once support for the Trackwork Server is discontinued.**

==== apps/adminserver ====
The apps/adminserver directory contains the java server that provides an admin API for managing the old C-based Trackwork Server. This server is what the adminclient communicates with.\\
**This application will not be needed once support for the Trackwork Server is discontinued.**

==== apps/gpssim ====
The apps/gpssim directory contains the java web start based GPS simulator application used to load test both the old Trackwork Server and the new Access Server. The simulator communicates to both servers using the old TSMLib API.

==== apps/haulsim ====
The apps/haulsim directory contains the java web start based haul simulator application. The haul simulator application can be used to generate simulated haul paths for any TMM or GRay device. The haul simulator is compatible with both the old Trackwork Server and the new Access Server and communicates using the old TSMLib API.

==== apps/storage ====
The apps/storage directory contains the build script and all the resources for the Access Server. 

==== apps/support ====
The apps/support directory contains the build script and resources for the standalone java based Access Support client. The support client is used to administrate the Access Server.

==== apps/uploader ====
The apps/uploader directory contains the build script and resources for all the variations of the standalone and web start based file uploader applications. This includes the support uploader web start application and the personalized salesman uploader applications.

==== cert ====
The cert directory contains the build script for creating the certificate used to sign the web start based java applications.

==== cpp ====
The cpp directory contains the C++ protobuf classes generated each time the protoc compiler is run. When the protobuf message definitions are changed these generated classes must be copied to the AccessLib API stored in Visual Source Safe.

==== dist ====
The dist directory is the target directory for all the distributions of the applications in the apps directory.

==== docs ====
The docs directory contains the "master" copy of all the documentation related to the various applications in the apps directory including the design docs for the Access Server.

==== packages ====
The packages directory contains all the third party java packages required by the applications in the apps directory.

==== protobuf ====
The protobuf directory contains the protobuf based messages used by the AccessLib API to communicate between the Access Server and both java and C++ applications.

==== protoc/linux ====
The protoc/linux directory contains a copy of the protobuf compiler compiled to run on either Red Hat or Fedora.

==== protoc/win32 ====
The protoc/win32 directory contains a copy of the protobuf compiler compiled to run under Windows.

==== src ====
The src directory contains all the java code for **ALL** the applications in the apps directory. The reason all the code is in one tree is encourage code sharing between the applications.

==== test ====
The test directory contains the java junit test code for the server and client applications.
AGTEK R & D Wiki

User Tools

Site Tools

Page Tools
