com.unboundid.directory.sdk.ds.api

Class SearchEntryCriteria

java.lang.Object

com.unboundid.directory.sdk.ds.api.SearchEntryCriteria

All Implemented Interfaces:

Configurable, ExampleUsageProvider, Reconfigurable<SearchEntryCriteriaConfig>, UnboundIDExtension

@Extensible
 @DirectoryServerExtension
 @DirectoryProxyServerExtension(appliesToLocalContent=true,
                               appliesToRemoteContent=true)
 @SynchronizationServerExtension(appliesToLocalContent=true,
                                appliesToSynchronizedContent=false)
 @MetricsEngineExtension
 @BrokerExtension
 @ThreadSafety(level=INTERFACE_THREADSAFE)
public abstract class SearchEntryCriteria
extends java.lang.Object
implements UnboundIDExtension, Reconfigurable<SearchEntryCriteriaConfig>, ExampleUsageProvider

This class defines an API that must be implemented by extensions which can be used to classify client search result entries.

Configuring Search Entry Criteria

In order to configure a search entry criteria object created using this API, use a command like:

      dsconfig create-search-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 search entry criteria instance, "{class-name}" is the fully-qualified name of the Java class that extends com.unboundid.directory.sdk.ds.api.SearchEntryCriteria, and "{name=value}" represents name-value pairs for any arguments to provide to the search entry criteria. If multiple arguments should be provided to the search entry criteria instance, then the "--set extension-argument:{name=value}" option should be provided multiple times.

Constructor Summary

Constructors

Constructor and Description
SearchEntryCriteria() Creates a new instance of this search entry criteria.

Method Summary

Modifier and Type	Method and Description
ResultCode	applyConfiguration(SearchEntryCriteriaConfig 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.
void	defineConfigArguments(ArgumentParser parser) Updates the provided argument parser to define any configuration arguments which may be used by this extension.
void	finalizeSearchEntryCriteria() Performs any cleanup which may be necessary when this search entry criteria 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	initializeSearchEntryCriteria(DirectoryServerContext serverContext, SearchEntryCriteriaConfig config, ArgumentParser parser) Initializes this search entry criteria.
boolean	isConfigurationAcceptable(SearchEntryCriteriaConfig 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.
abstract boolean	matches(OperationContext o, Entry entry, java.util.List<Control> controls) Indicates whether the provided operation matches the criteria for this search entry criteria object.

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchEntryCriteria

public SearchEntryCriteria()

Creates a new instance of this search entry criteria. All search entry criteria implementations must include a default constructor, but any initialization should generally be done in the initializeSearchEntryCriteria method.

Method Detail

getExtensionName

public abstract java.lang.String getExtensionName()

Retrieves a human-readable name for this extension.

Specified by:

getExtensionName in interface UnboundIDExtension

Returns:

A human-readable name for this extension.

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.

initializeSearchEntryCriteria

public void initializeSearchEntryCriteria(DirectoryServerContext serverContext,
                                          SearchEntryCriteriaConfig config,
                                          ArgumentParser parser)
                                   throws LDAPException

Initializes this search 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 search entry criteria.

parser - The argument parser which has been initialized from the configuration for this search entry criteria.

Throws:

LDAPException - If a problem occurs while initializing this search entry criteria.

isConfigurationAcceptable

public boolean isConfigurationAcceptable(SearchEntryCriteriaConfig 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<SearchEntryCriteriaConfig>

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(SearchEntryCriteriaConfig 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<SearchEntryCriteriaConfig>

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.

finalizeSearchEntryCriteria

public void finalizeSearchEntryCriteria()

Performs any cleanup which may be necessary when this search entry criteria is to be taken out of service.

matches

public abstract boolean matches(OperationContext o,
                                Entry entry,
                                java.util.List<Control> controls)

Indicates whether the provided operation matches the criteria for this search entry criteria object.

Parameters:

o - The context for the associated search operation.

entry - The entry for which to make the determination.

controls - The controls included with the search result entry.

Returns:

true if the provided operation matches the criteria for this search entry criteria object, or false if not.

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.