/*
 * Copyright 2005 Frank W. Zammetti
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */


package org.apache.struts.apps.ajaxchat.action;


import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpSession;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.apache.struts.action.Action;
import org.apache.struts.action.ActionForm;
import org.apache.struts.action.ActionForward;
import org.apache.struts.action.ActionMapping;
import org.apache.struts.apps.ajaxchat.actionform.LobbyActionForm;
import org.apache.struts.apps.ajaxchat.dao.AjaxChatDAO;


/**
 * This is a Struts Action that shows the lobby screen.  Note that it is called
 * as a result of a user logging in, as well as continually via AJAX while the
 * user is in the lobby to update the room statistics (i.e, how many users are
 * chatting in each room).
 *
 * @author <a href="mailto:frank.zammetti@pfpc.com">Frank W. Zammetti</a>.
 */
public class LobbyAction extends Action {


  /**
   * Log instance.
   */
  private static Log log = LogFactory.getLog(LobbyAction.class);


  /**
   * Execute.
   *
   * @param  mapping   ActionMapping.
   * @param  inForm    ActionForm.
   * @param  request   HttpServletRequest.
   * @param  response  HttpServletResponse.
   * @return           ActionForward.
   * @throws Exception If anything goes wrong.
   */
  public ActionForward execute(ActionMapping mapping, ActionForm inForm,
    HttpServletRequest request, HttpServletResponse response) throws Exception {

    log.debug("execute()...");

    HttpSession session = request.getSession();
    synchronized (session) {

      // Get the list of rooms and add it to the ActionForm.
      AjaxChatDAO dao = AjaxChatDAO.getInstance();
      LobbyActionForm form = (LobbyActionForm)inForm;
      form.setRooms(dao.getRoomList());

      return mapping.findForward("showLobby");

    }

  } // End execute().


} // End class.