Integration and Interoperability Facilities Framework: Client Libraries

Client Libraries

The CL layer of the Integration and Interoperability Framework focuses on the design, implementation, and management of client libraries, i.e. system components that mediate access to system services from within client Java runtimes.

In particular, the layer defines:

• a design model that codifies approaches to design issues which are common to all client libraries;
• an implementation framework that provides the support required to implement client libraries which comply with the design model;
• a management model that identifies technologies and best practices for client library management, including testing, building, and distribution;

Design Model

The design model for client libraries identifies a core set of capabilities that all libraries are required to offer, regardless of specific service semantics and client-side technology stacks. The model defines also common solutions to design issues that recur across their APIs, where the solutions are based on best practices and are motivated by goals of simplicity, testability, evolvability and standards compliance. Topics that fall within the scope of model include:

• the local model of service endpoints;
• the discovery of service endpoints;
• the fault-tolerant binding to service endpoint replicas;
• the caching of service endpoints addresses across interactions;
• the classification, modelling, and handling of interaction failures;
• the handling of call scope and client credentials;
• the design of asynchronous interactions, including interactions based on polling, notifications, and data streams;

Read more about the design model for client libraries here.

Implementation Framework

The design model for client libraries identifies capabilities and patterns common to all libraries. However, it does not specify how libraries provide those capabilities or implement those patterns, nor does it define the low-level details of their interfaces.

The client library framework is a set of components that support the development of client libraries that comply with the model. Through code sharing, the framework reduces development costs and ensures the consistency and correctness of library implementations.

Learn how to use the client library framework here.

Management Model

Moving beyond design and implementation issues, the management model for client libraries focuses on the overall management of client libraries as system components. In particular, the model identifies best practices and/or tools in the following areas:

• the boundary of client library components, including their relationship to service components and, where applicable, service stubs library components;
• the building of client libraries, including interactive builds and continuous integration builds;
• the profiling of client libraries as system components;
• the packaging of client libraries for distribution purposes;
• the testing of client libraries, including unit testing and integration testing;

Read more about the management model for client libraries here.