org.openmrs.module.web.controller.ModulePropertiesFormController.java Source code

Introduction

Here is the source code for org.openmrs.module.web.controller.ModulePropertiesFormController.java

Source

/**
 * This Source Code Form is subject to the terms of the Mozilla Public License,
 * v. 2.0. If a copy of the MPL was not distributed with this file, You can
 * obtain one at http://mozilla.org/MPL/2.0/. OpenMRS is also distributed under
 * the terms of the Healthcare Disclaimer located at http://openmrs.org/license.
 *
 * Copyright (C) OpenMRS Inc. OpenMRS is a registered trademark and the OpenMRS
 * graphic logo is a trademark of OpenMRS Inc.
 */
package org.openmrs.module.web.controller;

import java.util.HashMap;
import java.util.Map;

import javax.servlet.ServletException;
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.openmrs.api.APIAuthenticationException;
import org.openmrs.api.context.Context;
import org.openmrs.module.ModuleConstants;
import org.openmrs.module.ModuleUtil;
import org.openmrs.util.PrivilegeConstants;
import org.openmrs.web.WebConstants;
import org.springframework.context.support.MessageSourceAccessor;
import org.springframework.validation.BindException;
import org.springframework.web.servlet.ModelAndView;
import org.springframework.web.servlet.mvc.SimpleFormController;
import org.springframework.web.servlet.view.RedirectView;

public class ModulePropertiesFormController extends SimpleFormController {

    /**
     * Logger for this class and subclasses
     */
    protected static final Log log = LogFactory.getLog(ModulePropertiesFormController.class);

    /**
     * The onSubmit function receives the form/command object that was modified by the input form
     * and saves it to the db
     *
     * @see org.springframework.web.servlet.mvc.SimpleFormController#onSubmit(HttpServletRequest,
     *      HttpServletResponse, Object,
     *      BindException)
     */
    protected ModelAndView onSubmit(HttpServletRequest request, HttpServletResponse response, Object command,
            BindException errors) throws Exception {

        if (!Context.hasPrivilege(PrivilegeConstants.MANAGE_MODULES)) {
            throw new APIAuthenticationException("Privilege required: " + PrivilegeConstants.MANAGE_MODULES);
        }

        HttpSession httpSession = request.getSession();
        String view = getFormView();
        String success = "";
        String error = "";

        view = getSuccessView();

        if (!"".equals(success)) {
            httpSession.setAttribute(WebConstants.OPENMRS_MSG_ATTR, success);
        }

        if (!"".equals(error)) {
            httpSession.setAttribute(WebConstants.OPENMRS_ERROR_ATTR, error);
        }

        return new ModelAndView(new RedirectView(view));
    }

    /**
     * This is called prior to displaying a form for the first time. It tells Spring the
     * form/command object to load into the request
     *
     * @see org.springframework.web.servlet.mvc.AbstractFormController#formBackingObject(HttpServletRequest)
     */
    protected Object formBackingObject(HttpServletRequest request) throws ServletException {
        return "not used";
    }

    @Override
    protected Map<String, String> referenceData(HttpServletRequest request) throws Exception {

        Map<String, String> map = new HashMap<String, String>();
        MessageSourceAccessor msa = getMessageSourceAccessor();

        map.put("allowUpload", ModuleUtil.allowAdmin().toString());
        map.put("disallowUploads", msa.getMessage("Module.disallowUploads",
                new String[] { ModuleConstants.RUNTIMEPROPERTY_ALLOW_UPLOAD }));

        return map;
    }

}