BotEmail
Automatic Computer Remote Control by Email

Plugins y Wrappers

Aqui vamos a intentar explicar la diferencia entre un plugin y un wrapper, cómo se configuran, y cómo se puede desarrollar nuevos plugins para vuestro propio uso ( o lo compartais en el foro)

Llamamos plugin a cualquier extensión del programa de tipo externo que cumpla unos determinados criterios de programación (ver más abajo). Se colocarán el la carpeta plugins y el programa los reconocerá automáticamente al iniciarse.
Llamamos wrapper a un envoltorio del plugin (ES INTERNO DEL PROGRAMA, NO HAY QUE PROGRAMAR NADA) Se genera al seleccionar un plugin de la ventana y pulsar el botón "Nuevo Wrapper".
Los wrappers sirven para varias cosas:

  1. Permiten tener varias instancias de los plugins con distintos nombres
  2. Permite tener plugins activos o inactivos
  3. Da mucha mayor seguridad que nadie mas que tú sepas cuál es el nombre del wrapper que interpretará botemail al leer la entrada.
Si pulsais el botón de generar plantilla (Previamente tendreis que haber seleccionado un wrapper) se generará un fichero xml de nombre Template_NOMBREDELWRAPPER.xml con el código que debeis introducir en el cuerpo del mensaje que vayais a mandar a BotEmail. Sólo tendreis que rellenar los parámetros con los valores que necesiteis.
Ejemplo de fichero generado con "generar plantilla" para un wrapper de nombre CMDEXEC que usa el plugin que viene por defecto de Command Executer:

<?xml version="1.0" encoding="UTF-8"?>
<botemail>
 <wrapper>
<name>CMDEXEC</name>
<parameter>
<paramName>Command</paramName>
<paramValue>AQUI PONDREMOS EL VALOR DEL PARAMETRO</paramValue>
</parameter>
</wrapper>
</botemail>

Bastaría con rellenar el valor del parámetro, por ejemplo c:\\\\Archivos de programa\\Mozilla Firefox\\firefox.exe (Acordaos de poner las dos barras \\ para escapar el caracter) y con esto al recibir el correo, os abriría el Firefox (suponiendo que teneis el firefox en la misma ruta).

Cómo programar tu propio plugin

Para poder realizar tu propio plugin, lo primero que tienes que hacer es descargarte la librería y el proyecto de ejemplo de la página de descargas.
Una vez descargados, el proyecto de ejemplo Command Executer está realizado con Netbeans 6.8 y usa una librería llamada BotEmailLibs.jar
Esta libreria contiene dos interfaces que debes usar cuando quieras hacer tus propios plugins:
1 - IParameter. Es un interfaz que tendrán que implementar todos los parámetros que quieras que tu plugin reciba.
2 - IPlugin. Esta interfaz es la que hará de enlace entre tu plugin y la aplicación. Los métodos más importantes son:
  •     executePlugin() : Método que será llamado por BotEmail cuando reciba un wrapper asociado a tu plugin.
  •     getErrors(): Método que informará de los errores ocurridos dentro de tu plugin para que el usuario sepa qué hacer.
Por lo demás, el objetivo de los plugins está sólo limitado por tu imaginación (y tus conocimientos de programación).
El proyecto de ejemplo es uno de los plugins más sencillos que se pueden hacer, pero que enseña de forma clara el uso de un plugin.
Para dudas, consultas o sugerencias, ya sabes... usa el FORO
Copyright (c)2009 BotEmail