Ajout d'un message utilisateur ou d'erreur personnalisé à un module de service BOD

L'ajout de messages personnalisés à votre infrastructure de commandes BOD nécessite la création de votre fichier de propriétés en utilisant une convention de dénomination et un emplacement spécifiés. L'infrastructure de connexion est configurée pour parcourir la hiérarchie du module et pour rechercher et charger tous les regroupements de ressources (fichiers de propriétés) dont le nom correspond à la convention de dénomination.

Procédure

  1. Créez un fichier de propriétés répertoriant les valeurs de messages pour chaque environnement local à prendre en charge :
    1. Le fichier de propriétés doit être implanté dans le module com.mycompany.logging.properties où mycompany désigne le nom de votre entreprise ou tout autre identificateur arbitraire unique. Le point le plus important est que ce nom se termine par logging.properties et que ce module puisse être trouvé au niveau de la classe appelante, ou au dessus, dans la hiérarchie du module.
    2. Le nom des fichiers de propriété doit suivre le modèle ci-dessous : WcMyServiceModuleMessages_locale.properties , où MyServiceModule est le nom de votre module de service et locale est l'identificateur local (par exemple, en_US). 
    # translateable messages for the MyServiceModule component
# Message keys are defined in the class
# com.mycompany.logging.MyServiceModuleMessageKeys
MYCO0001E= MYCO0001E: The value "{1}" is invalid for parameter name "{0}"
MYCO0002I= MYCO0002I: The value {0} is over 9000!
  2. Créez une classe de clés de messages pour capturer les clés du fichier de propriétés. Cette classe doit définir une variable d'instance statique pour chaque clé de message définie dans votre fichier de propriétés.
    1. Si seul le code serveur a besoin d'accéder aux messages, créez une nouvelle classe d'interface dans le projet MyServiceModule-Server. La convention de dénomination suggérée est la suivante : MyServiceModuleApplicationMessageKey.java. Si le client tout comme le serveur ont besoin d'accéder aux messages, créez l'interface dans le projet MyServiceModule-Client, la convention de dénomination suggérée étant alors MyServiceModuleClientApplicationMessageKey.java.
    2. Créez pour chaque message une ligne similaire à ceci dans la classe d'interface :
      /**
 * MyServiceModule command invalid parameter
 * param 0: The name of the invalid parameter
 * param 1: The value of the invalid parameter
 */
public final static String MYCOMPANY_MYCOMMAND_INVALID_PARAMETER = "MYCO0001E";
  3. Consignez l'erreur comme suit :
    Logger logger = LoggingHelper.getLogger(MyClass.class);
logger.logp(Level.SEVERE, "MyClass","MyMethod",
MyServiceModuleMessageKeys.MYCOMPANY_MYCOMMAND_INVALID_PARAMETER,
new Object[] {parameterName, parameterValue} );