...
This page explains how the code is tied together, what the files are all about and so on.
The code
Root
| Source file | Description | |
|---|---|---|
| Config.json | This is the json file that contains the configuration that is used throughout the application. | |
| ips.txt | File that contains a list of ips that was used in the early stages of development | |
| IService1.cs | Public Interfae for the service. This defines what methods clients can see and invoke. | |
| Service1.svc | The endpoint svc file, this gives teh binding at the client end the correct information for consuming the WCF service. | |
| Web.Config | The configuration of the binding and communication protocols. (VERY DELICATE, DONT TOUCH UNLESS YOU ARE 100% SURE WQHAT YOU ARE DOING) |
Core
Containing ccore functionality.
| Source file | Description | |
|---|---|---|
| Engine.cs | This is the main file for controlling the core functionality in receiving, validating and sending procedure. | |
| Entities/MessageDTO | DataTransferObject that is used for sending data to the integration api |
Global
Containing logic and properties that should be available everywhere in the application.
The classes are all static for easier access.
| Source file | Description | |
|---|---|---|
| ApiExceptionHelper | The functionality for checking and throwing exceptions to the client is handled in here. | |
| ClassHelper | Convenient methods for class information | |
| CredentialsHelper | Creds worker | |
| InvokerHelper | Information from the invoker | |
| JsonHelper | Deserializing json | |
| ValidationHelper | Validate message data | |
| XmlHelper | When xml logging is on, this converts the bytearray to xml readable string. | |
| FileLog | Logging to a file. This class should not be invoked directly, use the Log.cs file instead. | |
| Log | The main entry for logging in the application, this class handles the rest. | |
| TraceLog | To be deleted | |
| XmlLog | Logging the xml message if set in config | |
| Config | The extracted configuration values from the config.json file is stored in here after the service is started. | |
| Enums | All Enums used in the application are located in here along with convenient methods for converting value to int and the other way as well. |
Outgoing
Classes for the communication to the integration api.
| Source file | Description | |
|---|---|---|
| ApiCom | Class for handeling the input from engine.cs and sending to the integration api | |
| ApiComBase | Base class for the underlying functionality in sending to the api |
= Will be deleted as they are no longer needed.
xx


