Copyright © Obeo 2016, 2017 – All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License v1.0
Authors Stéphane Thibaudeau
Contact [email protected]
SOA Designer permet de modéliser des composants métiers, leurs services et les structure de données (DTO = Data transfer object) manipulées.
SOA Designer fournit le point de vue SOA Views permettant de :
- Modéliser les composants et leurs liens entre eux
- Modéliser les contrats des composants (interfaces et services)
- Modéliser les DTOs, leur structure et les relations entre eux,
- Organiser ces DTOs en packages
Un assistant permet la création de modèles SOA. Cet assistant est accessible via le menu :
File > New > Other … > SOA Model (Catégorie IS Designer)
!pics/Safran – soa – wizard01.png!
Cet assistant vous permet de définir le nom du modèle que vous souhaitez créer ainsi que de définir son répertoire destination.
!pics/Safran – soa – wizard02.png!
Une fois l’assistant validé, le modèle est créé, les représentations SOA Diagram, DTO Namespaces Hierarchy et DTO Physical Names sont créées. La représentation DTO Namespaces Hierarchy est ouverte afin de commencer l’édition.
!pics/Safran – soa – model created.png!
Lorsqu’un modèle soa est créé à l’aide de ce wizard, les points de vues SOA Views, SOA (Safr@n Consolidated view) et Environment View sont activés.
Le point de vue SOA Views est décrit dans la section suivante. Le point de vue SOA (Safr@n Consolidated view) est décrit dans la section de documentation Safr@n – SOA. Le point de vue Environment View permet d’activer les vues propriétés EEF.
L’outillage SOA Designer fournit un point de vue dédié à la gestion des composants métier. Ce point de vue permet de visualiser et modifier un modèle SOA via plusieurs types de diagrammes.
L’ouverture d’une session de travail sur un modèle SOA se fait de manière classique :
- En ouvrant le Modeling Project contenant le modèle
- En double-cliquant sur un fichier *.aird existant
- En faisant un glisser/déposer d’un fichier *.soa sur la vue Model Explorer
- En convertissant le projet contenant le modèle en un Modeling Project
Le point de vue SOA Views doit être sélectionné sur la session ouverte. Pour vérifier si c’est bien le cas lancer le menu suivant la session :
Viewpoint Selection
Choisir le point de vue SOA Views :
Une fois le point de vue activé, il devient possible de créer ou visualiser les diagrammes SOA Views.
Chaque type de diagramme est rattaché à un concept SOA précis. Par exemple, un DTO Diagram est rattaché à un Namespace.
Pour créer un diagramme d’un certain type, il suffit de sélectionner l’élément du modèle auquel on veut rattacher le diagramme dans la vue Model Explorer puis, avec un clic droit, de sélectionner le menu :
New… > #Nom du diagramme#
puis renseigner le nom du diagramme et, enfin, valider.
Par exemple sur un objet racine Components, deux types de représentation peuvent être créés comme présenté sur la capture d’écran suivante :
Pour ouvrir un diagramme il suffit de double-cliquer sur le diagramme dans la vue Model Explorer. Attention seuls les diagrammes correspondants aux points de vue sélectionnés sur la session sont affichés dans la vue Model Explorer.
Le SOA Diagram permet de modéliser les composants métiers, les services qu’ils fournissent et les services dont ils ont eux-même besoin (services requis).
Ce diagramme permet aussi de relier les composants entre eux pour indiquer qu’un service fourni par un composant permet de répondre à un besoin de service requis exprimé par un autre composant.
Ce diagramme peut être créé sur un objet racine Components.
Les éléments suivants sont affichés sur le diagramme :
- Component : composant métier
- Provided service : service métier fourni par un composant
- Required service : service métier dont un composant a besoin pour fonctionner
- Les liens entre services fournis et services requis
Les outils fournis par la palette sont :
 |
Création d’un composant métier. |
 |
Création d’un service métier fourni par un composant. |
 |
Création d’un service métier requis par un composant. |
 |
Création d’un lien depuis un service requis vers un service fourni. Permet d’indiquer quel composant fournit les services nécessaires au fonctionnement d’un autre composant. |
 |
