Show TOC

Background documentationREST Interfaces and Classes Locate this document in the navigation structure


This section gives an overview of the interfaces and classes which (together with some additional DDIC elements) build the REST Library. It is important that the user of the REST library knows what classes are available and how they are used.

To ease reading, the term interfaces and classes will be referred to simply as classes in this section. So whenever the term classes is used, it may include interfaces, too.

The Classes of the REST Library can be grouped by their task into five groups:

  • Service registration and routing

    Classes required to register a REST application at the Internet Connection Framework (ICF) and to define resource paths to the applications resources as well as a basis resource class itself.

  • REST request and response

    Classes to access the HTTP request and response data. This includes header fields, URI parts, URI attributes and the HTTP content.

  • REST context

    Context which is available in most REST library classes to set and get various data. Used for example to pass flexible data over methods calls whose signature is fixed.

  • REST HTTP content processing

    Classes focused on serialization and deserialization of the HTTP body data. This includes parsing application/x-www-form-urlencoded data, multipart/mixed data and other formats.

  • Classes for Client implementation

    Classes designed for consuming REST based data services

In the following class diagram all five groups with their primary classes and their relations are shown. Classes marked with a green rectangle are most important because the creation of a REST application requires at least to inherit from these or use these classes.

This graphic is explained in the accompanying text.

Interfaces and Classes