org.opends.server.extensions

Class EntryCacheCommon

java.lang.Object

org.opends.server.extensions.EntryCacheCommon

public final class EntryCacheCommon
extends Object

This class provides some common tools to all entry cache implementations.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	EntryCacheCommon.ConfigErrorHandler Error handler used by local methods to report configuration error.
static class	EntryCacheCommon.ConfigPhase Configuration phases.

Method Summary

Modifier and Type	Method and Description
static EntryCacheCommon.ConfigErrorHandler	getConfigErrorHandler(EntryCacheCommon.ConfigPhase configPhase, List<LocalizableMessage> unacceptableReasons, List<LocalizableMessage> errorMessages) Create a new error handler.
static Set<Filter>	toFilters(SortedSet<String> filters, LocalizableMessageDescriptor.Arg3<Object,Object,Object> decodeErrorMsg, EntryCacheCommon.ConfigErrorHandler errorHandler, Dn configEntryDN) Reads a list of string filters and convert it to a list of search filters.

Methods inherited from class java.lang.Object

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

Method Detail

toFilters

public static Set<Filter> toFilters(SortedSet<String> filters,
                                    LocalizableMessageDescriptor.Arg3<Object,Object,Object> decodeErrorMsg,
                                    EntryCacheCommon.ConfigErrorHandler errorHandler,
                                    Dn configEntryDN)

Reads a list of string filters and convert it to a list of search filters.

Parameters:

filters - the list of string filter to convert to search filters

decodeErrorMsg - the error message ID to use in case of error

errorHandler - error handler to report filter decoding errors on

configEntryDN - the entry cache configuration DN

Returns:

the set of search filters

getConfigErrorHandler

public static EntryCacheCommon.ConfigErrorHandler getConfigErrorHandler(EntryCacheCommon.ConfigPhase configPhase,
                                                                        List<LocalizableMessage> unacceptableReasons,
                                                                        List<LocalizableMessage> errorMessages)

Create a new error handler.

Parameters:

configPhase - the configuration phase for which the error handler is used

unacceptableReasons - the reasons why the configuration cannot be applied (during PHASE_ACCEPTABLE phase)

errorMessages - the errors found when applying a new configuration (during PHASE_APPLY phase)

Returns:

a new configuration error handler