Felix Meschberger | 5e18fac | 2009-10-09 10:28:53 +0000 | [diff] [blame] | 1 | /* |
Felix Meschberger | add2b4a | 2007-04-11 18:12:33 +0000 | [diff] [blame] | 2 | * Licensed to the Apache Software Foundation (ASF) under one |
| 3 | * or more contributor license agreements. See the NOTICE file |
| 4 | * distributed with this work for additional information |
| 5 | * regarding copyright ownership. The ASF licenses this file |
| 6 | * to you under the Apache License, Version 2.0 (the |
| 7 | * "License"); you may not use this file except in compliance |
| 8 | * with the License. You may obtain a copy of the License at |
| 9 | * |
| 10 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 11 | * |
| 12 | * Unless required by applicable law or agreed to in writing, |
| 13 | * software distributed under the License is distributed on an |
| 14 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| 15 | * KIND, either express or implied. See the License for the |
| 16 | * specific language governing permissions and limitations |
| 17 | * under the License. |
| 18 | */ |
| 19 | package org.apache.felix.cm.impl; |
| 20 | |
| 21 | |
Felix Meschberger | a0903df | 2009-01-19 10:40:28 +0000 | [diff] [blame] | 22 | import java.lang.reflect.Array; |
Felix Meschberger | aeb8c5c | 2009-01-14 19:52:32 +0000 | [diff] [blame] | 23 | import java.util.ArrayList; |
| 24 | import java.util.Collection; |
Felix Meschberger | add2b4a | 2007-04-11 18:12:33 +0000 | [diff] [blame] | 25 | import java.util.Collections; |
| 26 | import java.util.Dictionary; |
| 27 | import java.util.Enumeration; |
| 28 | import java.util.Hashtable; |
Felix Meschberger | aeb8c5c | 2009-01-14 19:52:32 +0000 | [diff] [blame] | 29 | import java.util.Iterator; |
Felix Meschberger | a0903df | 2009-01-19 10:40:28 +0000 | [diff] [blame] | 30 | import java.util.Map; |
| 31 | import java.util.Vector; |
Felix Meschberger | add2b4a | 2007-04-11 18:12:33 +0000 | [diff] [blame] | 32 | |
| 33 | |
| 34 | /** |
| 35 | * The <code>CaseInsensitiveDictionary</code> is a |
| 36 | * <code>java.util.Dictionary</code> which conforms to the requirements laid |
| 37 | * out by the Configuration Admin Service Specification requiring the property |
| 38 | * names to keep case but to ignore case when accessing the properties. |
Felix Meschberger | add2b4a | 2007-04-11 18:12:33 +0000 | [diff] [blame] | 39 | */ |
| 40 | class CaseInsensitiveDictionary extends Dictionary |
| 41 | { |
| 42 | |
| 43 | /** |
| 44 | * The backend dictionary with lower case keys. |
| 45 | */ |
| 46 | private Hashtable internalMap; |
| 47 | |
| 48 | /** |
Felix Meschberger | 40d4e1b | 2008-03-26 10:41:00 +0000 | [diff] [blame] | 49 | * Mapping of lower case keys to original case keys as last used to set a |
| 50 | * property value. |
Felix Meschberger | add2b4a | 2007-04-11 18:12:33 +0000 | [diff] [blame] | 51 | */ |
| 52 | private Hashtable originalKeys; |
| 53 | |
| 54 | |
| 55 | CaseInsensitiveDictionary() |
| 56 | { |
| 57 | internalMap = new Hashtable(); |
| 58 | originalKeys = new Hashtable(); |
| 59 | } |
| 60 | |
| 61 | |
| 62 | CaseInsensitiveDictionary( Dictionary props ) |
| 63 | { |
| 64 | this(); |
| 65 | |
Felix Meschberger | 007c50e | 2011-10-20 12:39:38 +0000 | [diff] [blame^] | 66 | if ( props != null ) |
Felix Meschberger | add2b4a | 2007-04-11 18:12:33 +0000 | [diff] [blame] | 67 | { |
Felix Meschberger | 007c50e | 2011-10-20 12:39:38 +0000 | [diff] [blame^] | 68 | Enumeration keys = props.keys(); |
| 69 | while ( keys.hasMoreElements() ) |
Felix Meschberger | add2b4a | 2007-04-11 18:12:33 +0000 | [diff] [blame] | 70 | { |
Felix Meschberger | 007c50e | 2011-10-20 12:39:38 +0000 | [diff] [blame^] | 71 | Object key = keys.nextElement(); |
| 72 | |
| 73 | // check the correct syntax of the key |
| 74 | checkKey( key ); |
| 75 | |
| 76 | // check uniqueness of key |
| 77 | String lowerCase = ( ( String ) key ).toLowerCase(); |
| 78 | if ( internalMap.containsKey( lowerCase ) ) |
| 79 | { |
| 80 | throw new IllegalArgumentException( "Key [" + key + "] already present in different case" ); |
| 81 | } |
| 82 | |
| 83 | // check the value |
| 84 | Object value = props.get( key ); |
| 85 | value = checkValue( value ); |
| 86 | |
| 87 | // add the key/value pair |
| 88 | internalMap.put( lowerCase, value ); |
| 89 | originalKeys.put( lowerCase, key ); |
Felix Meschberger | add2b4a | 2007-04-11 18:12:33 +0000 | [diff] [blame] | 90 | } |
Felix Meschberger | add2b4a | 2007-04-11 18:12:33 +0000 | [diff] [blame] | 91 | } |
| 92 | } |
| 93 | |
| 94 | |
Felix Meschberger | a0903df | 2009-01-19 10:40:28 +0000 | [diff] [blame] | 95 | CaseInsensitiveDictionary( CaseInsensitiveDictionary props, boolean deepCopy ) |
Felix Meschberger | add2b4a | 2007-04-11 18:12:33 +0000 | [diff] [blame] | 96 | { |
Felix Meschberger | a0903df | 2009-01-19 10:40:28 +0000 | [diff] [blame] | 97 | Hashtable tmp = new Hashtable( Math.max( 2 * props.internalMap.size(), 11 ), 0.75f ); |
| 98 | if ( deepCopy ) |
| 99 | { |
| 100 | Iterator entries = props.internalMap.entrySet().iterator(); |
| 101 | while ( entries.hasNext() ) |
| 102 | { |
| 103 | Map.Entry entry = ( Map.Entry ) entries.next(); |
| 104 | Object value = entry.getValue(); |
| 105 | if ( value.getClass().isArray() ) |
| 106 | { |
| 107 | // copy array |
| 108 | int length = Array.getLength( value ); |
| 109 | Object newValue = Array.newInstance( value.getClass().getComponentType(), length ); |
| 110 | System.arraycopy( value, 0, newValue, 0, length ); |
| 111 | value = newValue; |
| 112 | } |
| 113 | else if ( value instanceof Collection ) |
| 114 | { |
| 115 | // copy collection, create Vector |
| 116 | // a Vector is created because the R4 and R4.1 specs |
| 117 | // state that the values must be simple, array or |
| 118 | // Vector. And even though we accept Collection nowadays |
| 119 | // there might be clients out there still written against |
| 120 | // R4 and R4.1 spec expecting Vector |
| 121 | value = new Vector( ( Collection ) value ); |
| 122 | } |
| 123 | tmp.put( entry.getKey(), value ); |
| 124 | } |
| 125 | } |
| 126 | else |
| 127 | { |
| 128 | tmp.putAll( props.internalMap ); |
| 129 | } |
Felix Meschberger | 5e18fac | 2009-10-09 10:28:53 +0000 | [diff] [blame] | 130 | |
Felix Meschberger | a0903df | 2009-01-19 10:40:28 +0000 | [diff] [blame] | 131 | internalMap = tmp; |
Felix Meschberger | add2b4a | 2007-04-11 18:12:33 +0000 | [diff] [blame] | 132 | originalKeys = new Hashtable( props.originalKeys ); |
| 133 | } |
| 134 | |
| 135 | |
Felix Meschberger | 40d4e1b | 2008-03-26 10:41:00 +0000 | [diff] [blame] | 136 | /* |
| 137 | * (non-Javadoc) |
Felix Meschberger | 5e18fac | 2009-10-09 10:28:53 +0000 | [diff] [blame] | 138 | * |
Felix Meschberger | add2b4a | 2007-04-11 18:12:33 +0000 | [diff] [blame] | 139 | * @see java.util.Dictionary#elements() |
| 140 | */ |
| 141 | public Enumeration elements() |
| 142 | { |
| 143 | return Collections.enumeration( internalMap.values() ); |
| 144 | } |
| 145 | |
| 146 | |
Felix Meschberger | 40d4e1b | 2008-03-26 10:41:00 +0000 | [diff] [blame] | 147 | /* |
| 148 | * (non-Javadoc) |
Felix Meschberger | 5e18fac | 2009-10-09 10:28:53 +0000 | [diff] [blame] | 149 | * |
Felix Meschberger | add2b4a | 2007-04-11 18:12:33 +0000 | [diff] [blame] | 150 | * @see java.util.Dictionary#get(java.lang.Object) |
| 151 | */ |
| 152 | public Object get( Object key ) |
| 153 | { |
| 154 | if ( key == null ) |
| 155 | { |
| 156 | throw new NullPointerException( "key" ); |
| 157 | } |
| 158 | |
| 159 | String stringKey = String.valueOf( key ).toLowerCase(); |
| 160 | return internalMap.get( stringKey ); |
| 161 | } |
| 162 | |
| 163 | |
Felix Meschberger | 40d4e1b | 2008-03-26 10:41:00 +0000 | [diff] [blame] | 164 | /* |
| 165 | * (non-Javadoc) |
Felix Meschberger | 5e18fac | 2009-10-09 10:28:53 +0000 | [diff] [blame] | 166 | * |
Felix Meschberger | add2b4a | 2007-04-11 18:12:33 +0000 | [diff] [blame] | 167 | * @see java.util.Dictionary#isEmpty() |
| 168 | */ |
| 169 | public boolean isEmpty() |
| 170 | { |
| 171 | return internalMap.isEmpty(); |
| 172 | } |
| 173 | |
| 174 | |
Felix Meschberger | 40d4e1b | 2008-03-26 10:41:00 +0000 | [diff] [blame] | 175 | /* |
| 176 | * (non-Javadoc) |
Felix Meschberger | 5e18fac | 2009-10-09 10:28:53 +0000 | [diff] [blame] | 177 | * |
Felix Meschberger | add2b4a | 2007-04-11 18:12:33 +0000 | [diff] [blame] | 178 | * @see java.util.Dictionary#keys() |
| 179 | */ |
| 180 | public Enumeration keys() |
| 181 | { |
| 182 | return Collections.enumeration( originalKeys.values() ); |
| 183 | } |
| 184 | |
| 185 | |
Felix Meschberger | 40d4e1b | 2008-03-26 10:41:00 +0000 | [diff] [blame] | 186 | /* |
| 187 | * (non-Javadoc) |
Felix Meschberger | 5e18fac | 2009-10-09 10:28:53 +0000 | [diff] [blame] | 188 | * |
Felix Meschberger | add2b4a | 2007-04-11 18:12:33 +0000 | [diff] [blame] | 189 | * @see java.util.Dictionary#put(java.lang.Object, java.lang.Object) |
| 190 | */ |
| 191 | public Object put( Object key, Object value ) |
| 192 | { |
| 193 | if ( key == null || value == null ) |
| 194 | { |
| 195 | throw new NullPointerException( "key or value" ); |
| 196 | } |
| 197 | |
Felix Meschberger | 40d4e1b | 2008-03-26 10:41:00 +0000 | [diff] [blame] | 198 | checkKey( key ); |
Felix Meschberger | aeb8c5c | 2009-01-14 19:52:32 +0000 | [diff] [blame] | 199 | value = checkValue( value ); |
Felix Meschberger | add2b4a | 2007-04-11 18:12:33 +0000 | [diff] [blame] | 200 | |
| 201 | String lowerCase = String.valueOf( key ).toLowerCase(); |
| 202 | originalKeys.put( lowerCase, key ); |
| 203 | return internalMap.put( lowerCase, value ); |
| 204 | } |
| 205 | |
| 206 | |
Felix Meschberger | 40d4e1b | 2008-03-26 10:41:00 +0000 | [diff] [blame] | 207 | /* |
| 208 | * (non-Javadoc) |
Felix Meschberger | 5e18fac | 2009-10-09 10:28:53 +0000 | [diff] [blame] | 209 | * |
Felix Meschberger | add2b4a | 2007-04-11 18:12:33 +0000 | [diff] [blame] | 210 | * @see java.util.Dictionary#remove(java.lang.Object) |
| 211 | */ |
| 212 | public Object remove( Object key ) |
| 213 | { |
| 214 | if ( key == null ) |
| 215 | { |
| 216 | throw new NullPointerException( "key" ); |
| 217 | } |
| 218 | |
| 219 | String lowerCase = String.valueOf( key ).toLowerCase(); |
| 220 | originalKeys.remove( lowerCase ); |
| 221 | return internalMap.remove( lowerCase ); |
| 222 | } |
| 223 | |
| 224 | |
Felix Meschberger | 40d4e1b | 2008-03-26 10:41:00 +0000 | [diff] [blame] | 225 | /* |
| 226 | * (non-Javadoc) |
Felix Meschberger | 5e18fac | 2009-10-09 10:28:53 +0000 | [diff] [blame] | 227 | * |
Felix Meschberger | add2b4a | 2007-04-11 18:12:33 +0000 | [diff] [blame] | 228 | * @see java.util.Dictionary#size() |
| 229 | */ |
| 230 | public int size() |
| 231 | { |
| 232 | return internalMap.size(); |
| 233 | } |
| 234 | |
| 235 | |
Felix Meschberger | 40d4e1b | 2008-03-26 10:41:00 +0000 | [diff] [blame] | 236 | // ---------- internal ----------------------------------------------------- |
| 237 | |
| 238 | /** |
| 239 | * Ensures the <code>key</code> complies with the <em>symbolic-name</em> |
| 240 | * production of the OSGi core specification (1.3.2): |
Felix Meschberger | 5e18fac | 2009-10-09 10:28:53 +0000 | [diff] [blame] | 241 | * |
Felix Meschberger | 40d4e1b | 2008-03-26 10:41:00 +0000 | [diff] [blame] | 242 | * <pre> |
| 243 | * symbolic-name :: = token('.'token)* |
| 244 | * digit ::= [0..9] |
| 245 | * alpha ::= [a..zA..Z] |
| 246 | * alphanum ::= alpha | digit |
| 247 | * token ::= ( alphanum | ’_’ | ’-’ )+ |
| 248 | * </pre> |
Felix Meschberger | 5e18fac | 2009-10-09 10:28:53 +0000 | [diff] [blame] | 249 | * |
Felix Meschberger | 40d4e1b | 2008-03-26 10:41:00 +0000 | [diff] [blame] | 250 | * If the key does not comply an <code>IllegalArgumentException</code> is |
| 251 | * thrown. |
Felix Meschberger | 5e18fac | 2009-10-09 10:28:53 +0000 | [diff] [blame] | 252 | * |
Felix Meschberger | 40d4e1b | 2008-03-26 10:41:00 +0000 | [diff] [blame] | 253 | * @param key |
| 254 | * The configuration property key to check. |
| 255 | * @throws IllegalArgumentException |
| 256 | * if the key does not comply with the symbolic-name production. |
| 257 | */ |
| 258 | static void checkKey( Object keyObject ) |
| 259 | { |
Felix Meschberger | 5e18fac | 2009-10-09 10:28:53 +0000 | [diff] [blame] | 260 | // check for wrong type or null key |
Felix Meschberger | 40d4e1b | 2008-03-26 10:41:00 +0000 | [diff] [blame] | 261 | if ( !( keyObject instanceof String ) ) |
| 262 | { |
| 263 | throw new IllegalArgumentException( "Key [" + keyObject + "] must be a String" ); |
| 264 | } |
| 265 | |
| 266 | String key = ( String ) keyObject; |
Felix Meschberger | 5e18fac | 2009-10-09 10:28:53 +0000 | [diff] [blame] | 267 | |
| 268 | // check for empty string |
| 269 | if ( key.length() == 0 ) |
Felix Meschberger | 40d4e1b | 2008-03-26 10:41:00 +0000 | [diff] [blame] | 270 | { |
Felix Meschberger | 5e18fac | 2009-10-09 10:28:53 +0000 | [diff] [blame] | 271 | throw new IllegalArgumentException( "Key [" + key + "] must not be an empty string" ); |
Felix Meschberger | 40d4e1b | 2008-03-26 10:41:00 +0000 | [diff] [blame] | 272 | } |
Felix Meschberger | 40d4e1b | 2008-03-26 10:41:00 +0000 | [diff] [blame] | 273 | } |
| 274 | |
Felix Meschberger | add2b4a | 2007-04-11 18:12:33 +0000 | [diff] [blame] | 275 | |
Felix Meschberger | aeb8c5c | 2009-01-14 19:52:32 +0000 | [diff] [blame] | 276 | static Object checkValue( Object value ) |
Felix Meschberger | add2b4a | 2007-04-11 18:12:33 +0000 | [diff] [blame] | 277 | { |
| 278 | Class type; |
Felix Meschberger | 88d6d10 | 2009-01-19 09:48:53 +0000 | [diff] [blame] | 279 | if ( value == null ) |
| 280 | { |
| 281 | // null is illegal |
| 282 | throw new IllegalArgumentException( "Value must not be null" ); |
| 283 | |
| 284 | } |
| 285 | else if ( value.getClass().isArray() ) |
Felix Meschberger | add2b4a | 2007-04-11 18:12:33 +0000 | [diff] [blame] | 286 | { |
| 287 | // check simple or primitive |
| 288 | type = value.getClass().getComponentType(); |
| 289 | |
Felix Meschberger | 88d6d10 | 2009-01-19 09:48:53 +0000 | [diff] [blame] | 290 | // check for primitive type (simple types are checked below) |
| 291 | // note: void[] cannot be created, so we ignore this here |
| 292 | if ( type.isPrimitive() ) |
Felix Meschberger | add2b4a | 2007-04-11 18:12:33 +0000 | [diff] [blame] | 293 | { |
Felix Meschberger | aeb8c5c | 2009-01-14 19:52:32 +0000 | [diff] [blame] | 294 | return value; |
Felix Meschberger | add2b4a | 2007-04-11 18:12:33 +0000 | [diff] [blame] | 295 | } |
| 296 | |
| 297 | } |
Felix Meschberger | aeb8c5c | 2009-01-14 19:52:32 +0000 | [diff] [blame] | 298 | else if ( value instanceof Collection ) |
Felix Meschberger | add2b4a | 2007-04-11 18:12:33 +0000 | [diff] [blame] | 299 | { |
| 300 | // check simple |
Felix Meschberger | aeb8c5c | 2009-01-14 19:52:32 +0000 | [diff] [blame] | 301 | Collection collection = ( Collection ) value; |
| 302 | if ( collection.isEmpty() ) |
Felix Meschberger | add2b4a | 2007-04-11 18:12:33 +0000 | [diff] [blame] | 303 | { |
Felix Meschberger | aeb8c5c | 2009-01-14 19:52:32 +0000 | [diff] [blame] | 304 | throw new IllegalArgumentException( "Collection must not be empty" ); |
Felix Meschberger | add2b4a | 2007-04-11 18:12:33 +0000 | [diff] [blame] | 305 | } |
| 306 | |
Felix Meschberger | aeb8c5c | 2009-01-14 19:52:32 +0000 | [diff] [blame] | 307 | // ensure all elements have the same type and to internal list |
| 308 | Collection internalValue = new ArrayList( collection.size() ); |
Felix Meschberger | add2b4a | 2007-04-11 18:12:33 +0000 | [diff] [blame] | 309 | type = null; |
Felix Meschberger | aeb8c5c | 2009-01-14 19:52:32 +0000 | [diff] [blame] | 310 | for ( Iterator ci = collection.iterator(); ci.hasNext(); ) |
Felix Meschberger | add2b4a | 2007-04-11 18:12:33 +0000 | [diff] [blame] | 311 | { |
Felix Meschberger | aeb8c5c | 2009-01-14 19:52:32 +0000 | [diff] [blame] | 312 | Object el = ci.next(); |
Felix Meschberger | add2b4a | 2007-04-11 18:12:33 +0000 | [diff] [blame] | 313 | if ( el == null ) |
| 314 | { |
Felix Meschberger | aeb8c5c | 2009-01-14 19:52:32 +0000 | [diff] [blame] | 315 | throw new IllegalArgumentException( "Collection must not contain null elements" ); |
Felix Meschberger | add2b4a | 2007-04-11 18:12:33 +0000 | [diff] [blame] | 316 | } |
| 317 | if ( type == null ) |
| 318 | { |
| 319 | type = el.getClass(); |
| 320 | } |
| 321 | else if ( type != el.getClass() ) |
| 322 | { |
Felix Meschberger | aeb8c5c | 2009-01-14 19:52:32 +0000 | [diff] [blame] | 323 | throw new IllegalArgumentException( "Collection element types must not be mixed" ); |
Felix Meschberger | add2b4a | 2007-04-11 18:12:33 +0000 | [diff] [blame] | 324 | } |
Felix Meschberger | aeb8c5c | 2009-01-14 19:52:32 +0000 | [diff] [blame] | 325 | internalValue.add( el ); |
Felix Meschberger | add2b4a | 2007-04-11 18:12:33 +0000 | [diff] [blame] | 326 | } |
Felix Meschberger | aeb8c5c | 2009-01-14 19:52:32 +0000 | [diff] [blame] | 327 | value = internalValue; |
Felix Meschberger | add2b4a | 2007-04-11 18:12:33 +0000 | [diff] [blame] | 328 | } |
Felix Meschberger | 88d6d10 | 2009-01-19 09:48:53 +0000 | [diff] [blame] | 329 | else |
Felix Meschberger | add2b4a | 2007-04-11 18:12:33 +0000 | [diff] [blame] | 330 | { |
| 331 | // get the type to check (must be simple) |
| 332 | type = value.getClass(); |
| 333 | |
| 334 | } |
Felix Meschberger | add2b4a | 2007-04-11 18:12:33 +0000 | [diff] [blame] | 335 | |
| 336 | // check for simple type |
| 337 | if ( type == String.class || type == Integer.class || type == Long.class || type == Float.class |
| 338 | || type == Double.class || type == Byte.class || type == Short.class || type == Character.class |
| 339 | || type == Boolean.class ) |
| 340 | { |
Felix Meschberger | aeb8c5c | 2009-01-14 19:52:32 +0000 | [diff] [blame] | 341 | return value; |
Felix Meschberger | add2b4a | 2007-04-11 18:12:33 +0000 | [diff] [blame] | 342 | } |
| 343 | |
| 344 | // not a valid type |
| 345 | throw new IllegalArgumentException( "Value [" + value + "] has unsupported (base-) type " + type ); |
| 346 | } |
| 347 | |
| 348 | |
Felix Meschberger | 40d4e1b | 2008-03-26 10:41:00 +0000 | [diff] [blame] | 349 | // ---------- Object Overwrites -------------------------------------------- |
Felix Meschberger | add2b4a | 2007-04-11 18:12:33 +0000 | [diff] [blame] | 350 | |
| 351 | public String toString() |
| 352 | { |
| 353 | return internalMap.toString(); |
| 354 | } |
| 355 | |
| 356 | } |