searchaction.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.demo.actions;

import opiam.admin.applis.demo.beans.Person;
import opiam.admin.applis.demo.forms.SearchForm;

import opiam.admin.faare.SearchResult;
import opiam.admin.faare.service.UserContext;
import opiam.admin.faare.service.services.SortService;
import opiam.admin.faare.service.services.StandardService;
import opiam.admin.faare.struts.actions.SecureAction;
import opiam.admin.faare.struts.service.StrutsService;
import opiam.admin.faare.struts.utils.SessionContext;

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 javax.servlet.ServletException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpSession;

import java.io.IOException;

import java.util.List;


/**
 * This class allows to perform the search.
 */
public class SearchAction extends SecureAction
{
    /** Instance of the log4j logger.
     * Used to generate the execution traces. */
    private static Logger _logger =
        Logger.getLogger(ProfileAction.class.getName());

    /**
     * This method is called to execute the action.
     *
     * @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  An I/O exception if failed or interrupted I/O operations occurs.
     * @throws ServletException  A 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();

        try
        {
            // Gets the session.
            HttpSession session = request.getSession();

            // Gets the session context.
            sessionContext = SessionContext.getInstance(session);

            // Gets the user context.
            userContext = sessionContext.getUserContext();

            String sessionResultName = "searchResult";

            // Removes the "searchResult" attribute in the session.
            session.removeAttribute(sessionResultName);

            // Removes the "currentEntry" attribute in the session.
            session.removeAttribute("currentEntry");

            // Gets the search type
            String searchType = (String) request.getParameter("searchType");

            // Checks if at least one field is not empty.
            // Returns to the search page if all the fields are empty.
            SearchForm sf = (SearchForm) actionForm;

            if (((sf.getGivenName() == null) ||
                    (sf.getGivenName().trim().compareToIgnoreCase("") == 0)) &&
                    ((sf.getName() == null) ||
                    (sf.getName().trim().compareToIgnoreCase("") == 0)) &&
                    ((sf.getPhone() == null) ||
                    (sf.getPhone().trim().compareToIgnoreCase("") == 0)) &&
                    ((sf.getId() == null) ||
                    (sf.getId().trim().compareToIgnoreCase("") == 0)) &&
                    ((sf.getDepartment() == null) ||
                    (sf.getDepartment().trim().compareToIgnoreCase("") == 0)) &&
                    ((sf.getSite() == null) ||
                    (sf.getSite().trim().compareToIgnoreCase("") == 0)) &&
                    ((sf.getGeneric() == null) ||
                    (sf.getGeneric().trim().compareToIgnoreCase("") == 0))
               )
            {
                // Returns the URI corresponding to the action success
                // as defined in the action configuration in the
                // struts-config.xml.
                if (searchType.equals("quick"))
                {
                    return (mapping.findForward("quickSearch"));
                }
                else
                {
                    return (mapping.findForward("success"));
                }
            }

            // Creates the search parameters from the "personSearch" request
            // defined in the requests_conf.xml.
            List args =
                StrutsService.getSearchArgument("personSearch", actionForm,
                                                sessionContext.getUserContext()
                                               );

            // Calls the StandardService to search the entries.
            SearchResult searchResult =
                StandardService.search(args, sessionContext.getUserContext());

            // writes the results number on the output defined in the
            // logger_config.properties.
            _logger.debug("***** result size = " +
                          searchResult.getLResults().size()
                         );

            // If there is only one result, returns the visualization page.
            if (searchResult.getLResults().size() == 1)
            {
                // Gets the entry.
                Object loadedObj = searchResult.getLResults().get(0);

                // Sets the found entry in the session.
                Person person = (Person) loadedObj;

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

                // Returns the URI corresponding to the action success_one
                // as defined in the action configuration in the
                // struts-config.xml.
                return (mapping.findForward("success_oneperson"));
            }

            // Calls the SortService to sort the results list according to the
            // "name" attribute.
            SortService.sort(searchResult.getLResults(), Person.class, "name",
                             sessionContext.getUserContext()
                            );

            // You can also use the search method of the StandardService class
            // which allows to sort the search results according to an
            // attributes array.
            // Sets the result of the search on the session.
            session.setAttribute(sessionResultName, searchResult);

            // Returns the URI corresponding to the action success
            // as defined in the action configuration in the struts-config.xml.
            return (mapping.findForward("success"));
        }
        catch (Exception se)
        {
            _logger.error(se.getMessage());
            msgErrors.add(ActionMessages.GLOBAL_MESSAGE,
                          new ActionMessage("error.service.unknown")
                         );
            saveErrors(request, msgErrors);

            return (mapping.findForward("service_error"));
        }
    }
}