[Castore-commits] BaseCastorePortlet.java NONE 1.1 PortletConstants.java NONE 1.1

[Arnaud Thimel]

Update of /cvsroot/castore/castore-portlets/src/java/fr/emn/castor/portlets
In directory adullact1:/tmp/cvs-serv8222/src/java/fr/emn/castor/portlets

Added Files:
	BaseCastorePortlet.java PortletConstants.java 
Log Message:
Commit de castore-portlets

--- NEW FILE: PortletConstants.java ---
/*
 * $Id: PortletConstants.java,v 1.1 2006/06/14 18:27:59 thimel Exp $
 *
 * Plateforme CASTORE
 * CeCILL Copyright (C) 2005-2006 by EMN
 * Made by Stéphane Bouchet
 * Web site = http://www.emn.fr/castore
 * Contact = Cédric Dumas, e-mail = Cedric.Dumas at emn.fr
 *
 * Version 1.0 (1er mars 2005)
 *
 * Ce logiciel est un programme informatique servant à créer une plateforme
 * open-source de bibliothèque numérique XML pour Conserver, Valoriser et
 * Diffuser le patrimoine documentaire de votre institut.
 *
 * Ce logiciel est régi par la licence CeCILL soumise au droit français et
 * respectant les principes de diffusion des logiciels libres. Vous pouvez
 * utiliser, modifier et/ou redistribuer ce programme sous les conditions de la
 * licence CeCILL telle que diffusée par le CEA, le CNRS et l'INRIA sur le site
 * "http://www.cecill.info". En contrepartie de l'accessibilité au code source
 * et des droits de copie, de modification et de redistribution accordés par
 * cette licence, il n'est offert aux utilisateurs qu'une garantie limitée. Pour
 * les mêmes raisons, seule une responsabilité restreinte pèse sur l'auteur du
 * programme, le titulaire des droits patrimoniaux et les concédants successifs.
 * A cet égard l'attention de l'utilisateur est attirée sur les risques associés
 * au chargement, à l'utilisation, à la modification et/ou au développement et à
 * la reproduction du logiciel par l'utilisateur étant donné sa spécificité de
 * logiciel libre, qui peut le rendre complexe à manipuler et qui le réserve
 * donc à des développeurs et des professionnels avertis possédant des
 * connaissances informatiques approfondies. Les utilisateurs sont donc invités
 * à charger et tester l'adéquation du logiciel à leurs besoins dans des
 * conditions permettant d'assurer la sécurité de leurs systèmes et ou de leurs
 * données et, plus généralement, à l'utiliser et l'exploiter dans les mêmes
 * conditions de sécurité. Le fait que vous puissiez accéder à cet en-tête
 * signifie que vous avez pris connaissance de la licence CeCILL, et que vous en
 * avez accepté les termes.
 *
 */

package fr.emn.castor.portlets;

/**
 * Constantes propres aux portlets
 */
public class PortletConstants {

    /**
     * Type MIME HTML
     */
    public static final String MIME_HTML = "text/html";

    /**
     * Prefixe commun a toutes les pages
     */
    public static final String FOLDER_PREFIX = "/WEB-INF/pages/"; 

    /**
     * Espace de nommage pour les pages des documents
     */
    public static final String NS_DOCUMENTS = FOLDER_PREFIX + "docs/";

    /**
     * Espace de nommage pour les pages des colletions
     */
    public static final String NS_COLLECTIONS = FOLDER_PREFIX + "colls/";

    /**
     * Espace de nommage pour les pages des groupes
     */
    public static final String NS_GROUPS = FOLDER_PREFIX + "groups/";

    /**
     * Espace de nommage pour les pages de navigation
     */
    public static final String NS_NAVIGATION = FOLDER_PREFIX + "nav/";

    /**
     * Espace de nommage pour les pages de recherche
     */
    public static final String NS_SEARCH = FOLDER_PREFIX + "search/";

    /**
     * Espace de nommage pour les pages de soumission
     */
    public static final String NS_SOUMISSION = FOLDER_PREFIX + "soumission/";

    /**
     * Espace de nommage pour les pages de validation
     */
    public static final String NS_VALIDATION = FOLDER_PREFIX + "validation/";

    /**
     * Espace de nommage pour les pages d'accueil
     */
    public static final String NS_WELCOME = FOLDER_PREFIX + "welcome/";

    /**
     * Espace de nommage pour les pages communes
     */
    public static final String NS_COMMON = FOLDER_PREFIX + "common/";

    /**
     * Emplacement de la page d'acces refuse
     */
    public static final String ACCESS_DENIED = NS_COMMON + "accessDenied.jsp";

} //PortletConstants

