System Architecture

System Architecture of the Functional Items Management module.

Module Design

This document provides a brief description of the main components of the FIM Module. Below is the diagram of the FIM architecture.

The JavaScript Library and the Remote Handler allow the control of the FIM module through JSON-RPC and RESTful Web Services.

The Functional Item represents a set of functionalities (e.g. for devices, users, services, etc.). Each Functional Item Object is registered as an OSGi service and must implement the Functional Item interface and also object class interface, which can inherit other interfaces. The Functional Item interface is used for obtaining the Functional Item UID, the interface version, the interfaces implemented by the Functional Item, supported properties and operations and the metadata for each property and operation.

It has to be registered as OSGi service with all Functional Item interfaces:

• The main FunctionalItem interface
• All inherited interfaces
• The FunctionalItem class

Each Functional Item is defined by its:

• Unique ID
• Main FunctionalItem interface
• Set of Properties with getter/setter methods and events on property change
• Set of Operations that can be invoked
• Meta information for each property and operation (types, description, allowed values, etc.)
• Set of attributes, used for filtering and permission checks

FIM Properties

Each Functional Item (FI) has the following attributes:

• UID – Unique Identifier number.
• NAME – user friendly name of the FI (e.g. Alarm, Binary Switch, etc.).
• TAGS – a set of tags that may represent user friendly names of groups that the FI belongs to (e.g. Devices, Binary Switches, Alarms).

The properties of a Functional Item can have different kind of access:

• read ("R") – the property is readable. The object class MUST provide a getter method for the readable property, that returns the value of the property.
• write ("W") – the property is writable. The object class MUST provide a setter method for the writable property, that can be used to set a new value of the property.
• event ("E") – the property is eventable. Events are sent upon changes of the property value.

Functional Item Factory

Functional Item Factory may be created for each Functional Item. The Factory represents an interface that holds a set of predefined attributes (a template) and therefore allows easy creation of supported Functional Item Objects.