Añadir un usuario personalizado o un mensaje de error a un módulo de servicio de BOD

Añadir mensajes personalizados a los mandatos de la infraestructura del BOD implica crear el archivo de propiedades con un convenio de denominación y una ubicación especificados. La infraestructura de la anotación cronológica se configura para que se recorra la jerarquía de paquetes y se encuentren y carguen aquellos paquetes de recursos (archivos de propiedades) cuyos nombres coincidan con el convenio de denominación.

Procedimiento

  1. Cree un archivo de propiedades en el que listar los valores de los mensajes, uno para cada entorno nacional al que desee dar soporte:
    1. El archivo de propiedades debe ubicarse en el paquete com.mycompany.logging.properties donde mycompany es el nombre de su empresa, o algún otro identificador exclusivo arbitrario. El aspecto más importante a tener en cuenta es que el nombre del paquete termine con logging.properties y que dicho paquete pueda encontrarse al mismo nivel que, o por encima de la clase que realice la llamada, respecto a la jerarquía de paquetes.
    2. El nombre de los archivos de propiedades debe seguir el patrón siguiente: WcMyServiceModuleMessages_locale.properties, donde MyServiceModule es el nombre del módulo de servicio y entorno local es el identificador de entorno local (por ejemplo, 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. Cree una clase de clave de mensaje que capture las claves del archivo de propiedades. Esta clase debe definir una variable de instancia estática para cada una de las claves de mensaje del archivo de propiedades.
    1. Si solo debe acceder a los mensajes el código del servidor, cree una nueva clase de interfaz en el proyecto de MyServiceModule-Server. El convenio de denominación que se sugiere es MyServiceModuleApplicationMessageKey.java. Si necesitan acceder a los mensajes tanto el cliente como el servidor, cree la interfaz en el proyecto de MyServiceModule-Client, utilizando el convenio de denominación MyServiceModuleClientApplicationMessageKey.java sugerido.
    2. Para cada mensaje, cree una línea parecida a la siguiente, en la clase de interfaz:
      /**
       * 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. Registre el error tal como se indica a continuación:
    Logger logger = LoggingHelper.getLogger(MyClass.class);
    logger.logp(Level.SEVERE, "MyClass","MyMethod",
    MyServiceModuleMessageKeys.MYCOMPANY_MYCOMMAND_INVALID_PARAMETER,
    new Object[] {parameterName, parameterValue} );