Red Hat Training

A Red Hat training course is available for Red Hat JBoss Enterprise Application Platform

3.2. Les API (de l'anglais Application Programming Interfaces) de gestion

Clients de gestion

JBoss EAP 6 offre trois approches différentes pour configurer et gérer des serveurs, une interface web, un client de ligne de commande et un ensemble de fichiers de configuration XML. Tandis que les méthodes recommandées pour la modification du fichier de configuration incluent la console de gestion et l'interface CLI, les modifications de configuration de la part des trois sont toujours synchronisées à travers les différentes vues et sont conservées dans les fichiers XML. Notez que les modifications apportées aux fichiers de configuration XML pendant l'exécution d'une instance de serveur seront remplacées par le modèle de serveur.

HTTP API

Le point de terminaison de l'API HTTP est le point d'entrée pour les clients de gestion, comme par exemple la Console de gestion, qui dépend du protocole HTTP pour s'intégrer à la couche de gestion. Ce point de terminaison utilise un protocole JSON encodé et un API de style RPC de-typed, pour décrire et exécuter des opérations de gestion dans un domaine géré ou un serveur autonome. Il est utilisé par la console web, mais offre aussi des possibilités d'intégration pour un large éventail d'autres clients.

Le point de terminaison HTTP API est situé près du contrôleur de domaine ou d'une instance de serveur autonome. Il sert deux contextes différents; un pour l'exécution des opérations de gestion et de l'autre pour accéder à l'interface web. Par défaut, il s'exécute sur le port 9990.

Exemple 3.1. Exemple de fichier de configuration HTTP API

<management-interfaces>
  [...]
  <http-interface security-realm="ManagementRealm">
     <socket-binding http="management-http"/>
  </http-interface>
</management-interfaces>
La console web est desservie par le même port que l'API de gestion HTTP. Il est important de distinguer la façon dont on accède à la Console de gestion ou à l'API HTTP : la Console de gestion comme localhost par défaut, la Console de gestion à distance par un hôte spécifique et une combinaison de ports, et l'API HTTP exposé du domaine.

Tableau 3.1. Les URL d'accès à la Console de gestion ou à l'API HTTP exposé

URL Description
http://localhost:9990/console La console de gestion à laquelle accéde l'hôte local, et qui contrôle la configuration du domaine géré.
http://hostname:9990/console La console de gestion accédée à distance, qui nomme l'hôte et qui contrôle la configuration du domaine géré.
http://hostname:9990/management L'API de gestion HTTP exécute sur le même port que la console de gestion, affiche les mêmes valeurs et attributs bruts exposés à l'API.
API Natif

Le CLI de gestion est un exemple d'outil d'API Natif. Cet outil de gestion est disponible à une instance de serveur autonome ou à un domaine, permettant ainsi à un utilisateur de se connecter à une instance du serveur autonome ou au contrôleur du domaine, et d'exécuter des opérations de gestion rendues disponibles par le modèle de gestion de-types.

Le point de terminaison de l'API natif est le point d'entrée pour les clients de gestion qui s'appuient sur le protocole natif pour intégrer la couche de gestion. Il utilise un protocole binaire ouvert et une API style-RPC basée sur un très petit nombre de types Java pour décrire et exécuter des opérations de gestion. Il est utilisé par l'outil de gestion Interface CLI, mais offre des capacités d'intégration pour un large éventail d'autres clients également.
Le point de terminaison d'API natif est co-localisé avec un contrôleur hôte ou un serveur autonome. Il doit être activé pour utiliser l'interface CLI. Par défaut, il s'exécute sur le port 9999.

Exemple 3.2. Exemple de fichier de configuration d'API natif

<management-interfaces>
  <native-interface security-realm="ManagementRealm">
    <socket-binding native="management-native"/>
  </native-interface>
  [...]
</management-interfaces>