RegisteredServiceSimpleFormController.java

/*
 * Licensed to Jasig under one or more contributor license
 * agreements. See the NOTICE file distributed with this work
 * for additional information regarding copyright ownership.
 * Jasig licenses this file to you 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 the following location:
 *
 *   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.jasig.cas.services.web;

import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.validation.constraints.NotNull;

import org.jasig.cas.services.RegexRegisteredService;
import org.jasig.cas.services.RegisteredService;
import org.jasig.cas.services.RegisteredServiceImpl;
import org.jasig.cas.services.ServicesManager;
import org.jasig.services.persondir.IPersonAttributeDao;
import org.springframework.beans.propertyeditors.StringTrimmerEditor;
import org.springframework.util.StringUtils;
import org.springframework.validation.BindException;
import org.springframework.web.bind.ServletRequestDataBinder;
import org.springframework.web.servlet.ModelAndView;
import org.springframework.web.servlet.mvc.SimpleFormController;
import org.springframework.web.servlet.view.RedirectView;

/**
 * SimpleFormController to handle adding/editing of RegisteredServices.
 *
 * @author Scott Battaglia
 * @since 3.1
 */
public final class RegisteredServiceSimpleFormController extends SimpleFormController {

    /** Instance of ServiceRegistryManager. */
    @NotNull
    private final ServicesManager servicesManager;

    /** Instance of AttributeRegistry. */
    @NotNull
    private final IPersonAttributeDao personAttributeDao;

    public RegisteredServiceSimpleFormController(
            final ServicesManager servicesManager,
            final IPersonAttributeDao attributeRepository) {
        this.servicesManager = servicesManager;
        this.personAttributeDao = attributeRepository;
    }

    /**
     * {@inheritDoc}
     * Sets the require fields and the disallowed fields from the
     * HttpServletRequest.
     *
     * @see org.springframework.web.servlet.mvc.BaseCommandController#initBinder(javax.servlet.http.HttpServletRequest,
     * org.springframework.web.bind.ServletRequestDataBinder)
     */
    @Override
    protected void initBinder(final HttpServletRequest request,
            final ServletRequestDataBinder binder) throws Exception {
        binder.setRequiredFields(new String[] {"description", "serviceId",
                "name", "allowedToProxy", "enabled", "ssoEnabled",
                "anonymousAccess", "evaluationOrder"});
        binder.setDisallowedFields(new String[] {"id"});
        binder.registerCustomEditor(String.class, new StringTrimmerEditor(true));
    }

    /**
     * {@inheritDoc}
     * Adds the service to the ServiceRegistry via the ServiceRegistryManager.
     *
     * @see org.springframework.web.servlet.mvc.SimpleFormController#onSubmit(javax.servlet.http.HttpServletRequest,
     * javax.servlet.http.HttpServletResponse, java.lang.Object,
     * org.springframework.validation.BindException)
     */
    @Override
    protected ModelAndView onSubmit(final HttpServletRequest request,
            final HttpServletResponse response, final Object command,
            final BindException errors) throws Exception {
        RegisteredService service = (RegisteredService) command;


        if (service.getServiceId().startsWith("^") && service instanceof RegisteredServiceImpl) {
            logger.debug("Detected regular expression starting with ^");
            final RegexRegisteredService regexService = new RegexRegisteredService();
            regexService.copyFrom(service);
            service = regexService;
        } else if (!service.getServiceId().startsWith("^") && service instanceof RegexRegisteredService) {
            logger.debug("Detected ant expression " + service.getServiceId());
            final RegisteredServiceImpl regexService = new RegisteredServiceImpl();
            regexService.copyFrom(service);
            service = regexService;
        }
        
        this.servicesManager.save(service);
        logger.info("Saved changes to service " + service.getId());

        final ModelAndView modelAndView = new ModelAndView(new RedirectView(
                "manage.html#" + service.getId(), true));
        modelAndView.addObject("action", "add");
        modelAndView.addObject("id", service.getId());

        return modelAndView;
    }

    @Override
    protected Object formBackingObject(final HttpServletRequest request)
            throws Exception {
        final String id = request.getParameter("id");

        if (!StringUtils.hasText(id)) {
            // create a default RegisteredServiceImpl object if an explicit class isn't set
            final Object service;
            if (this.getCommandClass() != null) {
                service = this.createCommand();
            } else {
                service = new RegisteredServiceImpl();
            }
            logger.debug("Created new service of type " + service.getClass().getName());
            return service;
        }

        final RegisteredService service = this.servicesManager.findServiceBy(Long.parseLong(id));

        if (service != null) {
            setCommandClass(service.getClass());
            logger.debug("Loaded service " + service.getServiceId() + " with command class set to " + this.getCommandClass());
        } else {
            logger.debug("Invalid service id specified.");
        }

        return service;
    }

    /**
     * {@inheritDoc}
     * @see org.springframework.web.servlet.mvc.SimpleFormController#referenceData(javax.servlet.http.HttpServletRequest)
     */
    @Override
    protected Map<?, ?> referenceData(final HttpServletRequest request) throws Exception {

        final Map<String, Object> model = new HashMap<String, Object>();

        final List<String> possibleAttributeNames = new ArrayList<String>();
        possibleAttributeNames.addAll(this.personAttributeDao.getPossibleUserAttributeNames());
        Collections.sort(possibleAttributeNames);
        model.put("availableAttributes", possibleAttributeNames);

        final List<String> possibleUsernameAttributeNames = new ArrayList<String>();
        possibleUsernameAttributeNames.addAll(possibleAttributeNames);
        possibleUsernameAttributeNames.add(0, "");
        model.put("availableUsernameAttributes", possibleUsernameAttributeNames);


        model.put("pageTitle", getFormView());
        model.put("commandName", getCommandName());
        return model;
    }
}