[XBUP]XBUP - Support: Catalog Service

Preamble

This document is part of the eXtensible Binary Universal Protocol project documentation. It contains ...

Up one level

Content

1 Catalog Service
  1.1 Use Cases
2 Catalog Service Implementation
  2.1 Implementation Using Java EE5
    2.1.1 Used Database Structure
  2.2 Implementation in PHP
    2.2.1 Used Database Structure
    2.2.2 Service Interface

1 Catalog Service

In this document, you can learn about the implementation of catalog services. The goal here is to enable centralized updating of local catalogs of client applications.

Catalog Service provides blocks specifications, groups of blocks and XBUP protocol formats (currently level 1). It keeps information about the owner and allows editing of the items and structures. Client applications will have got available local catalog, and it might update it using the Web service as needed. It can then validate the input documents using this catalog and eventually show them as text format.

The goal here is to design and implement catalog of block types and categories:

The structure of the catalog:

Basic schema:

Schema 1

Detailed shema of service:

Schema 2

1.1 Use Cases

Web service will be used for the following cases (Use Cases):

Client Application:

Web Service:

2 Catalog Service Implementation

This section contains a description of the implementation of catalog service. For testing purposes several implementations was created according to the availability of the necessary resources.

2.1 Implementation Using Java EE5

The service was implemented as a team project to the PA165 course in Faculty of Informatics, Masaryk University. The solution was created using Java EE5 with EJB and Java Persistence API in the development environment NetBeans 5.5 and with Visual Web Pack 5.5 extension. Application was running on Sun Java System Application Server 9.0 (GlassFish). Implementation is available for download as part of WR-13 version.

2.1.1 Used Database Structure

Catalog used in the implementation of this catalog service had the following structure:

Catalog ERD diagram

2.2 Implementation in PHP

Due to unavailability of the server where it would be possible to get the necessary web containers for Java version an alternative version in PHP was created. It is only a very simple alternative that is available on the website of the project.

2.2.1 Used Database Structure

Products used in the implementation of catalog service had the following structure:

Catalog ERD diagram

2.2.2 Service Interface

The service is used for remote calling functions over HTTP protocol. Parameters and result are passed in the release WR-14 as follows:

It is called a file wr14-0.php that accepts following parameters:

As a result a text file is returned, where sequence of variables names and values separated by the end of lines is returned.

A description of single functions follows (according to parameter op):


Homepage: http://xbup.sf.net
License: GNU Free Documentation License (FDL)
Latest update: 2008-10-28