mirror of https://github.com/OpenIdentityPlatform/OpenDJ.git

Chris Ridd
05.42.2014 f7c5ce48062ef5c62d062fb9f0cf401419c7a7ee
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
/*
 * CDDL HEADER START
 *
 * The contents of this file are subject to the terms of the
 * Common Development and Distribution License, Version 1.0 only
 * (the "License").  You may not use this file except in compliance
 * with the License.
 *
 * You can obtain a copy of the license at legal-notices/CDDLv1_0.txt
 * or http://forgerock.org/license/CDDLv1.0.html.
 * See the License for the specific language governing permissions
 * and limitations under the License.
 *
 * When distributing Covered Code, include this CDDL HEADER in each
 * file and include the License file at legal-notices/CDDLv1_0.txt.
 * If applicable, add the following below this CDDL HEADER, with the
 * fields enclosed by brackets "[]" replaced with your own identifying
 * information:
 *      Portions Copyright [yyyy] [name of copyright owner]
 *
 * CDDL HEADER END
 *
 *
 *      Copyright 2008 Sun Microsystems, Inc.
 */
 
package org.opends.server.extensions;
 
import java.io.Serializable;
import java.util.Map;
import java.util.HashMap;
import java.util.LinkedHashMap;
import java.util.concurrent.ConcurrentHashMap;
 
/**
 * This class represents serializable entry cache index structures
 * and supporting data types used for the entry cache persistence.
 * Structurally it should be an inner class of FileSystemEntryCache
 * however due to serialization constraints it has been separated.
 */
class FileSystemEntryCacheIndex implements Serializable {
 
  static final long serialVersionUID = 4537634108673038611L;
 
  /**
   * The file system entry cache instance this index belongs to.
   */
  transient private FileSystemEntryCache fsEntryCacheInstance;
 
  /**
   * Backend to checksum/id map for offline state.
   */
  public Map<String, Long> offlineState;
  /**
   * The mapping between backends and ID to DN maps.
   */
  public Map<String, Map<Long, String>> backendMap;
  /**
   * The mapping between DNs and IDs.
   */
  public Map<String, Long> dnMap;
 
  /**
   * Index constructor.
   * @param fsEntryCacheInstance The File System Entry Cache instance
   *                             this index is associated with.
   * @param accessOrder          The ordering mode for the index map
   *                             {@code true} for access-order,
   *                             {@code false} for insertion-order.
   */
  protected FileSystemEntryCacheIndex(
    FileSystemEntryCache fsEntryCacheInstance, boolean accessOrder) {
 
    this.fsEntryCacheInstance = fsEntryCacheInstance;
 
    offlineState =
      new ConcurrentHashMap<String, Long>();
    backendMap =
      new HashMap<String, Map<Long, String>>();
    dnMap =
      new LinkedHashMapRotator<String,Long>(
      16, (float) 0.75, accessOrder);
  }
 
  /**
   * This inner class exist solely to override <CODE>removeEldestEntry()</CODE>
   * method of the LinkedHashMap.
   *
   * @see  java.util.LinkedHashMap
   */
  private class LinkedHashMapRotator<K,V> extends LinkedHashMap<K,V> {
 
    static final long serialVersionUID = 5271482121415968435L;
 
    /**
     * Linked Hash Map Rotator constructor.
     * @param initialCapacity The initial capacity.
     * @param loadFactor      The load factor.
     * @param accessOrder     The ordering mode - {@code true} for
     *                        access-order, {@code false} for
     *                        insertion-order.
     */
    public LinkedHashMapRotator(int initialCapacity,
                                float loadFactor,
                                boolean accessOrder) {
      super(initialCapacity, loadFactor, accessOrder);
    }
 
    /**
     * This method will get called each time we add a new key/value
     * pair to the map. The eldest entry will be selected by the
     * underlying LinkedHashMap implementation based on the access
     * order configured and will follow either FIFO implementation
     * by default or LRU implementation if configured so explicitly.
     * @param  eldest  The least recently inserted entry in the map,
     *                 or if this is an access-ordered map, the least
     *                 recently accessed entry.
     * @return boolean {@code true} if the eldest entry should be
     *                 removed from the map; {@code false} if it
     *                 should be retained.
     */
    @Override protected boolean removeEldestEntry(Map.Entry eldest) {
      return fsEntryCacheInstance.removeEldestEntry(eldest);
    }
  }
}