Package org.opends.server.extensions

Class EntryDNVirtualAttributeProvider

java.lang.Object

org.opends.server.api.VirtualAttributeProvider<EntryDnVirtualAttributeCfg>

org.opends.server.extensions.EntryDNVirtualAttributeProvider

public class EntryDNVirtualAttributeProvider
extends VirtualAttributeProvider<EntryDnVirtualAttributeCfg>

This class implements a virtual attribute provider that is meant to serve the entryDN operational attribute as described in draft-zeilenga-ldap-entrydn.

Constructor Summary

Constructors

Constructor	Description
EntryDNVirtualAttributeProvider()

Method Summary

Modifier and Type	Method	Description
Attribute	getAttribute(Entry entry, AttributeDescription attributeDescription)	Generates an unmodifiable attribute with the values for the provided entry.
boolean	isMultiValued()	Indicates whether this virtual attribute provider may generate multiple values.
boolean	isSearchable(AttributeDescription attributeDescription, SearchOperation searchOperation, boolean isPreIndexed)	Indicates whether this attribute may be included in search filters as part of the criteria for locating entries.
void	processSearch(AttributeDescription attributeDescription, SearchOperation searchOperation)	Processes the provided search operation in which the search criteria includes an operation targeted at this virtual attribute.

Methods inherited from class org.opends.server.api.VirtualAttributeProvider

finalizeVirtualAttributeProvider, initializeVirtualAttributeProvider, isConfigurationAcceptable

Methods inherited from class java.lang.Object

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

Constructor Detail

EntryDNVirtualAttributeProvider

public EntryDNVirtualAttributeProvider()

Method Detail

isMultiValued

public boolean isMultiValued()

Description copied from class: VirtualAttributeProvider

Indicates whether this virtual attribute provider may generate multiple values.

Specified by:

isMultiValued in class VirtualAttributeProvider<EntryDnVirtualAttributeCfg>

Returns:

true if this virtual attribute provider may generate multiple values, or false if not.

getAttribute

public Attribute getAttribute(Entry entry,
                              AttributeDescription attributeDescription)

Description copied from class: VirtualAttributeProvider

Generates an unmodifiable attribute with the values for the provided entry.

Specified by:

getAttribute in class VirtualAttributeProvider<EntryDnVirtualAttributeCfg>

Parameters:

entry - The entry for which the values are to be generated.

attributeDescription - the attribute description corresponding to this virtual attribute

Returns:

The unmodifiable attribute with the values generated for the provided entry. It may be empty, but it must not be null.

isSearchable

public boolean isSearchable(AttributeDescription attributeDescription,
                            SearchOperation searchOperation,
                            boolean isPreIndexed)

Indicates whether this attribute may be included in search filters as part of the criteria for locating entries.. This virtual attribute will support search operations only if one of the following is true about the search filter:

• It is an equality filter targeting the associated attribute type.
• It is an AND filter in which at least one of the components is an equality filter targeting the associated attribute type.
• It is an OR filter in which all of the components are equality filters targeting the associated attribute type.

This virtual attribute also can be optimized as pre-indexed.

Overrides:

isSearchable in class VirtualAttributeProvider<EntryDnVirtualAttributeCfg>

Parameters:

attributeDescription - the attribute description corresponding to this virtual attribute

searchOperation - The search operation for which to make the determination.

isPreIndexed - Indicates if we expect the search on the virtual attribute to be faster than an index search.

Returns:

true if this attribute may be included in search filters, or false if not.

processSearch

public void processSearch(AttributeDescription attributeDescription,
                          SearchOperation searchOperation)

Description copied from class: VirtualAttributeProvider

Processes the provided search operation in which the search criteria includes an operation targeted at this virtual attribute. This method should only be called if isSearchable returns true and it is not possible to construct a manageable candidate list by processing other elements of the search criteria.

Overrides:

processSearch in class VirtualAttributeProvider<EntryDnVirtualAttributeCfg>

Parameters:

attributeDescription - the attribute description corresponding to this virtual attribute

searchOperation - The search operation to be processed.