Package com.unboundid.directory.sdk.ds.api

Class UncachedEntryCriteria

  • All Implemented Interfaces:
    Configurable, ExampleUsageProvider, Reconfigurable<UncachedEntryCriteriaConfig>, UnboundIDExtension
    @Extensible
@DirectoryServerExtension
@ThreadSafety(level=INTERFACE_THREADSAFE)
public abstract class UncachedEntryCriteria
extends java.lang.Object
implements UnboundIDExtension, Reconfigurable<UncachedEntryCriteriaConfig>, ExampleUsageProvider
    This class defines an API that must be implemented by extensions which have the ability to determine which entries should be stored in the uncached-id2entry database of a local DB backend, rather than in the id2entry database. In environments with data sets too large to fit in available memory, this can help the server better use the memory it does have for entries that are more likely to be accessed.

    Configuring Uncached Entry Criteria

    In order to configure an uncached entry criteria object created using this API, use a command like: 
          dsconfig create-uncached-entry-criteria \
           --criteria-name "{criteria-name}" \
           --type third-party \
           --set enabled:true \
           --set "extension-class:{class-name}" \
           --set "extension-argument:{name=value}"
    where "{criteria-name}" is the name to use for the uncached entry criteria instance, "{class-name}" is the fully-qualified name of the Java class that extends com.unboundid.directory.sdk.ds.api.UncachedEntryCriteria, and "{name=value}" represents name-value pairs for any arguments to provide to the uncached entry criteria. If multiple arguments should be provided to the criteria, then the "--set extension-argument:{name=value}" option should be provided multiple times.
    See Also:
    ScriptedUncachedEntryCriteria

    • Constructor Detail

      • UncachedEntryCriteria

        public UncachedEntryCriteria()
        Creates a new instance of this uncached entry criteria. All uncached entry criteria implementations must include a default constructor, but any initialization should generally be done in the initializeUncachedEntryCriteria method.

    • Method Detail

      • getExtensionDescription

        public abstract java.lang.String[] getExtensionDescription()
        Retrieves a human-readable description for this extension. Each element of the array that is returned will be considered a separate paragraph in generated documentation.
        Specified by:
        getExtensionDescription in interface UnboundIDExtension
        Returns:
        A human-readable description for this extension, or null or an empty array if no description should be available.

      • defineConfigArguments

        public void defineConfigArguments​(ArgumentParser parser)
                           throws ArgumentException
        Updates the provided argument parser to define any configuration arguments which may be used by this extension. The argument parser may also be updated to define relationships between arguments (e.g., to specify required, exclusive, or dependent argument sets).
        Specified by:
        defineConfigArguments in interface Configurable
        Parameters:
        parser - The argument parser to be updated with the configuration arguments which may be used by this extension.
        Throws:
        ArgumentException - If a problem is encountered while updating the provided argument parser.

      • initializeUncachedEntryCriteria

        public void initializeUncachedEntryCriteria​(DirectoryServerContext serverContext,
                                            UncachedEntryCriteriaConfig config,
                                            ArgumentParser parser)
                                     throws LDAPException
        Initializes this uncached entry criteria.
        Parameters:
        serverContext - A handle to the server context for the server in which this extension is running.
        config - The general configuration for this uncached entry criteria.
        parser - The argument parser which has been initialized from the configuration for this uncached entry criteria.
        Throws:
        LDAPException - If a problem occurs while initializing this uncached entry criteria.

      • isConfigurationAcceptable

        public boolean isConfigurationAcceptable​(UncachedEntryCriteriaConfig config,
                                         ArgumentParser parser,
                                         java.util.List<java.lang.String> unacceptableReasons)
        Indicates whether the configuration represented by the provided argument parser is acceptable for use by this extension. The parser will have been used to parse any configuration available for this extension, and any automatic validation will have been performed. This method may be used to perform any more complex validation which cannot be performed automatically by the argument parser.
        Specified by:
        isConfigurationAcceptable in interface Reconfigurable<UncachedEntryCriteriaConfig>
        Parameters:
        config - The general configuration for this extension.
        parser - The argument parser that has been used to parse the proposed configuration for this extension.
        unacceptableReasons - A list to which messages may be added to provide additional information about why the provided configuration is not acceptable.
        Returns:
        true if the configuration in the provided argument parser appears to be acceptable, or false if not.

      • applyConfiguration

        public ResultCode applyConfiguration​(UncachedEntryCriteriaConfig config,
                                     ArgumentParser parser,
                                     java.util.List<java.lang.String> adminActionsRequired,
                                     java.util.List<java.lang.String> messages)
        Attempts to apply the configuration from the provided argument parser to this extension.
        Specified by:
        applyConfiguration in interface Reconfigurable<UncachedEntryCriteriaConfig>
        Parameters:
        config - The general configuration for this extension.
        parser - The argument parser that has been used to parse the new configuration for this extension.
        adminActionsRequired - A list to which messages may be added to provide additional information about any additional administrative actions that may be required to apply some of the configuration changes.
        messages - A list to which messages may be added to provide additional information about the processing performed by this method.
        Returns:
        A result code providing information about the result of applying the configuration change. A result of SUCCESS should be used to indicate that all processing completed successfully. Any other result will indicate that a problem occurred during processing.

      • finalizeUncachedEntryCriteria

        public void finalizeUncachedEntryCriteria()
        Performs any cleanup which may be necessary when this uncached entry criteria instance is to be taken out of service.

      • shouldBeUncached

        public abstract boolean shouldBeUncached​(Entry previousEntry,
                                         Entry updatedEntry)
        Indicates whether the provided entry should be written into the uncached-id2entry database rather than into id2entry. This method may be used both for new entries (e.g., from add operations or LDIF imports) or existing entries (e.g., from modify, modify DN, or soft delete operations, or from re-encode processing).
        Parameters:
        previousEntry - A read-only representation of the entry as it existed before the update. If the entry is unchanged or did not previously exist, then this will be the same as updatedEntry.
        updatedEntry - A read-only representation of the entry as it will be written into either the id2entry or uncached-id2entry database.
        Returns:
        true if the entry should be written into the uncached-id2entry database, or false if it should be written into the id2entry database.

      • getExamplesArgumentSets

        public java.util.Map<java.util.List<java.lang.String>,​java.lang.String> getExamplesArgumentSets()
        Retrieves a map containing examples of configurations that may be used for this extension. The map key should be a list of sample arguments, and the corresponding value should be a description of the behavior that will be exhibited by the extension when used with that configuration.
        Specified by:
        getExamplesArgumentSets in interface ExampleUsageProvider
        Returns:
        A map containing examples of configurations that may be used for this extension. It may be null or empty if there should not be any example argument sets.