Ajout d’un composant externe sur le diagramme. Cet outil permet de faire apparaitre un composant défini dans un autre modèle SOA pour créer des relations avec les composants affichés. Cet outil est activable via le calque _External Components |
Il est possible de naviguer depuis ce diagramme vers un autre diagramme :
- Depuis un Component, un double-clic, le menu New ou le menu Open permettent de naviguer (et potentiellement de le créer) vers le diagramme de contrat de ce composant.
Le Component Contract Diagram permet de modéliser les services métiers fournis et/ou requis par un composant.
Pour chaque service, il permet de modéliser des opérations.
Pour chaque opération, les paramètres d’entrée, les paramètres de sortie et les cas d’erreur possibles sont modélisables.
Ce diagramme peut être créé sur les objets de type Component.
Les éléments suivants sont affichés sur le diagramme :
- Provided service : service métier fourni par le composant
- Required service : service métier dont un composant a besoin pour fonctionner
- Operation : les opérations d’un service sont affichées à l’intérieur du conteneur représentant le service
- Input parameter : paramètre d’entrée d’une opération
- Output parameter : paramètre de sortie d’une opération
- Fault parameter : cas d’erreur pour une opération
Les outils fournis par la palette sont :
 |
Création d’un service métier fourni par un composant. |
 |
Création d’un service métier requis par un composant. |
 |
Création d’une opération dans un service. |
 |
Création d’un paramètre d’entrée. |
 |
Création d’un paramètre de sortie. |
 |
Création d’un cas d’erreur. |
Les DTO sont organisés en packages (Namespaces).
La gestion de la hiérarchie de packages se fait en utilisant le diagramme DTO Namespaces Hierarchy.
Ce diagramme peut être créé sur l’objet racine Components.
Ce diagramme permet de créer, modifier ou supprimer des packages ainsi que d’accéder facilement au diagramme de gestion des DTOs d’un package.
Les éléments suivants sont affichés sur le diagramme :
- Namespace : chaque package contenu dans l’élément racine est affiché. Si un package est contenu par un autre package il apparaît à l’intérieur de son package parent. L’icône d’un package apparaît blanche ou grisée selon si le package est respectivement vide ou non.
- Dépendance : les dépendances entre packages sont représentées par des liens. Ces dépendances sont consolidées à partir du contenu de chacun des packages.Une dépendance consiste en un lien d’héritage, une référence ou l’utilisation d’une Enumération pour typer un attribut. Le nombre d’éléments considérés dans la relation de dépendance est indiqué sur chaque extrémité. Les dépendances entre un package et un de ses sous-packages ne sont pas affichées. L’affichage des dépendances peut être activé ou désactivé via le layer Dependencies.
Les outils fournis par la palette sont :
 |
Création d’un package. Un package peut être créé sur le fond du diagramme ou à l’intérieur d’un autre package. |
Il est possible de naviguer depuis ce diagramme vers un autre diagramme :
- Depuis un package, un double-clic, le menu New ou le menu Open permettent de naviguer (et potentiellement de le créer) vers le diagramme des DTOs de ce package.
Un diagramme des DTOs (DTO Diagram_) est associé à un package (_Namespace). Il permet de gérer les DTOs du package.
Les éléments suivants sont affichés sur le diagramme :
- DTOs
- Attributs
- Relations entre DTOs
- Liens d’héritage
- Enumération
- Packages contenus
Les outils fournis par la palette sont :
 |
Création d’un sous-package. |
 |
Création d’une entité. |
 |
Création de DTOs à partir d’entités. |
 |
Création d’un attribut de DTO. |
 |
Création d’une énumération. |
 |
Création d’une valeur d’énumération. |
 |
Création d’une relation simple. |
 |
Création d’une relation de composition. |
 |
Création d’un lien d’héritage. |
 |
Création d’une relation simple bidirectionnelle. |
 |
Création d’une relation de contenance bidirectionnelle. |
 |
Ajout d’un DTO externe. Cet outil permet de faire apparaitre un DTO défini dans un autre package pour créer des relations avec les DTOs du package courant. Cet outil est activable via le calque _External DTOs |
L’outil de création de DTOs à partir d’entités permet de sélectionner des entités (cf. documentation sur Entity Designer) et des références entre ces entités. Des DTOs et des relations sont créés pour chaque entité et chaque référence sélectionnée.
La gestion des exigences pour un modèle Entity utilise le mécanisme transverse de gestion des exigences fourni par l’outillage.
Se référer à la documentation Obeo Network – Requirements Tooling dans l’aide d’Eclipse.
Il est possible d’attacher de la documentation aux éléments d’un modèle Entity. Le mécanisme utilisé est le mécanisme transverse de gestion de la documentation fourni par l’outillage.
Se référer à la documentation Obeo Network – Documentation Tooling dans l’aide d’Eclipse.
Il est possible de créer des diagrammes d’interaction pour les éléments d’un modèle Entity.
Se reférer à la documentation Obeo Network – Interaction Tooling dans l’aide d’Eclipse.
Il est possible de créer des diagrammes de machines à états pour les éléments d’un modèle Entity.
Se reférer à la documentation Obeo Network – State Machine Tooling dans l’aide d’Eclipse.