|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.unboundid.directory.sdk.ds.api.UncachedEntryCriteria
@Extensible @DirectoryServerExtension @ThreadSafety(level=INTERFACE_THREADSAFE) public abstract class UncachedEntryCriteria
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.
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.
ScriptedUncachedEntryCriteria
Constructor Summary | |
---|---|
UncachedEntryCriteria()
Creates a new instance of this uncached entry criteria. |
Method Summary | |
---|---|
com.unboundid.ldap.sdk.ResultCode |
applyConfiguration(UncachedEntryCriteriaConfig config,
com.unboundid.util.args.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. |
void |
defineConfigArguments(com.unboundid.util.args.ArgumentParser parser)
Updates the provided argument parser to define any configuration arguments which may be used by this extension. |
void |
finalizeUncachedEntryCriteria()
Performs any cleanup which may be necessary when this uncached entry criteria instance is to be taken out of service. |
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. |
abstract java.lang.String[] |
getExtensionDescription()
Retrieves a human-readable description for this extension. |
abstract java.lang.String |
getExtensionName()
Retrieves a human-readable name for this extension. |
void |
initializeUncachedEntryCriteria(DirectoryServerContext serverContext,
UncachedEntryCriteriaConfig config,
com.unboundid.util.args.ArgumentParser parser)
Initializes this uncached entry criteria. |
boolean |
isConfigurationAcceptable(UncachedEntryCriteriaConfig config,
com.unboundid.util.args.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. |
abstract boolean |
shouldBeUncached(Entry previousEntry,
Entry updatedEntry)
Indicates whether the provided entry should be written into the uncached-id2entry database rather than into id2entry. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public UncachedEntryCriteria()
initializeUncachedEntryCriteria
method.
Method Detail |
---|
public abstract java.lang.String getExtensionName()
getExtensionName
in interface UnboundIDExtension
public abstract java.lang.String[] getExtensionDescription()
getExtensionDescription
in interface UnboundIDExtension
null
or an empty array if no description should be available.public void defineConfigArguments(com.unboundid.util.args.ArgumentParser parser) throws com.unboundid.util.args.ArgumentException
defineConfigArguments
in interface Configurable
parser
- The argument parser to be updated with the configuration
arguments which may be used by this extension.
com.unboundid.util.args.ArgumentException
- If a problem is encountered while updating the
provided argument parser.public void initializeUncachedEntryCriteria(DirectoryServerContext serverContext, UncachedEntryCriteriaConfig config, com.unboundid.util.args.ArgumentParser parser) throws com.unboundid.ldap.sdk.LDAPException
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.
com.unboundid.ldap.sdk.LDAPException
- If a problem occurs while initializing this
uncached entry criteria.public boolean isConfigurationAcceptable(UncachedEntryCriteriaConfig config, com.unboundid.util.args.ArgumentParser parser, java.util.List<java.lang.String> unacceptableReasons)
isConfigurationAcceptable
in interface Reconfigurable<UncachedEntryCriteriaConfig>
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.
true
if the configuration in the provided argument parser
appears to be acceptable, or false
if not.public com.unboundid.ldap.sdk.ResultCode applyConfiguration(UncachedEntryCriteriaConfig config, com.unboundid.util.args.ArgumentParser parser, java.util.List<java.lang.String> adminActionsRequired, java.util.List<java.lang.String> messages)
applyConfiguration
in interface Reconfigurable<UncachedEntryCriteriaConfig>
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.
SUCCESS
should be
used to indicate that all processing completed successfully. Any
other result will indicate that a problem occurred during
processing.public void finalizeUncachedEntryCriteria()
public abstract boolean shouldBeUncached(Entry previousEntry, Entry updatedEntry)
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.
true
if the entry should be written into the
uncached-id2entry database, or false
if it should be
written into the id2entry database.public java.util.Map<java.util.List<java.lang.String>,java.lang.String> getExamplesArgumentSets()
getExamplesArgumentSets
in interface ExampleUsageProvider
null
or empty if there should
not be any example argument sets.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |