MessageOperationController.java

/*
 * Copyright (C) 2015
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

package org.cleverbus.admin.web.msg;

import org.cleverbus.core.common.asynch.msg.MessageOperationService;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.ui.ModelMap;
import org.springframework.web.bind.annotation.ModelAttribute;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RequestParam;


/**
 * Controller that maps request from the Admin GUI to the message operations:
 * <ul>
 *   <li>message restart based on the msgID and type.
 *   Restart of the message = update the state from FAILED/CANCEL -> PARTLY FAILED in table [message] and [external_call]</li>
 *   <li>message cancel - only NEW and PARTLY_FAILED messages can be canceled</li>
 * </ul>
 *
 * @author <a href="mailto:viliam.elischer@cleverlance.com">Viliam Elischer</a>
 * @author <a href="mailto:petr.juza@cleverlance.com">Petr Juza</a>
 */
@Controller
@RequestMapping("/operations")
public class MessageOperationController {

    private static final String VIEW_NAME = "msgOps";

    private static final String RESTART_RESULT_ATTR = "resultRestartString";

    private static final String CANCEL_RESULT_ATTR = "resultCancelString";

    /** Message operation service result states */

    private static final String OP_NF = "MESSAGE NOT FOUND";

    private static final String RESTART_OK = "RESTART PERFORMED";

    private static final String RESTART_NOK = "RESTART FAILED";

    private static final String CANCEL_OK = "CANCEL PERFORMED";

    private static final String CANCEL_NOK = "CANCEL FAILED";

    @Autowired
    private MessageOperationService service;

    @RequestMapping(value = "/messageOperations", method = RequestMethod.GET)
    public String showMessageOps(@ModelAttribute("model") ModelMap modelMap) {
        return VIEW_NAME;
    }

    /**
     * The restart method - gets input from web-user and calls a service method
     * for updating the DB record based on the MSG ID.
     * <p/>
     * By default, when the checkbox is on web send as empty = the default value is not annotation driven, but manually
     * setup to false.
     *
     * @param modelMap     default view object for adding data to the view resolver (FTL)
     * @param messageID    user-input form parameter, used in the restart operation
     * @param totalRestart user-input, if the message should be restarted from scratch
     * @return name of the view
     */
    @RequestMapping(value = "/restartMessage", method = RequestMethod.POST)
    public String restartMessage(@ModelAttribute("model") ModelMap modelMap,
                                 @RequestParam("messageID") Long messageID,
                                 @RequestParam(value = "totalRestart", required = false) Boolean totalRestart) {

        if (totalRestart == null) {
            totalRestart = false;
        }

        if (messageID == null) {
            modelMap.addAttribute(RESTART_RESULT_ATTR, OP_NF);
        } else {
            try {
                service.restartMessage(messageID, totalRestart);
                modelMap.addAttribute(RESTART_RESULT_ATTR, RESTART_OK);
            } catch (RuntimeException rex) {
                modelMap.addAttribute(RESTART_RESULT_ATTR, RESTART_NOK + ": " + rex.getMessage());
            }
        }
        return VIEW_NAME;
    }

    /**
     * Cancel next message processing.
     * Only NEW and PARTLY_FAILED messages can be canceled.
     *
     * @param modelMap     default view object for adding data to the view resolver (FTL)
     * @param messageID    the message ID
     * @return name of the view
     */
    @RequestMapping(value = "/cancelMessage", method = RequestMethod.POST)
    public String cancelMessage(@ModelAttribute("model") ModelMap modelMap, @RequestParam("messageID") Long messageID) {

        if (messageID == null) {
            modelMap.addAttribute(CANCEL_RESULT_ATTR, OP_NF);
        } else {
            try {
                service.cancelMessage(messageID);
                modelMap.addAttribute(CANCEL_RESULT_ATTR, CANCEL_OK);
            } catch (RuntimeException rex) {
                modelMap.addAttribute(CANCEL_RESULT_ATTR, CANCEL_NOK + ": " + rex.getMessage());
            }
        }

        return VIEW_NAME;
    }
}