Tutoriel : création d'application Red5

Après avoir expliqué comment installer Red5 sur un serveur linux Debian, ce tutoriel imagé explique comment créer une application pour Red5 avec Java. Ce tutoriel requiert l'utilisation d'Eclipse, logiciel de développement gratuit et très largement utilisé par les développeurs Java. On peut créer des applications Red5 de plusieurs manières, mais utiliser Eclipse est sans doute le plus simple.

• création du projet Eclipse
• paramétrages du projet
• ajout des librairies externes
• création de la classe Java
• fichiers de paramétres de l'appli Red5
• compilation de l'application Red5
• déploiement de l'application Red5
• téléchargement de l'application

Création du projet Eclipse

Tout d'abord, nous allons créer un nouveau projet que nous appellerons LigamsRed5App :

Sélectionnez File -> New Project

Création d'un nouveau projet

Sélectionnez ensuite Java Project :

Eclipse : sélection de Java Project

Nous nommons maintenant l'application LigamsRed5App :

Eclipse : LigamsRed5App

Maintenant le projet apparaît dans le package explorer, nous allons paramétrer l'application et gérer les bibliothèques que nous allons utiliser.

Paramétrages du projet

Arborescence de l'application

Les applications Red5 ont un dossier WEB-INF, nous allons maintenant créer ce dossier :

Eclipse : WEB-INF

Eclipse : WEB-INF 2

De la même manière, nous allons créer 2 dossiers dans ce répertoire WEB-INF : un dossier classes (qui accueillera les classes compilées) et un dossier src (ou nous placerons les sources).

Assurez-vous d'obtenir quelque chose qui ressemble à ceci :

Eclipse : WEB-INF classes et src

Options de compilation

Maintenant, nous allons définir classes comme la destination des classes Java compilées, et src comme le répertoire des sources Java :

Répertoire src : Clic droit sur le répertoire -> build path -> use as Source Folder

Eclipse : src - source

Répertoire classes :

Sélectionner dans le menu Project -> Properties

Eclipse : project properties

Sélectionnez Java Build Path, puis l'onglet Source , tout en bas, modifiez le Default output folder, en sélectionnant WEB-INF/classes.

Eclipse : Default output folder

Fichiers de configuration de l'application Red5 :

Nous devons maintenant récupérer les fichiers de configuration de red5, vous pouvez soit copier/coller les fichiers d'un application fournie avec Red5, soit récupérer les fichiers fournis dans l'application LigamsRed5App en téléchargement en bas de page.

Si vous avez Red5 installé sur votre machine windows, vous les récupérerez dans ce répertoire : C:\Program Files\Red5\doc\templates\myapp\WEB-INF

Copiez/Collez ces fichiers de configuration dans le répertoire WEB-INF de votre application LigamsRed5App. Faites ensuite un refresh (touche F5) sur votre projet et les fichiers devraient apparaître dans l'explorateur de solution :

Eclipse : fichiers de configuration

Ajout des librairies externes

Créer une application Red5 requiert certaines librairies externes : notamment pour le système de logs, et pour étendre les classes de Red5.

Pour créer la classe principale de notre application, nous allons devoir étendre la classe ApplicationAdapter de Red5 : pour cela, sélectionnez dans le menu principal Project, puis Properties.

Sélectionnez ensuite Java build Path, puis l'onglet Libraries, pressez ensuite le bouton Add External JARs :

Ajout de librairies Externes JAR

Sélectionnez Red5.jar qui est situé dans votre répertoire d'installation de Red5, puis cliquez sur OK. (généralement C:\Program Files\Red5\Red5.jar ).

Ajout des librairies de log :

Répétez l'opération en ajoutant le Jar pick commons-logging-1.1.jar situé dans le répertoire lib du dossier Red5 (généralement C:\Program Files\Red5\lib\commons-logging-1.1.jar )

Création de la classe Java

Maintenant, l'environnement est prêt, nous pouvons créer la classe Java : créer une nouvelle classe :

Eclipse : création d'une classe

Package com.ligams, le nom de la classe sera Main. Nous devons créer les méthodes appStart et appConnect, nous gérons également les connexions, vous pouvez y ajouter un peu de code si vous le souhaiter (authentification etc.).

package com.ligams;

//Debogage : gestion des logs
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
//Gestion des connexions
import org.red5.server.api.IConnection;
import org.red5.server.adapter.ApplicationAdapter;

public class Main extends ApplicationAdapter
{
    private static final Log log = LogFactory.getLog( Main.class );
    /**
     * Démarrage de l'application
     * @return
     */
    public boolean appStart ( )
    {
        log.info( "Main.appStart" );
        return true;
    }
    /**
     * Arrêt de l'application
     */
    public void appStop ( )
    {
        log.info( "Main.appStop" );
    }
    /**
     * Connexion d'un client
     * @param conn 
     * @param params
     */
    public boolean appConnect( IConnection _conn , Object[] _params )
    {
        log.info( "Main.appConnect " + _conn.getClient().getId() );
        return true;
    }
    /**
     * Déconnexion d'un client
     * @param conn
     * @param params
     */
    public void appDisconnect( IConnection conn , Object[] params )
    {
        log.info( "Main.appDisconnect " + conn.getClient().getId() );
    }
    
}

Le code Java est maintenant prêt, nous devons maintenant paramétrer correctement l'application.

Fichiers de paramètres

Ouvrir le fichier log4j.properties :

Ouvrir le fichier red5-web.properties :

webapp.contextPath=/ligams
webapp.virtualHosts=*

Ouvrir le fichier red5-web.xml :

Dans ce fichier, nous devons configurer la classe principale de l'application, modifier le XML ainsi :

<bean id="web.handler" class="com.ligams.Main" singleton="true" />

Ouvrir le fichier web.xml :

Dans ce fichier, modifiez le paramètre WebAppRootKey ainsi :

    <context-param>
        <param-name>webAppRootKey</param-name>
        <param-value>/ligams</param-value>
    </context-param>

Compilation de l'application

Tout est prêt, vous pouvez désormais compiler votre application Red5 : Project puis build Project, ou sélectionnez Build automaticly, et cette application est désormais prête à fonctionner.

Eclipse : compilation d'application

Déploiement de l'application Red5 LigamsRed5App

Pour déployer cette application, créer un dossier ligams dans le répertoire webapps de Red5, puis placez y le dossier WEB-INF, et votre application est prête à fonctionner !

Téléchargement de l'application

Ce fichier contient :

• La source Java
• Les fichiers de configuration de l'appli
• Le fichier compilé