editpersonaction.java

OPIAM stands for Open Identity and Access Management. This Suite will provide modules for user & rig

/*
 * OPIAM Suite
 *
 * Distributable under LGPL license.
 * See terms of license at gnu.org.
 */

package opiam.admin.applis.tutorial.actions;

import java.io.IOException;

import javax.servlet.ServletException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpSession;

import org.apache.log4j.Logger;
import org.apache.struts.action.ActionForm;
import org.apache.struts.action.ActionForward;
import org.apache.struts.action.ActionMapping;
import org.apache.struts.action.ActionMessage;
import org.apache.struts.action.ActionMessages;

import opiam.admin.applis.tutorial.beans.Person;
import opiam.admin.applis.tutorial.forms.PersonForm;
import opiam.admin.faare.persistence.javabeans.JBTop;
import opiam.admin.faare.service.UserContext;
import opiam.admin.faare.service.services.StandardService;
import opiam.admin.faare.struts.actions.SecureAction;
import opiam.admin.faare.struts.utils.SessionContext;

/**
 * This class allows to edit a person entry.
 *
 * This Action class inherits from SecureAction class.
 * The SecureAction class checks that the user is connected before calling
 * the action methods.
 */
public class EditPersonAction extends SecureAction
{
    /** Instance of the log4j logger.
     * Used to generate the execution traces. */
    private static Logger _logger =
        Logger.getLogger(EditPersonAction.class);

    /**
     * This method is called to execute the action once the checks have been
     * performed by the SecureAction class.
     *
     * @param mapping              Struts mapping data.
     * @param actionForm           FormBean associated with the action.
     * @param request              HTTP request.
     * @param httpServletResponse  HTTP response.
     *
     * @return An ActionForward.
     *
     * @throws IOException if failed or interrupted I/O operations occurs.
     * @throws ServletException if the servlet has a problem.
     */
    public ActionForward secureExecute(ActionMapping mapping,
        ActionForm actionForm,
        HttpServletRequest request,
        HttpServletResponse httpServletResponse)
        throws IOException, ServletException
    {
        SessionContext sessionContext = null;
        UserContext userContext = null;
        ActionMessages msgErrors = new ActionMessages();

        // Gets the dn value from the request.
        String dn = request.getParameter("dn");

        // Writes the operation on the output defined in the
        // logger_config.properties.
        _logger.info("Edit the person : " + dn);
        try
        {
            // Gets the session.
            HttpSession session = request.getSession();
            // Gets the session context.
            sessionContext = SessionContext.getInstance(session);
            // Gets the user context.
            userContext = sessionContext.getUserContext();

            // Loads the entry from the given dn.
            JBTop loadedObj = StandardService.load(dn, userContext);
            // Converts the entry into a person entry.
            Person person = (Person) loadedObj;

            // Clones the entry to allow to do a roolback if an error occurs.
            // The clone also allows to manage the concurrent access.
            Person pclone = (Person) person.clone();

            // Adds the cloned person entry in the formBean.
            PersonForm user = new PersonForm();
            user.setUser(pclone);

            // Sets the formBean "PersonForm" in the session with the
            // "modifyPersonForm" name.
            // This name is used in the jsp page by the Struts tags to
            // recover the attributes values of the person entry.
            session.setAttribute("modifyPersonForm", user);

            // Returns the Action-Forward corresponding to the action success
            // as defined in the action configuration in the struts-config.xml.
            return mapping.findForward("success");

        }
        catch (Exception se)
        {
            // Writes the error on the standard ouput console.
            se.printStackTrace();

            // Writes the error on the output defined in the
            // logger_config.properties.
            _logger.error(se.getMessage());

            // Gets the error message from the message-resources file
            // defined in the struts-config.xml
            msgErrors.add(ActionMessages.GLOBAL_MESSAGE,
               new ActionMessage("error.service.unknown"));
            // Save the error message in the request to display it in the jsp
            // page.
            saveErrors(request, msgErrors);

            // Returns the Action-Forward corresponding to the error
            return (mapping.findForward("error"));
        }
    }
}