001/**
002 * Copyright 2005-2014 The Kuali Foundation
003 *
004 * Licensed under the Educational Community License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.opensource.org/licenses/ecl2.php
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016package org.kuali.rice.kns.web;
017
018import org.kuali.rice.core.api.CoreApiServiceLocator;
019import org.kuali.rice.core.api.config.property.ConfigurationService;
020
021import java.util.HashMap;
022import java.util.HashSet;
023import java.util.LinkedList;
024import java.util.Map;
025import java.util.Queue;
026import java.util.Set;
027import java.util.UUID;
028import java.util.Collections;
029
030
031/**
032 * A class which will hold a Map of editable properties, dropping editable properties when too many
033 * are filled in. 
034 * 
035 * @author Kuali Rice Team (rice.collab@kuali.org)
036 *
037 * @deprecated KNS Struts deprecated, use KRAD and the Spring MVC framework.
038 */
039@Deprecated
040public class EditablePropertiesHistoryHolder implements java.io.Serializable {
041        private Map<String, Set<String>> editablePropertiesMap;
042        private Integer maxLength = null;
043        private Queue<String> historyOrder;
044        private static final String EDITABLE_PROPERTIES_HISTORY_SIZE_PROPERTY_NAME = "kns.editable.properties.history.size";
045        private transient ConfigurationService configurationService;
046        
047        /**
048         * Constructs the EditablePropertiesHistoryHolder
049         *
050         */
051        public EditablePropertiesHistoryHolder() {
052        editablePropertiesMap = Collections.synchronizedMap(new HashMap<String, Set<String>>());
053                historyOrder = new LinkedList<String>();
054        }
055        
056        /**
057         * @return the maximum length of the history that this will hold
058         */
059        public int getMaxHistoryLength() {
060                if (maxLength == null) {
061                        final String historyLengthAsString = getConfigurationService().getPropertyValueAsString(
062                    EditablePropertiesHistoryHolder.EDITABLE_PROPERTIES_HISTORY_SIZE_PROPERTY_NAME);
063                        if (historyLengthAsString == null) {
064                                maxLength = new Integer(20);
065                        } else {
066                                try {
067                                        maxLength = new Integer(historyLengthAsString);
068                                } catch (NumberFormatException nfe) {
069                                        throw new RuntimeException("Cannot convert property "+EditablePropertiesHistoryHolder.EDITABLE_PROPERTIES_HISTORY_SIZE_PROPERTY_NAME+" with value "+historyLengthAsString+" to integer", nfe);
070                                }
071                        }
072                }
073                return maxLength.intValue();
074        }
075        
076        /**
077         * Adds a Set of editable property names to the history, keyed with the given guid String.  If the editable properties exceeds the buffer size,
078         * the earliest editable properties will be bumped
079         * @param editableProperties the Set of editable property names to save in the history
080         * @return a String to act as a key (or guid) to the editable properties
081         */
082        public String addEditablePropertiesToHistory(Set<String> editableProperties) {
083                String guid = generateNewGuid();
084                
085                if (getHistoryOrder().size() > getMaxHistoryLength()) {
086                        final String guidForRemoval = getHistoryOrder().remove();
087                        getEditablePropertiesMap().remove(guidForRemoval);
088                }
089                getHistoryOrder().add(guid);
090                getEditablePropertiesMap().put(guid, editableProperties);
091                
092                return guid;
093        }
094        
095        /**
096         * 
097         * @return a newly generated Guid to act as a key to an editable properties Set
098         */
099        public String generateNewGuid() {
100                final String guid = UUID.randomUUID().toString();
101                return guid;
102        }
103        
104        /**
105         * Returns the editable properties registered with the current guid
106         * @param guid the guid to find editable properties for
107         * @return a Set<String> of editable properties
108         */
109        public Set<String> getEditableProperties(String guid) {
110                return getEditablePropertiesMap().get(guid);
111        }
112        
113        /**
114         * Clears out the editable properties associated with the given guid
115         * @param guid the guid to clear out editable properties for
116         */
117        public void clearEditableProperties(String guid) {
118                getEditablePropertiesMap().put(guid, createNewEditablePropertiesEntry());
119        }
120        
121        /**
122         * @return the order of the entries as they chronologically were created
123         */
124        protected Queue<String> getHistoryOrder() {
125                return historyOrder;
126        }
127        
128        /**
129         * @return the Map which associates editable property guids with Sets of editable property names
130         */
131        protected Map<String, Set<String>> getEditablePropertiesMap() {
132                return editablePropertiesMap;
133        }
134        
135        /**
136         * @return a new Entry to hold the names of editable properties
137         */
138        protected Set<String> createNewEditablePropertiesEntry() {
139                return new HashSet<String>();
140        }
141        
142        /**
143         * @return an implementation of the ConfigurationService
144         */
145        protected ConfigurationService getConfigurationService() {
146                if (configurationService == null) {
147                        configurationService = CoreApiServiceLocator.getKualiConfigurationService();
148                }
149                return configurationService;
150        }
151}