AdventNet TL1 API Architecture

AdventNet TL1 API provides rich set of Java classes which can be used in various functional areas in managing TL1 devices. The API classes help application developers to concentrate mainly on implementing the high-level management functionality. That is, they need not bother about the underlying communication and the TL1 message structure which are the most complex ones to implement. These tasks are carried out by the AdventNet TL1 API which helps the developers to build applications fast and reduce the time to market.

The diagram below shows the architecture of the AdventNet TL1 API. It shows the TL1 API packages as separate layers to easily understand the model. All user applications will sit on the top of these layers.

TL1 Transport Provider Package

AdventNet TL1 API is designed to be protocol-neutral accommodating transport protocols as plug-ins. This way, the core API do not perform operations specific to any particular protocol and the higher layer TL1 messages can use any transport protocol for communicating with the device. AdventNet TL1 API provides TCP as default protocol implementation.

The TL1 Transport Provider acts as a bridge between the core API and the transport protocol implementation. Essentially, the TL1 Transport Provider provides a framework for communication between the manager application and the devices. The TL1 API interacts with the Transport Provider unaware of the details of the protocol and uses the implementation of the protocol that is registered with the Transport Provider. For more information on Transport Provider, please refer to TL1 Transport package section in the Developer guide.

TL1 Communication Package

The Communication package forms the core of the product providing first level of interface to user applications for setting up communication mechanism, sending messages to the TL1 device, and getting responses. It provides useful set of methods for callback registration, monitoring device connections, timeout etc. The TL1 API also allows simultaneous communication with multiple devices. For more information on TL1 Communication API, please refer to TL1 Communication package section in the Developer guide.

Apart from the core functionality, TL1 API also provides Log APIs that helps developers to debug messages exchanged between the management application and the TL1 device. These log contain historic information of TL1 device transactions for debugging and routine auditing. These APIs offer transaction-based information logs as well as raw data logs.

TL1 Message Package

The TL1 Message package is used for creating TL1 messages that can be sent to the TL1 device using the Message API. All kinds of TL1 Messages (Input, Response, Autonomous, and Acknowledgments) can be formed using the Message API. It also provides classes to extract every information from the TL1 message. Please refer to the TL1 Message package in the Developer Guide for more details.

TL1 Parser Package

The TL1 Parser package provides a default message parser that is used by the TL1 API. This Message Parser is built as per Bellcore standards. It can parse all kinds of TL1 messages such as Input, Response, Autonomous, and Acknowledgments. You can also plug in your own parser implementation on the Session API for parsing the TL1 messages received from various TL1 devices. Please refer to the TL1 Parser package in the Developer Guide for more details.

TL1 Message Builder

The TL1 Message Builder is a graphical interface tool used to create any standard TL1 Message Definition and also the real-time data for the message definition which can be directly sent to the TL1 NEs for management purposes. These message definitions can also be used by the APIs for creating messages. These definitions allow detailed parsing of the TL1 responses and alarms. For more information, please refer to the TL1 Message Builder section under TL1 Tools.

TL1 Craft Interface

The TL1 Craft Interface is a manager-side testing tool built using the TL1 API. The Craft Interface can be used to establish multiple connections with multiple TL1 devices, to query devices, and to get responses. The tool also allows establishing connections using any transport protocol such as TCP, Telnet, Serial, or any custom protocol. You can also load the message set created through the Message Builder for sending commands. For more information, please refer to the TL1 Craft Interface section under TL1 Tools.