Differences

This shows you the differences between two versions of the page.

--- docs:3500:0400:0410 [2023/04/05 06:28] – [Implementing Channel’s Source and Sink] sean
+++ docs:3500:0400:0410 [2025/06/12 02:36] (current) – Rename to AwareIM aware_support3
@@ Line 3: / Line 3: @@
 ===== Implementing Channel’s Source and Sink =====
-The first step that is required to add a custom channel to //**Aware IM**// is to write the component(s) that handle communication between //**Aware IM**// and the external software system or hardware device. In order to write the code for such components it is important to understand the architectural framework that //**Aware IM**// uses to communicate with an external software system or device ("external party").
+The first step that is required to add a custom channel to //**AwareIM**// is to write the component(s) that handle communication between //**AwareIM**// and the external software system or hardware device. In order to write the code for such components it is important to understand the architectural framework that //**AwareIM**// uses to communicate with an external software system or device ("external party").
-//**Aware IM**// incorporates the ''openadaptor'' framework written by Dresdner Kleinwort Wasserstein to handle communication with external parties. This framework abstracts the process of sending messages between systems.  The source of the message is abstracted in a component called //Source// and the destination of the message is abstracted in the component called //Sink//. Thus messages are generated by Source and travel to the corresponding Sink.
+//**AwareIM**// incorporates the ''openadaptor'' framework written by Dresdner Kleinwort Wasserstein to handle communication with external parties. This framework abstracts the process of sending messages between systems.  The source of the message is abstracted in a component called //Source// and the destination of the message is abstracted in the component called //Sink//. Thus messages are generated by Source and travel to the corresponding Sink.
-If communication with the external party requires that messages be sent from //**Aware IM**// to the external party the specific Sink needs to be implemented (//**Aware IM**// framework will automatically provide the corresponding Source). If communication requires that messages be sent from the external party to //**Aware IM**// the specific Source needs to be implemented (//**Aware IM**// framework will automatically provide the corresponding Sink).
+If communication with the external party requires that messages be sent from //**AwareIM**// to the external party the specific Sink needs to be implemented (//**AwareIM**// framework will automatically provide the corresponding Source). If communication requires that messages be sent from the external party to //**AwareIM**// the specific Source needs to be implemented (//**AwareIM**// framework will automatically provide the corresponding Sink).
-Messages that float between //**Aware IM**// and external party represent arrays of DataObject’s. DataObject is the class that allows defining any number of attributes of different types and provides generic access to them - very much like the [[docs:3500:0300:0317|IEntity]] interface (in fact ''IEntity'' is a wrapper around ''DataObject''). ''DataObject'' exposes the ''[[pr_methods:getattributevalue|getAttributeValue]]'' and ''[[pr_methods:setattributevalue|setAttributeValue]]'' methods that allow access to the values of its attributes.
+Messages that float between //**AwareIM**// and external party represent arrays of DataObject’s. DataObject is the class that allows defining any number of attributes of different types and provides generic access to them - very much like the [[docs:3500:0300:0317|IEntity]] interface (in fact ''IEntity'' is a wrapper around ''DataObject''). ''DataObject'' exposes the ''[[pr_methods:getattributevalue|getAttributeValue]]'' and ''[[pr_methods:setattributevalue|setAttributeValue]]'' methods that allow access to the values of its attributes.
-//**Aware IM**// sends ''DataObjects'' of some specific structure to the external party and it expects ''DataObjects'' of this structure from the external party. As explained in the previous section this structure implies that there are only two forms of requests that can be sent between //**Aware IM**// and the external party – service requests and notifications.
+//**AwareIM**// sends ''DataObjects'' of some specific structure to the external party and it expects ''DataObjects'' of this structure from the external party. As explained in the previous section this structure implies that there are only two forms of requests that can be sent between //**AwareIM**// and the external party – service requests and notifications.
-//**Aware IM**// provides two utility classes [[docs:3500:0400:0410:0415|MessageBuilder]] and [[docs:3500:0400:0410:0414|MessageInterpreter]] that allow a programmer to easily create or read messages representing service requests and notifications without knowing too many details about the underlying structures of ''DataObjects'' and its attributes.
+//**AwareIM**// provides two utility classes [[docs:3500:0400:0410:0415|MessageBuilder]] and [[docs:3500:0400:0410:0414|MessageInterpreter]] that allow a programmer to easily create or read messages representing service requests and notifications without knowing too many details about the underlying structures of ''DataObjects'' and its attributes.
 To summarize a programmer has to do the following:
-  - When writing a Sink the service request or notification from //**Aware IM**// has to be translated into the protocol of the external party and sent to this party.
+  - When writing a Sink the service request or notification from //**AwareIM**// has to be translated into the protocol of the external party and sent to this party.
-  - When writing a Source the message in the external party’s format has to be translated into the standard service request or notification and sent to //**Aware IM**//.
+  - When writing a Source the message in the external party’s format has to be translated into the standard service request or notification and sent to //**AwareIM**//.
 The details of this process are described in the sections below.
 {{simplenavi>:docs:3500:0400:0410}}