Client Connector - Development Guide
- Luis Pinto (Unlicensed)
- Licinio Kustra Mano
- Steen Manniche
- Marcelo Fonseca
CLIENT CONNECTOR (CC) - DEVELOPMENT GUIDE
This page presents a development guide for the Client Connector Component.
The main purpose is to help the developers understand the way it interacts with the other components, so that it could be better integrated in more complex solutions or to act as a jump start to new development members.
If you are trying to find documentations about usage and install, please see: NCP-B - Integration Guide
DIAGRAMS
General Diagram of Components
(Click the picture to enlarge)
This is a global diagram of components for the B side of the OpenNCP. There we can see all the functional components and a high level view of the way they interact with each other.
In this particular situation we should focus in the main blocks of the Protocol Terminators project, specially the Client Connector portion, as you can see in detail in the following image.
The Client Connector component makes use of the three projects that represents the XCPD, XCA and XDR Client.
They all gather the necessary mechanisms to communicate with the NCP-A side, using the IHE Profiles.
Client Connector Simple Class Diagram
(Click the picture to enlarge)
The above picture, represents a simple class diagram for the Client Connector , containing all the main classes responsible for the principal operations.
In Client Connector, the class that gathers all the operations, that allow the communication with the portal, is the ClientConnectorServiceSkeleton, that you can see in more detail in the next picture.
There, we can find the following operations:
| Operation Name | Description |
|---|---|
| queryPatient | This operation encapsulates all the necessary logic to perform a query for patients. |
| queryDocuments | Performs a query for documents. |
| retrieveDocument | Retrieves a specific document. |
| submitDocument | Submits a given document. |
| sayHello | Test method that greets with an "Hello" message. |
As said before, the ClientConnectorServiceSkeleton class, and the group of operations, represents the defined API for the communication with the Portal and other systems, using Web Services, over AXIS.
The epSOS defined operations are represented by the four last classes in the global diagram and briefly explained in the bellow table.
| Class Name | Description |
|---|---|
| Identification Service | Represents the epSOS IdentificationService and the findIdentityByTreats() operation, providing a way to obtain a shared patient identifier. |
| Patient Service | Represents the epSOS PatientService and the list() operation, providing ways to obtain the patient summary of the identified patient. |
| Dispensation Service | Represents the epSOS DispensationService and the discard(), initialize() operations, related with the eDispensation processes. |
| Consent Service | Represents the epSOS ConsentService and the discard(), put() operations, related with the Consent processes. |
Each of this class encapsulates the way the Protocol Terminators projects (XCPD, XCA and XDR, represented in the component diagram) are used.
Patient Query Interaction Diagram
Documentation
JavaDoc
JavaDoc for this project can be accessed in 3 different ways:
- you can read the source code
- you can get it from zip: cc.zip. Last update 2012-09-11.
- Or you can view it in a browser after deploy this project. E.g. http://localhost:8080/epsos-client-connector/javadoc/
Files
Web service WSDL
Service XSD