--- NEW FILE: BaseCastorePortlet.java ---
/*
 * $Id: BaseCastorePortlet.java,v 1.1 2006/06/14 18:27:59 thimel Exp $
 *
 * Plateforme CASTORE
 * CeCILL Copyright (C) 2005-2006 by EMN
 * Made by Stéphane Bouchet
 * Web site = http://www.emn.fr/castore
 * Contact = Cédric Dumas, e-mail = Cedric.Dumas at emn.fr
 *
 * Version 1.0 (1er mars 2005)
 *
 * Ce logiciel est un programme informatique servant à créer une plateforme
 * open-source de bibliothèque numérique XML pour Conserver, Valoriser et
 * Diffuser le patrimoine documentaire de votre institut.
 *
 * Ce logiciel est régi par la licence CeCILL soumise au droit français et
 * respectant les principes de diffusion des logiciels libres. Vous pouvez
 * utiliser, modifier et/ou redistribuer ce programme sous les conditions de la
 * licence CeCILL telle que diffusée par le CEA, le CNRS et l'INRIA sur le site
 * "http://www.cecill.info". En contrepartie de l'accessibilité au code source
 * et des droits de copie, de modification et de redistribution accordés par
 * cette licence, il n'est offert aux utilisateurs qu'une garantie limitée. Pour
 * les mêmes raisons, seule une responsabilité restreinte pèse sur l'auteur du
 * programme, le titulaire des droits patrimoniaux et les concédants successifs.
 * A cet égard l'attention de l'utilisateur est attirée sur les risques associés
 * au chargement, à l'utilisation, à la modification et/ou au développement et à
 * la reproduction du logiciel par l'utilisateur étant donné sa spécificité de
 * logiciel libre, qui peut le rendre complexe à manipuler et qui le réserve
 * donc à des développeurs et des professionnels avertis possédant des
 * connaissances informatiques approfondies. Les utilisateurs sont donc invités
 * à charger et tester l'adéquation du logiciel à leurs besoins dans des
 * conditions permettant d'assurer la sécurité de leurs systèmes et ou de leurs
 * données et, plus généralement, à l'utiliser et l'exploiter dans les mêmes
 * conditions de sécurité. Le fait que vous puissiez accéder à cet en-tête
 * signifie que vous avez pris connaissance de la licence CeCILL, et que vous en
 * avez accepté les termes.
 *
 */

package fr.emn.castor.portlets;

import java.io.IOException;

import javax.portlet.ActionRequest;
import javax.portlet.ActionResponse;
import javax.portlet.GenericPortlet;
import javax.portlet.PortletException;
import javax.portlet.PortletRequest;
import javax.portlet.RenderRequest;
import javax.portlet.RenderResponse;

import org.apache.commons.logging.Log;

import fr.emn.castor.collections.ICollection;
import fr.emn.castor.common.CoreProxy;
import fr.emn.castor.documents.IDocuments;
import fr.emn.castor.groupes.IGroupe;
import fr.emn.castor.portlets.common.PortletUtils;
import fr.emn.castor.recherche.IRecherche;
import fr.emn.castor.users.IUser;

/**
 * Porlet de base du module. Toute methode non surchargee par les autres Portlet
 * affiche des logs.
 */
public abstract class BaseCastorePortlet extends GenericPortlet {

    /**
     * Renvoie l'instance de la facade de Documents 
     * @param request la request permettant de recuperer le 'remoteUser'
     * @return le singleton correspondant a la facade
     */
    public IDocuments getDocumentFacade(PortletRequest request) {
        return CoreProxy.getModuleDocuments(request.getRemoteUser());
    }

    /**
     * Renvoie l'instance de la facade de User 
     * @param request la request permettant de recuperer le 'remoteUser'
     * @return le singleton correspondant a la facade
     */
    public IUser getUserFacade(PortletRequest request) {
        return CoreProxy.getModuleUtilisateur(request.getRemoteUser());
    }

    /**
     * Renvoie l'instance de la facade de Collection 
     * @param request la request permettant de recuperer le 'remoteUser'
     * @return le singleton correspondant a la facade
     */
    public ICollection getCollectionFacade(PortletRequest request) {
        return CoreProxy.getModuleCollection(request.getRemoteUser());
    }

    /**
     * Renvoie l'instance de la facade de Groupe 
     * @param request la request permettant de recuperer le 'remoteUser'
     * @return le singleton correspondant a la facade
     */
    public IGroupe getGroupeFacade(PortletRequest request) {
        return CoreProxy.getModuleGroupe(request.getRemoteUser());
    }

    /**
     * Renvoie l'instance de la facade de Recherche 
     * @param request la request permettant de recuperer le 'remoteUser'
     * @return le singleton correspondant a la facade
     */
    public IRecherche getSearchFacade(PortletRequest request) {
        return CoreProxy.getModuleRecherche(request.getRemoteUser());
    }

    /**
     * @return le log personnalise pour la classe
     */
    public abstract Log getLog();

    /**
     * Loggue l'objet passe en parametre.
     * @param o
     */
    public void log(Object o) {
        PortletUtils.log(o, 0, getLog());
    }

    /**
     * @see javax.portlet.GenericPortlet#doEdit(
     * javax.portlet.RenderRequest, javax.portlet.RenderResponse)
     */
    @Override
    protected void doEdit(RenderRequest request, RenderResponse response)
            throws PortletException, IOException {
        log("edit");
    }

    /**
     * @see javax.portlet.GenericPortlet#doHelp(
     * javax.portlet.RenderRequest, javax.portlet.RenderResponse)
     */
    @Override
    protected void doHelp(RenderRequest request, RenderResponse response)
            throws PortletException, IOException {
        log("help");
    }

    /**
     * @see javax.portlet.GenericPortlet#doView(
     * javax.portlet.RenderRequest, javax.portlet.RenderResponse)
     */
    @Override
    protected void doView(RenderRequest request, RenderResponse response)
            throws PortletException, IOException {
        log("view");
    }

    /**
     * @see javax.portlet.GenericPortlet#processAction(
     * javax.portlet.ActionRequest, javax.portlet.ActionResponse)
     */
    @Override
    public void processAction(ActionRequest request, ActionResponse response)
            throws PortletException, IOException {
        log("processAction");
    }

} //BaseCastorePortlet