XCA Client - Development Guide
- Luis Pinto (Unlicensed)
- Marcelo Fonseca
Content of the Protocol Terminators
XCA CLIENT - DEVELOPMENT GUIDE
This page presents a development guide for the XCA Client 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.
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 XCA Component, highlighted as blue, in the previous picture.
The next diagram shows a more closer and isolated look over the XCA Component and all the components that it uses.
XCA Client Simple Class Diagram
(Click the picture to enlarge)
This diagram illustrates the three main classes of the XCA Client project.
The XcaIniGateway represents the entry point for this component and it contains the following operation(s):
| Operation Name | Description |
|---|---|
| crossGatewayQuery | Allows the Query of documents and represents the XCA IHE Profile Cross Gateway Query transaction [ITI-38], in a higher, abstract level. |
| crossGatewayRetrieve | Allows the Retrieval of documents and represents the XCA IHE Profile Cross Gateway Retrieve transaction [ITI-39], in a higher, abstract level. |
The RespondingGateway_ServiceStub contains the same XCA operations, but now at a lower level:
| Operation Name | Description |
|---|---|
| respondingGateway_CrossGatewayQuery | Also represents the XCA IHE Profile Cross Gateway Query transaction [ITI-38], but this time at a lower level, directly managing IHE defined objects and more closely related with the communication stack. |
| respondingGateway_CrossGatewayRetrieve | Also represents the XCA IHE Profile Cross Gateway Retrieve transaction [ITI-39], but this time at a lower level, directly managing IHE defined objects and more closely related with the communication stack. |
You can find more extensive and complete information about the XCA Client classes and their operations in the JavaDoc, available bellow.
JAVADOC
You can find a first version of the JavaDoc in the following file list:
REFERENCES
WP3.4 Deliverable D3.4.2 - Common Components Specification v2.2
IHE International: IHE IT Infrastructure (ITI) Technical Framework. Volume 1: Integration Profiles. August 2011.