Rubrique précédente: Création d'un adaptateur personnalisé à l'aide de l'interface du kit de développement logicielRubrique suivante: Configurez le nouvel adaptateur de recherche personnalisé avec le composant de recherche fédérée de CA.


Compilation de fichiers .jar pour le nouvel adaptateur personnalisé

Compilez les fichiers .jar pour des adaptateurs de recherche personnalisés.

Procédez comme suit:

  1. Compilez les nouveaux adaptateurs de recherche personnalisés. Vérifiez que vous disposez des fichiers .jar suivants dans le chemin d'accès à la classe Java :
    jsr311-api-1.0.jar

    Ce fichier .jar est disponible dans le répertoire CA SDM :

    %NX_ROOT%\java\lib\CXF\
    
    cafedsearch-core.jar

    Ce fichier se trouve dans le dossier suivant :

    %NX_ROOT%\bopcfg\www\CATALINA_BASE_FS\webapps\cafedsearch\WEB-INF\lib
    
    cafedsearch-adapter-sdk-1,0.0.jar

    Ce fichier se trouve dans le dossier suivant :

    %NX_ROOT%\bopcfg\www\CATALINA_BASE_FS\webapps\cafedsearch\WEB-INF\lib
    
    log4j-1.2.15.jar (facultatif)

    Ce fichier se trouve dans le dossier suivant :

    %NX_ROOT%\java\lib
    
  2. Ecrivez une nouvelle classe Java pour étendre la classe SearchAdapter et fournir l'implémentation de la méthode abstraite.
    recherche
    

    Le composant de recherche fédérée de CA appelle et transfère des paramètres de méthode de recherche. Ces paramètres sont intégrés au paramètre SearchOptions pour chaque demande de recherche à partir du client.

    Remarque : Vérifiez que votre implémentation garantit la sécurité des threads, car le composant CAFedSearch conserve une seule instance de la classe Java. Pour chaque opération de recherche, la méthode de recherche est appelée sur la même instance.

  3. Le paramètre SearchOptions de méthode de recherche contient les méthodes suivantes :
    getSearchTerms()

    Spécifie la méthode de récupération de la chaîne de recherche.

    getStartIndex()

    Spécifie la méthode d'index de début, le nombre à partir duquel le client souhaite rechercher des éléments. L'index commence à partir de 1.

    getItemsPerPage()

    Spécifie le nombre maximum de résultats de recherche attendu par le client.

    Remarque : Vous pouvez également utiliser d'autres méthodes de classe Java. Par exemple : getUserId()

  4. Envoyez les informations collectées à l'API de moteur de recherche externe pour récupérer les résultats de la recherche.

    Remarque : Pour plus d'informations sur les méthodes de classe Java, consultez la documentation Java.

  5. La méthode de recherche renvoie une instance de classe ResultCollection. Créez une instance ResultCollection et renseignez les valeurs à l'aide des méthodes suivantes :
    setSources(String name)

    Spécifie le nom de l'adaptateur de recherche. Les noms respectent la casse et doivent correspondre exactement au nom fourni dans le fichier de configuration de l'utilitaire. Pour plus de facilité, SearchAdapter fournit une méthode getName() qui doit être utilisée.

    Par exemple :

    results.setSources(getName());
    
    setTotalResults (int total)

    Spécifie le nombre total de résultats de recherche.

    setStartIndex(int startIndex)

    Spécifie un index de début des résultats. Cette valeur est basée sur les résultats issus de votre moteur de recherche.

    results.setStartIndex(startIndex);
    
  6. Un ensemble de ResultItems doit être transféré vers l'objet ResultCollection par appel de la méthode setSearchResultItems. Pour ajouter une instance de ResultItem à la fois, utilisez la méthode addSearchResultItem().

    Remarque : Pour plus d'informations sur la classe Java ResultCollection, reportez-vous à la documentation de Java.

  7. La classe ResultItem contient les méthodes importantes suivantes, qui doivent être remplies pour chaque élément de résultat de recherche (ligne).
    setContentText(String txt)

    Spécifie une méthode permettant de définir le contenu réel des résultats de la recherche.

    setContentHTML(String txt)

    Indique une méthode permettant de définir le contenu HTML (peut contenir des balises HTML). Si le moteur de recherche met HTML en surbrillance, définissez le texte mis en surbrillance à l'aide de cette méthode.

    Remarque : Si votre moteur de recherche ne dispose pas de cette fonctionnalité, vous pouvez écrire une simple méthode de classe Java pour mettre en surbrillance le texte. L'adaptateur de CA Open Space contient une méthode simple pour mettre des termes en gras dans les résultats de la recherche.

    setTitleHTML(String titleHTML)

    Indique une méthode permettant de définir un titre HTML (peut contenir des balises HTML).

    setTitleText(String titleText)

    Indique une méthode permettant de définir un titre simple (ne peut pas contenir de balises HTML).

    setSource(String source)

    Indique une méthode permettant de définir l'attribut source. Un appel habituel est de type item.setSource(getName());.

    Remarque : Si l'adaptateur de recherche requiert davantage de fichiers .jar, personnalisez le fichier build.xml pour compiler et préparer un fichier .jar pour l'adaptateur. Les binaires Ant sont requis pour utiliser le fichier build.xml. Utilisez Ant pour exécuter les cibles dans build.xml de manière à compiler et créer les fichiers .jar. Conservez le fichier build.xml dans votre dossier source (src). Le fichier build.properties est facultatif. Pour plus d'informations sur les binaires Ant, consultez l'Aide de Ant.

    Le fichier .jar est compilé.