Fichier descripteur d'adaptateur Java

En savoir plus sur la fonction et la structure du fichier descripteur d'adaptateur Java™.

Vous utilisez le fichier descripteur adapter.xml pour déclarer le nom d'affichage, la description, le nom de classe de l'application JAX-RS, et les contrôles de sécurité qui sont exposés par un adaptateur Java pour les applications et les autres adaptateurs. Les éléments, les sous-éléments et les attributs du fichier XML d'adaptateur JavaScript sont décrits dans les sections ci-après.

Le fichier descripteur adapter.xml se trouve dans le dossier adapter-resources, sous <Java_adapter>/src/main/.

L'élément adapter

L'élément adapter est l'élément racine du fichier de configuration d'adaptateur. Il possède la structure suivante, composée d'attributs et de sous-éléments :
<?xml version="1.0" encoding="UTF-8"?>
<mfp:adapter name="JavaAdapter1"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:mfp="http://www.ibm.com/mfp/integration">
 
    <displayName>JavaAdapter1</displayName>
    <description>JavaAdapter1</description>
     
    <JAXRSApplicationClass>com.acme.JavaAdapter1Application</JAXRSApplicationClass>
	
    <securityCheckDefinition
name="UserAuthenticationSC" class="com.my_company.package.MyUserAuthenticationSecurityCheck"> 
        <property name="maxAttempts" displayName="Nombre maximal de tentatives"
            defaultValue="3"
            description="Nombre maximal de tentatives d'authentification d'utilisateur autorisées"/>
    </securityCheckDefinition>

    <property name="path" description="Chemin après le nom d'hôte" defaultValue="/feed">
</mfp:adapter>

Les attributs de l'élément adapter

name

Obligatoire.

Nom de l'adaptateur. Il doit être unique sur le serveur MobileFirst Server. Il peut contenir des caractères alphanumériques et des traits de soulignement, et doit commencer par une lettre. Une fois que vous avez défini et déployé un adaptateur, vous ne pouvez plus modifier son nom.

Les sous-éléments de l'élément adapter

L'élément adapter possède les sous-éléments ci-après.

displayName

Facultatif.

Nom de l'adaptateur qui est affiché dans MobileFirst Operations Console. Si cet élément n'est pas spécifié, la valeur de l'attribut name est utilisée à la place.

description

Facultatif.

Informations supplémentaires sur l'adaptateur. Affichées dans MobileFirst Operations Console.

JAXRSApplicationClass

Requis pour l'exposition d'un noeud final /adapter.

Définit le nom de classe de l'application JAX-RS de cet adaptateur. Dans l'exemple, il s'agit de com.acme.JavaAdapter1Application. Pour plus d'informations, voir Implémentation du service JAX-RS de l'adaptateur.
securityCheckDefinition

Facultatif.

Définit un objet de contrôle de sécurité. Pour des informations complètes sur l'élément securityCheckDefinition, voir L'élément <securityCheckDefinition>.

property

Facultatif.

Déclare une propriété définie par l'utilisateur.

  • Les propriétés définies par l'utilisateur sont indiquées dans MobileFirst Operations Console dans l'onglet Configurations pour l'adaptateur correspondant. Les valeurs que les développeurs leur attribuent au cours de la création de l'adaptateur peuvent être remplacées dans la console, sans déployer l'adaptateur.
  • Les propriétés définies par l'utilisateur peuvent être lues à l'aide de l'interface ConfigurationAPI et personnalisées davantage au moment de l'exécution. Pour plus d'informations, voir Configuration des adaptateurs.
L'élément property possède la structure ci-dessous.
<property name="nom-unique" 
    description="valeur" 
    defaultValue="valeur" 
    type="valeur"
/>
L'élément property possède les attributs ci-dessous.
name

Obligatoire.

Nom de la propriété. Il doit être unique dans l'adaptateur. Il peut contenir des caractères alphanumériques et des traits de soulignement, et doit commencer par une lettre.

description

Facultatif.

Description lisible de la propriété. Il s'agit du nom qui est affiché dans MobileFirst Operations Console.

defaultValue

Obligatoire.

Définit la valeur par défaut de cette propriété. Il s'agit de la valeur qui sera associée à la propriété, si elle n'est pas remplacée.

type

Facultatif.

Type de propriété. S'il n'est pas spécifié, le type chaîne est supposé. Les valeurs suivantes sont admises :
  • string : valeur par défaut. Toute valeur de chaîne est admise.
  • integer : toute valeur de type entier est admise.
  • boolean : les valeurs true et false seulement sont admises.
  • enumerator : des valeurs spécifiques seulement sont admises. Elles sont spécifiées sous la forme d'un tableau JSON. Par exemple, l'expression énumérative ['premier', 'deuxième'] n'autorise que les valeurs premier et deuxième.
Rubrique parent : Adaptateurs MobileFirst Java