Coverage Report - org.kuali.rice.kew.preferences.service.impl.PreferencesServiceImpl
 
Classes in this File Line Coverage Branch Coverage Complexity
PreferencesServiceImpl
0%
0/146
0%
0/32
5.2
 
 1   
 /*
 2   
  * Copyright 2005-2007 The Kuali Foundation
 3   
  *
 4   
  *
 5   
  * Licensed under the Educational Community License, Version 2.0 (the "License");
 6   
  * you may not use this file except in compliance with the License.
 7   
  * You may obtain a copy of the License at
 8   
  *
 9   
  * http://www.opensource.org/licenses/ecl2.php
 10   
  *
 11   
  * Unless required by applicable law or agreed to in writing, software
 12   
  * distributed under the License is distributed on an "AS IS" BASIS,
 13   
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 14   
  * See the License for the specific language governing permissions and
 15   
  * limitations under the License.
 16   
  */
 17   
 package org.kuali.rice.kew.preferences.service.impl;
 18   
 
 19   
 import java.util.ArrayList;
 20   
 import java.util.Collection;
 21   
 import java.util.HashMap;
 22   
 import java.util.Map;
 23   
 
 24   
 import org.apache.commons.lang.StringUtils;
 25   
 import org.kuali.rice.core.config.Config;
 26   
 import org.kuali.rice.core.config.ConfigContext;
 27   
 import org.kuali.rice.kew.exception.WorkflowServiceErrorException;
 28   
 import org.kuali.rice.kew.exception.WorkflowServiceErrorImpl;
 29   
 import org.kuali.rice.kew.preferences.Preferences;
 30   
 import org.kuali.rice.kew.preferences.service.PreferencesService;
 31   
 import org.kuali.rice.kew.service.KEWServiceLocator;
 32   
 import org.kuali.rice.kew.useroptions.UserOptions;
 33   
 import org.kuali.rice.kew.useroptions.UserOptionsService;
 34   
 import org.kuali.rice.kew.util.KEWConstants;
 35   
 import org.kuali.rice.kns.service.KNSServiceLocator;
 36   
 import org.kuali.rice.kns.service.KualiConfigurationService;
 37   
 
 38   
 
 39   
 /**
 40   
  * An implementation of the {@link PreferencesService}.
 41   
  *
 42   
  * @author Kuali Rice Team (rice.collab@kuali.org)
 43   
  */
 44  0 
 public class PreferencesServiceImpl implements PreferencesService {
 45   
 
 46  0 
     private static final org.apache.log4j.Logger LOG = org.apache.log4j.Logger.getLogger(PreferencesServiceImpl.class);
 47   
 
 48   
     private static final String DISAPPROVED_DOC_COLOR = "DOCUMENT_STATUS_COLOR_D";
 49   
     private static final String DISSAPPROVED_CANCELLED_DOC_COLOR = "DOCUMENT_STATUS_COLOR_C";
 50   
     private static final String APPROVED_DOC_COLOR = "DOCUMENT_STATUS_COLOR_A";
 51   
     private static final String CANCELLED_DOC_COLOR = "DOCUMENT_STATUS_COLOR_X";
 52   
     private static final String SAVED_DOC_COLOR = "DOCUMENT_STATUS_COLOR_S";
 53   
     private static final String ENROUTE_DOC_COLOR = "DOCUMENT_STATUS_COLOR_R";
 54   
     private static final String PROCESSED_DOC_COLOR = "DOCUMENT_STATUS_COLOR_P";
 55   
     private static final String INITIATED_DOC_COLOR = "DOCUMENT_STATUS_COLOR_I";
 56   
     private static final String FINAL_DOC_COLOR = "DOCUMENT_STATUS_COLOR_F";
 57   
     private static final String EXCEPTION_DOC_COLOR = "DOCUMENT_STATUS_COLOR_E";
 58   
     private static final String REFRESH_RATE_KEY = "REFRESH_RATE";
 59   
     private static final String OPEN_NEW_WINDOW_KEY = "OPEN_ITEMS_NEW_WINDOW";
 60   
     private static final String COLUMN_DOC_TYPE_KEY = "DOC_TYPE_COL_SHOW_NEW";
 61   
     private static final String COLUMN_TITLE_KEY = "TITLE_COL_SHOW_NEW";
 62   
     private static final String COLUMN_ACTION_REQ_KEY = "ACTION_REQUESTED_COL_SHOW_NEW";
 63   
     private static final String COLUMN_INITIATOR_KEY = "INITIATOR_COL_SHOW_NEW";
 64   
     private static final String COLUMN_DELEGATOR_KEY = "DELEGATOR_COL_SHOW_NEW";
 65   
     private static final String COLUMN_DATE_CREATE_KEY = "DATE_CREATED_COL_SHOW_NEW";
 66   
     private static final String COLUMN_DOCUMENT_STATUS_KEY = "DOCUMENT_STATUS_COL_SHOW_NEW";
 67   
     private static final String COLUMN_APP_DOC_STATUS_KEY = "APP_DOC_STATUS_COL_SHOW_NEW";
 68   
     private static final String COLUMN_WORKGROUP_REQUEST_KEY = "WORKGROUP_REQUEST_COL_SHOW_NEW";
 69   
     private static final String COLUMN_CLEAR_FYI_KEY = "CLEAR_FYI_COL_SHOW_NEW";
 70   
     private static final String ACTION_LIST_SIZE_KEY = "ACTION_LIST_SIZE_NEW";
 71   
     private static final String EMAIL_REMINDER_KEY = KEWConstants.EMAIL_RMNDR_KEY;
 72   
     private static final String EMAIL_NOTIFY_PRIMARY_KEY = "EMAIL_NOTIFY_PRIMARY";
 73   
     private static final String EMAIL_NOTIFY_SECONDARY_KEY = "EMAIL_NOTIFY_SECONDARY";
 74   
     private static final String DEFAULT_COLOR = "white";
 75   
     private static final String DEFAULT_ACTION_LIST_SIZE = "10";
 76   
     private static final String DEFAULT_REFRESH_RATE = "15";
 77   
     private static final String ERR_KEY_REFRESH_RATE_WHOLE_NUM = "preferences.refreshRate";
 78   
     private static final String ERR_KEY_ACTION_LIST_PAGE_SIZE_WHOLE_NUM = "preferences.pageSize";
 79   
     private static final String DELEGATOR_FILTER_KEY = "DELEGATOR_FILTER";
 80   
     private static final String PRIMARY_DELEGATE_FILTER_KEY = "PRIMARY_DELEGATE_FILTER";
 81   
     public static final String USE_OUT_BOX = "USE_OUT_BOX";
 82   
     private static final String COLUMN_LAST_APPROVED_DATE_KEY = "LAST_APPROVED_DATE_COL_SHOW_NEW";
 83   
 
 84   
     public static final String COLUMN_CURRENT_NODE_KEY = "CURRENT_NODE_COL_SHOW_NEW";
 85   
 
 86   
     public Preferences getPreferences(String principalId) {
 87  0 
         if ( LOG.isDebugEnabled() ) {
 88  0 
         LOG.debug("start preferences fetch user " + principalId);
 89   
         }
 90  0 
         Collection<UserOptions> options = getUserOptionService().findByWorkflowUser(principalId);
 91  0 
         Map<String,UserOptions> optionMap = new HashMap<String, UserOptions>();
 92  0 
         for ( UserOptions option : options ) {
 93  0 
                 optionMap.put(option.getOptionId(), option);
 94   
         }
 95   
 
 96  0 
         KualiConfigurationService kcs = KNSServiceLocator.getKualiConfigurationService();
 97   
 
 98  0 
         String stagingDirectory = kcs.getPropertyString("staging.directory");
 99   
 
 100  0 
         String defaultColor =  kcs.getPropertyString("userOptions.default.color");
 101  0 
         String defaultEmail = kcs.getPropertyString("userOptions.default.email");
 102  0 
         String defaultNotifyPrimary = kcs.getPropertyString("userOptions.default.notifyPrimary");
 103  0 
         String defaultNotifySecondary = kcs.getPropertyString("userOptions.default.notifySecondary");
 104  0 
         String defaultOpenNewWindow = kcs.getPropertyString("userOptions.default.openNewWindow");
 105  0 
         String defaultActionListSize = kcs.getPropertyString("userOptions.default.actionListSize");
 106  0 
         String defaultRefreshRate = kcs.getPropertyString("userOptions.default.refreshRate");
 107  0 
         String defaultShowActionRequired = kcs.getPropertyString("userOptions.default.showActionRequired");
 108  0 
         String defaultShowDateCreated = kcs.getPropertyString("userOptions.default.showDateCreated");
 109  0 
         String defaultShowDocType = kcs.getPropertyString("userOptions.default.showDocumentType");
 110  0 
         String defaultShowDocStatus = kcs.getPropertyString("userOptions.default.showDocumentStatus");
 111  0 
         String defaultShowInitiator = kcs.getPropertyString("userOptions.default.showInitiator");
 112  0 
         String defaultShowDelegator = kcs.getPropertyString("userOptions.default.showDelegator");
 113  0 
         String defaultShowTitle = kcs.getPropertyString("userOptions.default.showTitle");
 114  0 
         String defaultShowWorkgroupRequest = kcs.getPropertyString("userOptions.default.showWorkgroupRequest");
 115  0 
         String defaultShowLastApprovedDate = kcs.getPropertyString("userOptions.default.showLastApprovedDate");
 116  0 
         String defaultShowClearFYI = kcs.getPropertyString("userOptions.default.showClearFYI");
 117  0 
         String defaultShowCurrentNode = kcs.getPropertyString("userOptions.default.showCurrentNode");
 118  0 
         String defaultDelegatorFilterOnActionList = kcs.getPropertyString("userOptions.default.delegatorFilterOnActionList");
 119  0 
         String defaultPrimaryDelegatorFilterOnActionList = kcs.getPropertyString("userOptions.default.primaryDelegatorFilterOnActionList");
 120   
 
 121   
         // TODO: remove the old deprecated OUT_BOX_DEFAULT_PREFERENCE_ON usage in a future version
 122   
         // see KULRICE-4582
 123   
 
 124  0 
         String defaultUseOutBox = ConfigContext.getCurrentContextConfig().getProperty(Config.OUT_BOX_DEFAULT_PREFERENCE_ON);
 125  0 
         if (!StringUtils.isBlank(defaultUseOutBox)) {
 126  0 
                 if (Boolean.valueOf(defaultUseOutBox)) {
 127  0 
                         defaultUseOutBox = "yes";
 128   
                 } else {
 129  0 
                         defaultUseOutBox = "no";
 130   
                 }
 131   
         } else {
 132  0 
                 defaultUseOutBox = kcs.getPropertyString("userOptions.default.useOutBox");
 133   
         }
 134   
 
 135  0 
         Preferences preferences = new Preferences();
 136  0 
         preferences.setColorApproved(getOption(optionMap,APPROVED_DOC_COLOR, defaultColor, principalId, preferences).getOptionVal());
 137  0 
         preferences.setColorCanceled(getOption(optionMap,CANCELLED_DOC_COLOR, defaultColor, principalId, preferences).getOptionVal());
 138  0 
         preferences.setColorDissapproveCancel(getOption(optionMap,DISSAPPROVED_CANCELLED_DOC_COLOR, defaultColor, principalId, preferences).getOptionVal());
 139  0 
         preferences.setColorDissaproved(getOption(optionMap,DISAPPROVED_DOC_COLOR, defaultColor, principalId, preferences).getOptionVal());
 140  0 
         preferences.setColorEnroute(getOption(optionMap,ENROUTE_DOC_COLOR, defaultColor, principalId, preferences).getOptionVal());
 141  0 
         preferences.setColorException(getOption(optionMap,EXCEPTION_DOC_COLOR, defaultColor, principalId, preferences).getOptionVal());
 142  0 
         preferences.setColorFinal(getOption(optionMap,FINAL_DOC_COLOR, defaultColor, principalId, preferences).getOptionVal());
 143  0 
         preferences.setColorInitiated(getOption(optionMap,INITIATED_DOC_COLOR, defaultColor, principalId, preferences).getOptionVal());
 144  0 
         preferences.setColorProccessed(getOption(optionMap,PROCESSED_DOC_COLOR, defaultColor, principalId, preferences).getOptionVal());
 145  0 
         preferences.setColorSaved(getOption(optionMap,SAVED_DOC_COLOR, defaultColor, principalId, preferences).getOptionVal());
 146  0 
         preferences.setEmailNotification(getOption(optionMap,EMAIL_REMINDER_KEY, defaultEmail, principalId, preferences).getOptionVal());
 147  0 
         preferences.setNotifyPrimaryDelegation(getOption(optionMap,EMAIL_NOTIFY_PRIMARY_KEY, defaultNotifyPrimary, principalId, preferences).getOptionVal());
 148  0 
         preferences.setNotifySecondaryDelegation(getOption(optionMap,EMAIL_NOTIFY_SECONDARY_KEY, defaultNotifySecondary, principalId, preferences).getOptionVal());
 149  0 
         preferences.setOpenNewWindow(getOption(optionMap,OPEN_NEW_WINDOW_KEY, defaultOpenNewWindow, principalId, preferences).getOptionVal());
 150  0 
         preferences.setPageSize(getOption(optionMap,ACTION_LIST_SIZE_KEY, defaultActionListSize, principalId, preferences).getOptionVal());
 151  0 
         preferences.setRefreshRate(getOption(optionMap,REFRESH_RATE_KEY, defaultRefreshRate, principalId, preferences).getOptionVal());
 152  0 
         preferences.setShowActionRequested(getOption(optionMap,COLUMN_ACTION_REQ_KEY, defaultShowActionRequired, principalId, preferences).getOptionVal());
 153  0 
         preferences.setShowDateCreated(getOption(optionMap,COLUMN_DATE_CREATE_KEY, defaultShowDateCreated, principalId, preferences).getOptionVal());
 154  0 
         preferences.setShowDocType(getOption(optionMap,COLUMN_DOC_TYPE_KEY, defaultShowDocType, principalId, preferences).getOptionVal());
 155  0 
         preferences.setShowDocumentStatus(getOption(optionMap,COLUMN_DOCUMENT_STATUS_KEY, defaultShowDocStatus, principalId, preferences).getOptionVal());
 156  0 
         preferences.setShowInitiator(getOption(optionMap,COLUMN_INITIATOR_KEY, defaultShowInitiator, principalId, preferences).getOptionVal());
 157  0 
         preferences.setShowDelegator(getOption(optionMap,COLUMN_DELEGATOR_KEY, defaultShowDelegator, principalId, preferences).getOptionVal());
 158  0 
         preferences.setShowDocTitle(getOption(optionMap,COLUMN_TITLE_KEY, defaultShowTitle, principalId, preferences).getOptionVal());
 159  0 
         preferences.setShowWorkgroupRequest(getOption(optionMap,COLUMN_WORKGROUP_REQUEST_KEY, defaultShowWorkgroupRequest, principalId, preferences).getOptionVal());
 160  0 
         preferences.setShowClearFyi(getOption(optionMap,COLUMN_CLEAR_FYI_KEY, defaultShowClearFYI, principalId, preferences).getOptionVal());
 161  0 
         preferences.setDelegatorFilter(getOption(optionMap,DELEGATOR_FILTER_KEY, defaultDelegatorFilterOnActionList, principalId, preferences).getOptionVal());
 162  0 
         preferences.setPrimaryDelegateFilter(getOption(optionMap,PRIMARY_DELEGATE_FILTER_KEY, defaultPrimaryDelegatorFilterOnActionList, principalId, preferences).getOptionVal());
 163  0 
         preferences.setShowDateApproved(getOption(optionMap,COLUMN_LAST_APPROVED_DATE_KEY, defaultShowLastApprovedDate, principalId, preferences).getOptionVal());
 164  0 
         preferences.setShowCurrentNode(getOption(optionMap,COLUMN_CURRENT_NODE_KEY, defaultShowCurrentNode, principalId, preferences).getOptionVal());
 165  0 
         preferences.setUseOutbox(getOption(optionMap,USE_OUT_BOX, defaultUseOutBox, principalId, preferences).getOptionVal());
 166   
 
 167  0 
         if ( LOG.isDebugEnabled() ) {
 168  0 
         LOG.debug("end preferences fetch user " + principalId);
 169   
         }
 170  0 
         return preferences;
 171   
     }
 172   
 
 173   
     /* @see https://test.kuali.org/jira/browse/KULRICE-1726 */
 174   
     //private static ConcurrencyDetector detector = new ConcurrencyDetector("Concurrency in PreferencesServiceImpl", false);
 175   
 
 176   
     private UserOptions getOption(Map<String,UserOptions> optionsMap, String optionKey, String defaultValue, String principalId, Preferences preferences) {
 177  0 
             if ( LOG.isDebugEnabled() ) {
 178  0 
         LOG.debug("start fetch option " + optionKey + " user " + principalId);
 179   
             }
 180  0 
         UserOptions option = optionsMap.get(optionKey);
 181  0 
         if (option == null) {
 182  0 
                 if ( LOG.isDebugEnabled() ) {
 183  0 
             LOG.debug("User option '" + optionKey + "' on user " + principalId + " has no stored value.  Preferences will require save.");
 184   
                 }
 185  0 
             option = new UserOptions();
 186  0 
             option.setWorkflowId(principalId);
 187  0 
             option.setOptionId(optionKey);
 188  0 
             option.setOptionVal(defaultValue);
 189  0 
             optionsMap.put(optionKey, option); // just in case referenced a second time
 190  0 
             if ( optionKey.equals(USE_OUT_BOX) && !ConfigContext.getCurrentContextConfig().getOutBoxOn() ) {
 191   
                     // don't mark as needing save
 192   
             } else {
 193  0 
             preferences.setRequiresSave(true);
 194   
         }
 195   
         }
 196  0 
         if ( LOG.isDebugEnabled() ) {
 197  0 
         LOG.debug("End fetch option " + optionKey + " user " + principalId);
 198   
         }
 199  0 
         return option;
 200   
     }
 201   
 
 202   
     public void savePreferences(String principalId, Preferences preferences) {
 203   
             // NOTE: this previously displayed the principalName.  Now it's just the id
 204  0 
             if ( LOG.isDebugEnabled() ) {
 205  0 
         LOG.debug("saving preferences user " + principalId);
 206   
             }
 207   
 
 208  0 
         validate(preferences);
 209  0 
         Map<String,String> optionsMap = new HashMap<String,String>(50);
 210   
 
 211  0 
         optionsMap.put(DISSAPPROVED_CANCELLED_DOC_COLOR, preferences.getColorDissapproveCancel());
 212  0 
         optionsMap.put(DISAPPROVED_DOC_COLOR, preferences.getColorDissaproved());
 213  0 
         optionsMap.put(APPROVED_DOC_COLOR, preferences.getColorApproved());
 214  0 
         optionsMap.put(CANCELLED_DOC_COLOR, preferences.getColorCanceled());
 215  0 
         optionsMap.put(SAVED_DOC_COLOR, preferences.getColorSaved());
 216  0 
         optionsMap.put(ENROUTE_DOC_COLOR, preferences.getColorEnroute());
 217  0 
         optionsMap.put(PROCESSED_DOC_COLOR, preferences.getColorProccessed());
 218  0 
         optionsMap.put(INITIATED_DOC_COLOR, preferences.getColorInitiated());
 219  0 
         optionsMap.put(FINAL_DOC_COLOR, preferences.getColorFinal());
 220  0 
         optionsMap.put(EXCEPTION_DOC_COLOR, preferences.getColorException());
 221  0 
         optionsMap.put(REFRESH_RATE_KEY, preferences.getRefreshRate().trim());
 222  0 
         optionsMap.put(OPEN_NEW_WINDOW_KEY, preferences.getOpenNewWindow());
 223  0 
         optionsMap.put(COLUMN_DOC_TYPE_KEY, preferences.getShowDocType());
 224  0 
         optionsMap.put(COLUMN_TITLE_KEY, preferences.getShowDocTitle());
 225  0 
         optionsMap.put(COLUMN_ACTION_REQ_KEY, preferences.getShowActionRequested());
 226  0 
         optionsMap.put(COLUMN_INITIATOR_KEY, preferences.getShowInitiator());
 227  0 
         optionsMap.put(COLUMN_DELEGATOR_KEY, preferences.getShowDelegator());
 228  0 
         optionsMap.put(COLUMN_DATE_CREATE_KEY, preferences.getShowDateCreated());
 229  0 
         optionsMap.put(COLUMN_DOCUMENT_STATUS_KEY, preferences.getShowDocumentStatus());
 230  0 
         optionsMap.put(COLUMN_APP_DOC_STATUS_KEY, preferences.getShowAppDocStatus());
 231  0 
         optionsMap.put(COLUMN_WORKGROUP_REQUEST_KEY, preferences.getShowWorkgroupRequest());
 232  0 
         optionsMap.put(COLUMN_CLEAR_FYI_KEY, preferences.getShowClearFyi());
 233  0 
         optionsMap.put(ACTION_LIST_SIZE_KEY, preferences.getPageSize().trim());
 234  0 
         optionsMap.put(EMAIL_REMINDER_KEY, preferences.getEmailNotification());
 235  0 
         optionsMap.put(EMAIL_NOTIFY_PRIMARY_KEY, preferences.getNotifyPrimaryDelegation());
 236  0 
         optionsMap.put(EMAIL_NOTIFY_SECONDARY_KEY, preferences.getNotifySecondaryDelegation());
 237  0 
         optionsMap.put(DELEGATOR_FILTER_KEY, preferences.getDelegatorFilter());
 238  0 
         optionsMap.put(PRIMARY_DELEGATE_FILTER_KEY, preferences.getPrimaryDelegateFilter());
 239  0 
         optionsMap.put(COLUMN_LAST_APPROVED_DATE_KEY, preferences.getShowDateApproved());
 240  0 
         optionsMap.put(COLUMN_CURRENT_NODE_KEY, preferences.getShowCurrentNode());
 241  0 
         if (ConfigContext.getCurrentContextConfig().getOutBoxOn()) {
 242  0 
             optionsMap.put(USE_OUT_BOX, preferences.getUseOutbox());
 243   
         }
 244  0 
         getUserOptionService().save(principalId, optionsMap);
 245  0 
         if ( LOG.isDebugEnabled() ) {
 246  0 
         LOG.debug("saved preferences user " + principalId);
 247   
     }
 248  0 
     }
 249   
 
 250   
     private void validate(Preferences preferences) {
 251  0 
         LOG.debug("validating preferences");
 252   
 
 253  0 
         Collection errors = new ArrayList();
 254   
         try {
 255  0 
             new Integer(preferences.getRefreshRate().trim());
 256  0 
         } catch (NumberFormatException e) {
 257  0 
             errors.add(new WorkflowServiceErrorImpl("ActionList Refresh Rate must be in whole " +
 258   
                     "minutes", ERR_KEY_REFRESH_RATE_WHOLE_NUM));
 259  0 
         } catch (NullPointerException e1) {
 260  0 
             errors.add(new WorkflowServiceErrorImpl("ActionList Refresh Rate must be in whole " +
 261   
                     "minutes", ERR_KEY_REFRESH_RATE_WHOLE_NUM));
 262  0 
         }
 263   
 
 264   
         try {
 265  0 
             if(new Integer(preferences.getPageSize().trim()) == 0){
 266  0 
                     errors.add(new WorkflowServiceErrorImpl("ActionList Page Size must be non-zero ", ERR_KEY_ACTION_LIST_PAGE_SIZE_WHOLE_NUM));
 267   
             }
 268  0 
         } catch (NumberFormatException e) {
 269  0 
             errors.add(new WorkflowServiceErrorImpl("ActionList Page Size must be in whole " +
 270   
                     "minutes", ERR_KEY_ACTION_LIST_PAGE_SIZE_WHOLE_NUM));
 271  0 
         } catch (NullPointerException e1) {
 272  0 
             errors.add(new WorkflowServiceErrorImpl("ActionList Page Size must be in whole " +
 273   
                     "minutes", ERR_KEY_ACTION_LIST_PAGE_SIZE_WHOLE_NUM));
 274  0 
         }
 275   
 
 276  0 
         LOG.debug("end validating preferences");
 277  0 
         if (! errors.isEmpty()) {
 278  0 
             throw new WorkflowServiceErrorException("Preference Validation Error", errors);
 279   
         }
 280  0 
     }
 281   
 
 282   
     public UserOptionsService getUserOptionService() {
 283  0 
         return (UserOptionsService) KEWServiceLocator.getService(
 284   
                 KEWServiceLocator.USER_OPTIONS_SRV);
 285   
     }
 286   
 }
Report generated by Cobertura 1.9.4.1 on 2/8/11 2:30 PM.