org.apache.directory.server.core.api.subtree

Class SubentryCache

java.lang.Object

org.apache.directory.server.core.api.subtree.SubentryCache

All Implemented Interfaces:

java.lang.Iterable<org.apache.directory.api.ldap.model.name.Dn>

public class SubentryCache
extends java.lang.Object
implements java.lang.Iterable<org.apache.directory.api.ldap.model.name.Dn>

A cache for subtree specifications. It associates a Subentry with a Dn, representing its position in the DIT.
This cache has a size limit set to 1000 at the moment. We should add a configuration parameter to manage its size.

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.Map<org.apache.directory.api.ldap.model.name.Dn,org.apache.directory.api.ldap.model.subtree.Subentry>	cache The Subentry cache
private int	cacheMaxSize The cache size limit
private java.util.concurrent.atomic.AtomicInteger	cacheSize The current cache size
private static int	DEFAULT_CACHE_MAX_SIZE The default cache size limit

Constructor Summary

Constructors

Constructor and Description
SubentryCache() Creates a new instance of SubentryCache with a default maximum size.
SubentryCache(int maxSize) Creates a new instance of SubentryCache with a specific maximum size.

Method Summary

Modifier and Type	Method and Description
org.apache.directory.api.ldap.model.subtree.Subentry	addSubentry(org.apache.directory.api.ldap.model.name.Dn dn, org.apache.directory.api.ldap.model.subtree.Subentry subentry) Stores a new Subentry into the cache, associated with a Dn
int	getCacheSize()
org.apache.directory.api.ldap.model.subtree.Subentry	getSubentry(org.apache.directory.api.ldap.model.name.Dn dn) Retrieve a Subentry given a Dn.
boolean	hasSubentry(org.apache.directory.api.ldap.model.name.Dn dn) Tells if there is a Subentry associated with a Dn
java.util.Iterator<org.apache.directory.api.ldap.model.name.Dn>	iterator()
org.apache.directory.api.ldap.model.subtree.Subentry	removeSubentry(org.apache.directory.api.ldap.model.name.Dn dn) Remove a Subentry for a given Dn

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

DEFAULT_CACHE_MAX_SIZE

private static final int DEFAULT_CACHE_MAX_SIZE

The default cache size limit

See Also:

Constant Field Values

cacheMaxSize

private int cacheMaxSize

The cache size limit

cacheSize

private java.util.concurrent.atomic.AtomicInteger cacheSize

The current cache size

cache

private final java.util.Map<org.apache.directory.api.ldap.model.name.Dn,org.apache.directory.api.ldap.model.subtree.Subentry> cache

The Subentry cache

Constructor Detail

SubentryCache

public SubentryCache()

Creates a new instance of SubentryCache with a default maximum size.

SubentryCache

public SubentryCache(int maxSize)

Creates a new instance of SubentryCache with a specific maximum size.

Method Detail

getSubentry

public final org.apache.directory.api.ldap.model.subtree.Subentry getSubentry(org.apache.directory.api.ldap.model.name.Dn dn)

Retrieve a Subentry given a Dn. If there is none, null will be returned.

Parameters:

dn - The Dn we want to get the Subentry for

Returns:

The found Subentry, or null

removeSubentry

public final org.apache.directory.api.ldap.model.subtree.Subentry removeSubentry(org.apache.directory.api.ldap.model.name.Dn dn)

Remove a Subentry for a given Dn

Parameters:

dn - The Dn for which we want to remove the associated Subentry

Returns:

The removed Subentry, if any

addSubentry

public org.apache.directory.api.ldap.model.subtree.Subentry addSubentry(org.apache.directory.api.ldap.model.name.Dn dn,
                                                                        org.apache.directory.api.ldap.model.subtree.Subentry subentry)

Stores a new Subentry into the cache, associated with a Dn

Parameters:

dn - The Subentry Dn

ss - The SubtreeSpecification

adminRoles - The administrative roles for this Subentry

Returns:

The old Subentry, if any

hasSubentry

public boolean hasSubentry(org.apache.directory.api.ldap.model.name.Dn dn)

Tells if there is a Subentry associated with a Dn

Parameters:

dn - The Dn

Returns:

True if a Subentry is found

iterator

public java.util.Iterator<org.apache.directory.api.ldap.model.name.Dn> iterator()

Specified by:

iterator in interface java.lang.Iterable<org.apache.directory.api.ldap.model.name.Dn>

Returns:

An Iterator over the Subentry's DNs

getCacheSize

public int getCacheSize()

Returns:

The number of elements in the cache