content: /**
   * Copyright (c) 2012-2018, Andy Janata
   * All rights reserved.
   *
   * Redistribution and use in source and binary forms, with or without modification, are permitted
   * provided that the following conditions are met:
   *
   * * Redistributions of source code must retain the above copyright notice, this list of conditions
   *   and the following disclaimer.
   * * Redistributions in binary form must reproduce the above copyright notice, this list of
   *   conditions and the following disclaimer in the documentation and/or other materials provided
   *   with the distribution.
   *
   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR
   * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
   * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
   * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
   * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
   * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
   * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY
   * WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
   */
  
  package net.socialgamer.cah.handlers;
  
  import java.util.HashMap;
  import java.util.Map;
  
  import javax.servlet.http.HttpSession;
  
  import net.socialgamer.cah.Constants.AjaxResponse;
  import net.socialgamer.cah.Constants.ErrorCode;
  import net.socialgamer.cah.Constants.ReturnableData;
  import net.socialgamer.cah.RequestWrapper;
  
  
  /**
   * Implementations of this interface MUST also have a public static final String OP. There will be
   * compile errors if they do not.
   *
   * @author Andy Janata (ajanata@socialgamer.net)
   */
  public abstract class Handler {
  
    /**
     * Handle a request.
     *
     * @param request
     *          The request parameters.
     * @param session
     *          The client's session.
     * @return Response data.
     */
    public abstract Map<ReturnableData, Object> handle(RequestWrapper request,
        HttpSession session);
  
    /**
     * Get a data set for an error response.
     *
     * @param errorCode
     *          The error code.
     * @return The data to return as the result of the request.
     */
    protected static Map<ReturnableData, Object> error(final ErrorCode errorCode) {
      final Map<ReturnableData, Object> data = new HashMap<ReturnableData, Object>();
      data.put(AjaxResponse.ERROR, Boolean.TRUE);
      data.put(AjaxResponse.ERROR_CODE, errorCode.toString());
      return data;
    }
  
    /**
     * Get a data set for an error response, with extra error information.
     * @param errorCode The error code.
     * @param extraData Additional data to return with the error.
     * @return The data to return as the result of the request.
     */
    protected static Map<ReturnableData, Object> error(final ErrorCode errorCode,
        final Map<ReturnableData, Object> extraData) {
      final Map<ReturnableData, Object> data = error(errorCode);
      data.putAll(extraData);
      return data;
    }
  }
  