Package org.opends.server.extensions

Class CollectiveAttributeSubentriesVirtualAttributeProvider

java.lang.Object

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

org.opends.server.extensions.CollectiveAttributeSubentriesVirtualAttributeProvider

public class CollectiveAttributeSubentriesVirtualAttributeProvider
extends VirtualAttributeProvider<CollectiveAttributeSubentriesVirtualAttributeCfg>

This class implements a virtual attribute provider to serve the collectiveAttributeSubentries operational attribute as described in RFC 3671.

Constructor Summary

Constructors

Constructor	Description
CollectiveAttributeSubentriesVirtualAttributeProvider()	Creates a new instance of this collectiveAttributeSubentries virtual attribute provider.

Method Summary

Modifier and Type	Method	Description
Attribute	getValues(Entry entry, VirtualAttributeRule rule)	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(VirtualAttributeRule rule, SearchOperation searchOperation, boolean isPreIndexed)	Indicates whether this attribute may be included in search filters as part of the criteria for locating entries.
void	processSearch(VirtualAttributeRule rule, 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

approximatelyEqualTo, finalizeVirtualAttributeProvider, greaterThanOrEqualTo, hasAllValues, hasValue, hasValue, initializeVirtualAttributeProvider, isConfigurationAcceptable, lessThanOrEqualTo, matchesEqualityAssertion, matchesSubstring

Methods inherited from class java.lang.Object

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

Constructor Detail

CollectiveAttributeSubentriesVirtualAttributeProvider

public CollectiveAttributeSubentriesVirtualAttributeProvider()

Creates a new instance of this collectiveAttributeSubentries virtual attribute provider.

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<CollectiveAttributeSubentriesVirtualAttributeCfg>

Returns:

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

getValues

public Attribute getValues(Entry entry,
                           VirtualAttributeRule rule)

Description copied from class: VirtualAttributeProvider

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

Specified by:

getValues in class VirtualAttributeProvider<CollectiveAttributeSubentriesVirtualAttributeCfg>

Parameters:

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

rule - The virtual attribute rule which defines the constraints for the 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(VirtualAttributeRule rule,
                            SearchOperation searchOperation,
                            boolean isPreIndexed)

Description copied from class: VirtualAttributeProvider

Indicates whether this attribute may be included in search filters as part of the criteria for locating entries.

Specified by:

isSearchable in class VirtualAttributeProvider<CollectiveAttributeSubentriesVirtualAttributeCfg>

Parameters:

rule - The virtual attribute rule which defines the constraints for the 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(VirtualAttributeRule rule,
                          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.

Specified by:

processSearch in class VirtualAttributeProvider<CollectiveAttributeSubentriesVirtualAttributeCfg>

Parameters:

rule - The virtual attribute rule which defines the constraints for the virtual attribute.

searchOperation - The search operation to be processed.