Comunicarse es una necesidad vital entre sistemas para ampliar sus funcionalidades e interacción entre dispositivos diferentes. En este caso Fermat no es la excepción. La comunicación es importante para la transmisión de datos y envío de información relevante.
Para satisfacer con esta importante necesidad se ha definido como parte de la solución los Servicios de Red.
Los Servicios de Red entran en la categoría de Plug-in de los tipos de componentes definidos que podemos encontrar dentro del Sistema Fermat. Este tipo de Plug-in esta especializado a una tarea bien definida dentro de la arquitectura, el mismo actúa como un intermediario entre la capa de comunicación y los otros componentes de la plataforma, y de esta manera fungir como un servicio para los otros componentes.
Como los Servicios de Red son los intermediarios, y son los que únicamente interactúan directamente con la capa de comunicaciones, ellos son los encargados de encapsular todas las tareas y lógica necesaria para esta interacción, y entre estas tareas básicas encontramos las siguientes:
- Solicitar a la capa de comunicaciones el registro de otros componentes con el Servidor de la Nube (Cloud Server).
- Solicitar a la capa de comunicaciones el descubrimiento y búsqueda de otros componentes registrados, y que están ejecutandose en otro dispositivo.
- Solicitar a la capa de comunicaciones el establecer un nuevo canal de comunicaciones con otro componente especifico y poder enviar y recibir mensajes.
- Mantener una administración de los canales establecidos.
- Recibir y almacenar los mensajes entrantes.
- Enviar y almacenar los mensajes salientes.
Los Servicios de Red también tienen la responsabilidad de definir un protocolo de comunicaciones basado en mensajes para la internación con otros Servicios de Red que se ejecuten en otro dispositivo corriendo el Sistema de Fermat. Un punto importante a tener en consideración en cuanto a los Servicios de Red, es que los mismos solo pueden tener interacción o comunicación con otro Servicio de Red de su mismo tipo que se ejecute en otro dispositivo, para que así los mismos envíen y reciban mensajes de acuerdo a su protocolo definido y puedan entenderse.
## Part I: Conceptos
Es un servicio de red que pretende definir el protocolo y comportamiento para la comunicación entre los componentes de una plataforma que se ejecuta dentro del Fermat Framework.
-
Servicios de Red para Actores, que son los encargados de gestionar las actividades reaccionadas con las identidades (Actores) que se encuentra dentro de la plataforma.
-
Servicios de Red generales que son los encargados de gestionar lógicas de negocio o protocolos de transferencia de información.
Son los canales establecidos por la capa de comunicaciones para que los servicio de red envíen y reciban sus mensajes.
Está definido como la información que el emisor envía al receptor a través de un canal de comunicación determinado, y el mismo tiene un sentido unico.
Esta sección le ayudará a entender el flujo de trabajo necesarios a seguir para implementar un Servicio de Red del Sistema Fermat.
Es obligatorio que se cree un conjunto inicial de GitHub Issues antes de continuar con el flujo de trabajo. Esto le mostrará al resto de los equipos que alguien está trabajando en esta funcionalidad y evitar conflictos de trabajo desde el principio. También se enganchará el líder del equipo en su flujo de trabajo y que le permita orientar y asesorar a usted cuando sea necesario.
Una jerarquía básica de GitHub Issues se crean como un primer paso. Los temas están vinculados uno a otro con sólo colocar un enlace en el primer comentario.
Cuando nos referimos a 'Plugin name' lo que esperamos es la siguiente información:
- Plataforma o Super nombre de Capa - 3 caracteres.
- Nombre de la capa
- Nombre del Plug-in
Todos ellos separados por "-".
Los Issues que deben ser enlazados a su padre deben tener en su primera línea "Parent:" + enlace http al Issues padre.
Los jefes de equipo etiquetados en la segunda línea con el fin de pedirles que asignar el Issue a usted y al mismo tiempo de suscribirse a cualquier actualización del tema. Esto ayuda a los líderes de equipo para seguir los acontecimientos del Issue y proporcionar asistencia u orientación al ver algo mal. El formato sugerido es:
"@ líder de usuario Nombre del equipo, por favor asigne este tema para mí."
La estructura inicial obligatoria es el siguiente: (nota: la palabra ISSUE no es parte del nombre)
Esta es la raíz de la estructura de su problema y debe ser etiquetado como SUPER ISSUE. Está cerrado sólo cuando todos sus hijos y nietos están cerrados.
Esta es la raíz para el Análisis. Está cerrado cada vez que se lleven a cabo todos los análisis. Este Issue debe estar vinculado a la raíz de la estructura de tema.
1 - ISSUE: '_ Plugin name_' - Caso de Usos
Este es donde se especifica cada uno de los posibles casos de usos para cubrir el problema.
Esta es la raíz para la implemtación. Está cerrado cada vez que se lleven a cabo todos las implemntaciones. Este Issue debe estar vinculado a la raíz de la estructura de tema.
1 - ISSUE: **'_ Plugin name_' - Interfaces**
Este es donde se especifica cada uno de los posibles interfaces a implementar.
2 - ISSUE: '_ Plugin name_' - Data Base
Este es donde se especifica cada una de las componenetes de base de datos.
Esta es la raíz de pruebas. Está cerrado cada vez que se lleva a cabo todas las pruebas. Este ISSUE debe estar vinculado a la raíz de la estructura de tema.
-
ISSUE: '_ Plugin name_' - Pruebas - Pruebas Unitarias
-
ISSUE: 'Plugin name' - Pruebas - Pruebas de Integración
Esta es la raíz de control de calidad. Es cerrado cuando se pasan las pruebas de control de calidad. Este problema debe estar vinculado a la raíz de la estructura de tema.
Se espera que tenga aquí Issues hijos en la forma 'Plugin name' QA - Bug Fix n, donde n es el número y el nombre de error.
Esta es la raíz de Producción. Se cierra cada vez que el plug-in alcanza producción. Se puede volver a abrir si se encuentran problemas de bugs en producción y cerrados de nuevo una vez que son solventados. Este Issue debe estar vinculado a la raíz de la estructura de tema.
Se espera que tenga aquí Issues hijos en la forma 'Plugin name' Producción - Bug Fix n, donde n es el número y el nombre de error.
Los componentes de los Servicios de Red pueden estar agrupados y distribuidos de la siguiente manera.
Cada vez que usted desea crear una nueva carpeta, SubApp o de escritorio, debe crear el proyecto que llevará a cabo los componentes GUI en cualquiera de los tres directorios que se muestran a continuación siguiendo esta estructura:
+ PLATFORM_NAME (3 Character)
+ plugin
+ actor_network_services
- fermat-platformname-plugin-actor-network-service-name_1
- fermat-platformname-plugin-actor-network-service-name_2
+ network_services
- fermat-platformname-plugin-network-service-name_1
- fermat-platformname-plugin-network-service-name_2
- fermat-platformname-plugin-network-service-name_3
Donde:
- PLATFORM_NAME: Se refiere a la plataforma en la que vas a crear sus componentes.
- plugin: Se refiere directorio o paguete donde van los componentes de tipo plugin.
- actor_network_services: Se refiere directorio o paguete donde van los network services especializado para los actores.
- network_services: Se refiere directorio o paguete donde van los network services de tipo generales.
Aqui un ejemplo:
+ DAP
+ plugin
+ actor
+ actor_network_services
- fermat-dap-plugin-actor-network-service-asset-issuer-bitdubai
- fermat-dap-plugin-actor-network-service-asset-user-bitdubai
- fermat-dap-plugin-actor-network-service-redeem-point-bitdubai
+ digital_asset_transaction
+ identity
+ middleware
+ network_services
- fermat-dap-plugin-network-service-asset-transmission-bitdubai
+ sub_app_module
+ wallet
+ wallet_module
Como podemos observar en la estructura de la plataforma "Digital Asset Plataform (DAP)" cuenta con tres Servicio de Red de tipo Actor y un Servicio de Red general para una tarea en especifico.
El nombre de los proyectos siguen este patrón:
fermat-[platform_name]-plugin-[network_service_type]-[name_of_the_project]-[org_name]
Where:
- platform_Name: Se refiere a la plataforma en la que va a crear sus componentes.
- network_service_type: Se refiere al tipo de network service que se va a crear, Si es un para un actor o no.
- name_of_the_project: Este es el nombre del proyecto.
- org_name: Este es el nombre de la empresa o organización promotora que está creando el proyecto, por ejemplo: ** bitdubai **.
He aquí un ejemplo:
fermat-dap-plugin-actor-network-service-asset-issuer-bitdubai
Dónde: **DAP ** es la plataforma, **plugin** es el tipo de componente, **actor-network-service** es el tipo de network service, **asset-issuer** es el nombre del proyecto y ** bitdubai ** es la organización responsable de los componentes de este proyecto. Esto significa que el proyecto es un plugin llamado Asset Issuer desarrollado por BitDubai para la plataforma de la DAP.
Un proyecto de componentes de Network Service en Fermat tiene la siguiente estructura básica (Etiquetas: + carpeta, > paquete, - archivo):
+ fermat-[platform_name]-plugin-[network_service_type]-[name_of_the_project]-[org_name]
- .gitignore
- build.gradle
- proguard-rules.pro
+ src
+ main
+ java
> com.bitdubai.[project_type].[name_of_the_project]
> structure
> version_1
> structure
> communications
> database
> event_handlers
> exceptions
- Developer.java
+ test
+ java
> unit.com.bitdubai.[project_type].[name_of_the_project]
Donde:
- El archivo
build.gradlees donde se definen las dependencias del proyecto con otras de las plataformas o con bibliotecas de terceros, pero no por defecto (las bibliotecas de soporte, por ejemplo). - El archivo
Proguard-rules.proconfigura la herramienta Proguard. (para más información ver [este enlace] (http://developer.android.com/guide/developing/tools/proguard.html)). NOTA: no configuramos este archivo en el momento, por lo tanto, está vacía * - Dentro de la carpeta
src/main/javase encuentra el paquete donde colocar los archivos de Java (clases, intefaces, enumeraciones ..) - Dentro de la carpeta
testva el código que se utiliza para hacer pruebas unitarias en las funcionalidades que usted está en desarrollo en la carpetasrc. - Dentro del paquete
structurese encuentra bien organizado dentro de otros paquetes las clases que component el plug-in que se esta desarrollando. - Las Pruebas unitarias se crean dentro del paquete
unit.com.bitdubai.[project_type].[name_of_the_project]en el directoriotest/java
Al principio, cuando se crea el proyecto, no será reconocido como tal en la estructura de dependencias del proyecto raíz (Fermat) y se mostrará como un directorio más. Por lo que su proyecto debe ser incluido en la estructura de dependencias, es necesario añadir las siguientes líneas en el archivo settings.gradle que se encuentra en la carpeta de la plataforma en la que vas a trabajar:
include ':fermat-[platform_name]-plugin-[network_service_type]-[name_of_the_project]-[org_name]'
project(':fermat-[platform_name]-plugin-[network_service_type]-[name_of_the_project]-[org_name]').projectDir = new File('platform_name/plugin/project_type/fermat-[platform_name]-plugin-[network_service_type]-[name_of_the_project]-[org_name]')He aquí un ejemplo de una parte del archivo `settings.gradle` para la plataforma DAP (`fermat/DAP/settings.gradle`):
```Gradle ...
// actor network service include ':fermat-dap-plugin-actor-network-service-asset-user-bitdubai' project(':fermat-dap-plugin-actor-network-service-asset-user-bitdubai').projectDir = new File('DAP/plugin/actor_network_service/fermat-dap-plugin-actor-network-service-asset-user-bitdubai')
include ':fermat-dap-plugin-actor-network-service-redeem-point-bitdubai' project(':fermat-dap-plugin-actor-network-service-redeem-point-bitdubai').projectDir = new File('DAP/plugin/actor_network_service/fermat-dap-plugin-actor-network-service-redeem-point-bitdubai')
include ':fermat-dap-plugin-actor-network-service-asset-issuer-bitdubai' project(':fermat-dap-plugin-actor-network-service-asset-issuer-bitdubai').projectDir = new File('DAP/plugin/actor_network_service/fermat-dap-plugin-actor-network-service-asset-issuer-bitdubai')
// network-service include ':fermat-dap-plugin-network-service-asset-transmission-bitdubai' project(':fermat-dap-plugin-network-service-asset-transmission-bitdubai').projectDir = new File('DAP/plugin/network_service/fermat-dap-plugin-network-service-asset-transmission-bitdubai')
...
<br>
## Parte III: Implementación
En Fermat se sigue un estándar al momento de la creación de un Network Service, de tal forma que se le da uniformidad al proceso de envío y recepción de metadata a través de la red P2P. Para ello se dispone de una plantilla o "template", la cual debe ser respetada para la implementación de este tipo de plugins, por supuesto, es posible ajustar el network service a los requerimientos de la plataforma en la cual va a ser utilizado, solo debe permanecer fija la estructura para el establecimiento de la conexión con el servidor, el registro del mismo y el envío de mensajes.
Para comenzar con la creacion de un plugin Network Service podemos crearlo desde cero agregando las siguientes clases template en la estructura:
+ structure
> communications
> CommunicationNetworkServiceConnectionManager
> CommunicationNetworkServiceLocal
> CommunicationNetworkServiceRemoteAgent
> CommunicationRegistrationProcessNetworkServiceAgent
> database
> CommunicationNetworkServiceDatabaseConstants
> CommunicationNetworkServiceDatabaseFactory
> CommunicationNetworkServiceDeveloperDatabaseFactory
> IncomingMessageDao
> OutgoingMessageDao
> event_handlers
> ClientConnectionCloseNotificationEventHandler
> CompleteComponentConnectionRequestNotificationEventHandler
> CompleteComponentRegistrationNotificationEventHandler
> CompleteRequestListComponentRegisteredNotificationEventHandler
> NewReceiveMessagesNotificationEventHandler
> NewSentMessagesNotificationEventHandler
> VPNConnectionCloseNotificationEventHandler
> exceptions
> CantInitializeDatabaseException
> CantInitializeNetworkServiceDatabaseException
> CantReadRecordDataBaseException
El código fuente de las clases pertenecientes al Template de un Network Service se encuentran en:
+ P2P/library/api/fermat-p2p-api/src/main/java/com/bitdubai/fermat_p2p_api/layer/all_definition/common/network_services/template/
Es bueno destacar que este Template contiene una serie de clases Abstractas que deben ser implementadas en plugin que se está desarrollando.
Como todo plugin en Fermat, este debe incluir una clase **PluginRoot** en la cual se hacen referencia a todos los plugins externos para poder usar las funcionalidades prestadas por estos, así como también sirve para inicializar todas las clases de manejo de base de datos del plugin, agentes y manejadores de aventos (event handlers). Esta clase PluginRoot debe extender de la clase **_AbstractNetworkService_**.
Así mismo, en la _API_ de la plataforma a la cual pertenece el plugin, deben estar la(s) interface(s) manager del plugin, la cual proporcionan acceso a las funcionalidades del plugin Network Service a otros plugins de Fermat. La interface manager debe extender de las interfaces **_FermatManager_** y **_TransactionProtocolManager<BusinessTransactionMetadata>_**.
La interface manager debe ser implementada el paquete _structure_ del plugin.
<br>
<br><br><br>
## Parte IV: Servidor Local de Pruebas
Es posible la ejecución de un servidor local para realizar pruebas de funcionamiento de un Plugin Network Service, esto permite agilizar el proceso de depuración del código fuente del plugin, así como el proceso de detección de errores del mismo.
Para la ejecución del servidor en un ambiente local de desarrollo se deben seguir los siguientes pasos:
* Se debe ingresar a la carpeta principal donde está guardado el proyecto en el disco duro.
```Shell
cd $PATH_TO_FERMAT_REPO/fermat
- Luego se ejecuta el comando que ejecuta la compilación:
cd $PATH_TO_gradle/gradle fatjar- Ahora se ingresa a la carpeta en la cual se encuentra el archivo ejecutable, producto de la compilación anterior:
P2P/plugin/communication/fermat-p2p-plugin-ws-communications-cloud-server-bitdubai/build/libs/- Se debe verificar el contenido de la carpeta anterior, para ello se usa el comando:
ls- Una vez obtenida la lista de archivos contenidos en P2P/plugin/communication/fermat-p2p-plugin-ws-communications-cloud-server-bitdubai/build/libs/ se debe copiar el nombre del archivo JAR que contenga en su nombre with dependencies
- Para la ejecución del servidor, se debe ejecutar el siguiente comando:
java -jar $NOMBRE_DEL_ARCHIVO_OBTENIDO_EN_EL_PASO_ANTERIOR -jar- Cuando se esté ejecutando el servidor se deben observar los mensajes impresos en la consola, entre los cuales se imprime la dirección IP que está usando el servidor local, esta dirección debe ser copiada y usada para configurar al cliente local de comunicaciones. El cliente local de comunicaciones se encuentra en com.bitdubai.fermat_p2p_plugin.layer.ws.communications.cloud.client.developer.bitdubai.version_1.structure.util.ServerConf.
- La dirección IP obtenida en el paso anterior se debe usar en la siguiente variable de configuración:
/**
* Represent the SERVER_IP in the local environment
*/
public static final String SERVER_IP_DEVELOPER_LOCAL = "<LOCAL IP SERVER>";- Una vez configurada la dirección IP se debe ejecutar la aplicación, cuando esta inicie, si el Plugin Network Service se está ejecutando y registrando de forma correcta debería obtener en la consola del servidor un texto como el que se muestra a continuación:
ComponentRegistrationRequestPacketProcessor - processingPackage
ComponentRegistrationRequestPacketProcessor - packetContentJsonStringRepresentation = {"ns-t":"TESTING PLUGIN","pr":"{\"alias\":\"testingpluginnetworkservice\",\"communicationCloudClientIdentity\":\"048B5A003C40B82563BCC002A08D2F6F5257D2B1A0487BCDD11CED7E2845918D57F5998FEF38900A9B665A27235BDEF2A5E6D6BE9AFBA4CED545045F00C14FCDBF\",\"identityPublicKey\":\"04DC8F6915AE276E602EEAA29155EA094A072F876C86B9E9C3A75E6F3FD46B2FA0846BC1C445CDA77C1C07DA0AA566541810FDDD0B28340BE3D99A83F945D526F6\",\"name\":\"Testing Plugin Network Service\",\"networkServiceType\":\"TESTING_PLUGIN\",\"platformComponentType\":\"NETWORK_SERVICE\"}"}
ComponentRegistrationRequestPacketProcessor - registerNetworkServiceComponent
ComponentRegistrationRequestPacketProcessor - Total Network Service Component Registered (TESTING_PLUGIN) = 1