ADUCID 4.x

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== Java SDK Basic Architecture ======

This document describes the ADUCID® integration library. The library simplifies communication from the Java Runtime Environment (1.5 and higher), by using the R4 interface. The library is the alternative to direct access to the R4 interface for calling web services. This API is used by other adapters (, e.g. the adapter for the Tomcat web server, adapter for spring security).

It is highly recommended to work with Client API or/and Web Platform only as the high level APIs. Abstract Part and R4 Client parts are for ADUCID® masters only.

===== Prerequisites =====

When reading this document, the following basic knowledge is assumed:

  * [[developers:start|ADUCID Development]]
  * [[concepts:01-architecture|ADUCID architecture]]

Knowledge of web technologies, integration of web applications and Java programming language is also assumed.

===== SDK Architecture =====

This SDK is supplied as a standard Java library, which can be used by the application as an indirection layer when communicating with the R4 AIM interface.

{{:developers:sdk-integration.png?nolink&404x435}}

This layer has the following functions:

  * It separates the application from a specific technology used for calling web services
  * It provides reverse compatibility with future partial modifications of the R4 interface

{{:developers:sdk-architecture.png?nolink&419x490}}

SDK has following parts:

  * [[developers:integration:sdk-java#abstract_part|Abstract Part]] – contains the application code shared by all SDK implementations without technological dependency on the R4 communication solution
  * [[developers:integration:sdk-java:r4|R4 Client]] – contains implementation of the abstract part, including fully functional R4 communication solution based on HTTP URL Connection and DOM technologies
  * [[developers:integration:sdk-java:client-api|Java SDK Client API]] – client itself, methods to be used by ADUCID® integrators
  * [[developers:integration:sdk-java:web-platfrorm|Java SDK Web Platform]] – platform, that can be used by web application developers to integrate ADUCID®, it is a bridge between HTTP web interface and direct Client API method calls

See chapters below for details.

===== Abstract Part =====

The architecture of abstract part is provided in the picture below:

{{:developers:sdk-abstract.png?nolink&801x431}}

Integrators may create their own implementation of AducidMessageSender, which uses a different technology for calling the AIM server web services. In some cases, integrators may also create their own descendant of the AbstractAducidClient abstract class. It is assumed that the portfolio of available communication methods for RESTful web services or XML/http will be expanded.

==== Use of ADUCID® Java SDK Abstract Part ====

To work with abstract part of Java SDK, include api-[version].jar Java library in your application classpath.
ADUCID 4.x

User Tools

Site Tools

Page Tools
