Java tutorial
/* * Copyright (c) 2002-2014, Mairie de Paris * All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * * 1. Redistributions of source code must retain the above copyright notice * and the following disclaimer. * * 2. Redistributions in binary form must reproduce the above copyright notice * and the following disclaimer in the documentation and/or other materials * provided with the distribution. * * 3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its * contributors may be used to endorse or promote products derived from * this software without specific prior written permission. * * 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 HOLDERS 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. * * License 1.0 */ package fr.paris.lutece.plugins.workflow.modules.notifymylutece.web; import fr.paris.lutece.plugins.workflow.modules.notifymylutece.business.TaskNotifyMyLuteceConfig; import fr.paris.lutece.plugins.workflow.modules.notifymylutece.business.notification.NotificationTypeFactory; import fr.paris.lutece.plugins.workflow.modules.notifymylutece.business.retrieval.IRetrievalTypeFactory; import fr.paris.lutece.plugins.workflow.modules.notifymylutece.service.INotifyMyLuteceService; import fr.paris.lutece.plugins.workflow.modules.notifymylutece.service.TaskNotifyMyLuteceConfigService; import fr.paris.lutece.plugins.workflow.modules.notifymylutece.util.constants.NotifyMyLuteceConstants; import fr.paris.lutece.plugins.workflow.service.WorkflowPlugin; import fr.paris.lutece.plugins.workflow.service.security.IWorkflowUserAttributesManager; import fr.paris.lutece.plugins.workflow.web.task.NoFormTaskComponent; import fr.paris.lutece.plugins.workflowcore.service.config.ITaskConfigService; import fr.paris.lutece.plugins.workflowcore.service.task.ITask; import fr.paris.lutece.portal.service.plugin.Plugin; import fr.paris.lutece.portal.service.plugin.PluginService; import fr.paris.lutece.portal.service.template.AppTemplateService; import fr.paris.lutece.portal.service.util.AppLogService; import fr.paris.lutece.portal.service.util.AppPathService; import fr.paris.lutece.portal.service.util.AppPropertiesService; import fr.paris.lutece.util.html.HtmlTemplate; import org.apache.commons.beanutils.BeanUtils; import org.apache.commons.lang.StringUtils; import java.lang.reflect.InvocationTargetException; import java.util.ArrayList; import java.util.Arrays; import java.util.HashMap; import java.util.List; import java.util.Locale; import java.util.Map; import javax.inject.Inject; import javax.inject.Named; import javax.servlet.http.HttpServletRequest; /** * * NotifyMyLuteceTaskComponent * */ public class NotifyMyLuteceTaskComponent extends NoFormTaskComponent { // PARAMETERS private static final String PARAMETER_APPLY = "apply"; // TEMPLATE private static final String TEMPLATE_TASK_NOTIFY_MYLUTECE_CONFIG = "admin/plugins/workflow/modules/notifymylutece/task_notify_mylutece_config.html"; // SERVICES @Inject @Named(TaskNotifyMyLuteceConfigService.BEAN_SERVICE) private ITaskConfigService _taskNotifyMyLuteceConfigService; @Inject private IWorkflowUserAttributesManager _userAttributesManager; @Inject private INotifyMyLuteceService _notifyMyLuteceService; @Inject private IRetrievalTypeFactory _retrievalTypeFactory; /** * {@inheritDoc} */ @Override public String doSaveConfig(HttpServletRequest request, Locale locale, ITask task) { // In case there are no errors, then the config is created/updated boolean bCreate = false; TaskNotifyMyLuteceConfig config = _taskNotifyMyLuteceConfigService.findByPrimaryKey(task.getId()); if (config == null) { config = new TaskNotifyMyLuteceConfig(); config.setIdTask(task.getId()); bCreate = true; } try { BeanUtils.populate(config, request.getParameterMap()); String strApply = request.getParameter(PARAMETER_APPLY); // Check if the AdminUser clicked on "Apply" or on "Save" if (StringUtils.isEmpty(strApply)) { String strJspError = validateConfig(config, request); if (StringUtils.isNotBlank(strJspError)) { return strJspError; } } // The method is overrided becaus of the following setter config.setListUserGuid(getSelectedUsers(request, config)); if (bCreate) { _taskNotifyMyLuteceConfigService.create(config); } else { _taskNotifyMyLuteceConfigService.update(config); } } catch (IllegalAccessException e) { AppLogService.error(e.getMessage(), e); } catch (InvocationTargetException e) { AppLogService.error(e.getMessage(), e); } return null; } /** * {@inheritDoc} */ @Override public String getDisplayConfigForm(HttpServletRequest request, Locale locale, ITask task) { TaskNotifyMyLuteceConfig config = _taskNotifyMyLuteceConfigService.findByPrimaryKey(task.getId()); String strDefaultSenderName = AppPropertiesService .getProperty(NotifyMyLuteceConstants.PROPERTY_DEFAULT_SENDER_NAME); Plugin pluginWorkflow = PluginService.getPlugin(WorkflowPlugin.PLUGIN_NAME); Map<String, Object> model = new HashMap<String, Object>(); model.put(NotifyMyLuteceConstants.MARK_CONFIG, config); model.put(NotifyMyLuteceConstants.MARK_DEFAULT_SENDER_NAME, strDefaultSenderName); model.put(NotifyMyLuteceConstants.MARK_LIST_ENTRIES, _notifyMyLuteceService.getListEntries(task.getId(), locale)); model.put(NotifyMyLuteceConstants.MARK_LIST_DIRECTORIES, _notifyMyLuteceService.getListDirectories()); model.put(NotifyMyLuteceConstants.MARK_LIST_ENTRIES_FREEMARKER, _notifyMyLuteceService.getListEntries(task.getId())); model.put(NotifyMyLuteceConstants.MARK_WEBAPP_URL, AppPathService.getBaseUrl(request)); model.put(NotifyMyLuteceConstants.MARK_LOCALE, locale); model.put(NotifyMyLuteceConstants.MARK_PLUGIN_WORKFLOW, pluginWorkflow); model.put(NotifyMyLuteceConstants.MARK_TASKS_LIST, _notifyMyLuteceService.getListBelowTasks(task, locale)); model.put(NotifyMyLuteceConstants.MARK_IS_USER_ATTRIBUTE_WS_ACTIVE, _userAttributesManager.isEnabled()); model.put(NotifyMyLuteceConstants.MARK_NOTIFICATION_TYPES, NotificationTypeFactory.getFactory().getNotificationTypes()); model.put(NotifyMyLuteceConstants.MARK_RETRIEVAL_TYPES, _retrievalTypeFactory.getRetrievalTypes()); model.put(NotifyMyLuteceConstants.MARK_AVAILABLE_USERS_LIST, _notifyMyLuteceService.getAvailableUsers(config)); model.put(NotifyMyLuteceConstants.MARK_SELECTED_USERS_LIST, _notifyMyLuteceService.getSelectedUsers(config)); HtmlTemplate template = AppTemplateService.getTemplate(TEMPLATE_TASK_NOTIFY_MYLUTECE_CONFIG, locale, model); return template.getHtml(); } /** * {@inheritDoc} */ @Override public String getDisplayTaskInformation(int nIdHistory, HttpServletRequest request, Locale locale, ITask task) { return null; } /** * {@inheritDoc} */ @Override public String getTaskInformationXml(int nIdHistory, HttpServletRequest request, Locale locale, ITask task) { return null; } // PRIVATE METHODS /** * Get the selected users * @param request the HTTP request * @param config the config * @return a list of User Guid */ private String[] getSelectedUsers(HttpServletRequest request, TaskNotifyMyLuteceConfig config) { // Init the list of user guid List<String> listUserGuid; if ((config.getListUserGuid() != null) && (config.getListUserGuid().length > 0)) { listUserGuid = new ArrayList<String>(Arrays.asList(config.getListUserGuid())); } else { listUserGuid = new ArrayList<String>(); } // Remove unselected users from the list String[] listUnselectedUsers = request.getParameterValues(NotifyMyLuteceConstants.PARAMETER_UNSELECT_USERS); if ((listUnselectedUsers != null) && (listUnselectedUsers.length > 0)) { if ((listUserGuid != null) && !listUserGuid.isEmpty()) { for (String strUserGuid : listUnselectedUsers) { listUserGuid.remove(strUserGuid); } } } // Add selected users String[] listSelectedUsers = request.getParameterValues(NotifyMyLuteceConstants.PARAMETER_SELECT_USERS); if ((listSelectedUsers != null) && (listSelectedUsers.length > 0)) { for (String strUserGuid : listSelectedUsers) { listUserGuid.add(strUserGuid); } } if ((listUserGuid != null) && !listUserGuid.isEmpty()) { return listUserGuid.toArray(new String[listUserGuid.size()]); } return null; } }