Package org.opends.server.extensions

Class IsMemberOfVirtualAttributeProvider

java.lang.Object

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

org.opends.server.extensions.IsMemberOfVirtualAttributeProvider

public final class IsMemberOfVirtualAttributeProvider
extends VirtualAttributeProvider<IsMemberOfVirtualAttributeCfg>

This class implements a virtual attribute provider that is meant to serve the isMemberOf operational attribute. This attribute will be used to provide a list of all groups in which the specified user is a member.

Constructor Summary

Constructors

Constructor	Description
IsMemberOfVirtualAttributeProvider()

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	tryProcessSearch(AttributeDescription attributeDescription, RequestContext context, SearchRequest request, Predicate<SearchResultEntry> out)	Attempts to process the provided search operation using this virtual attribute, return true if it was successful.

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

finalizeVirtualAttributeProvider, getServerContext, initializeVirtualAttributeProvider, initializeVirtualAttributeProvider, isConfigurationAcceptable

Methods inherited from class java.lang.Object

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

Constructor Details

IsMemberOfVirtualAttributeProvider

public IsMemberOfVirtualAttributeProvider()

Method Details

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

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

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.

tryProcessSearch

public boolean tryProcessSearch(AttributeDescription attributeDescription,
 RequestContext context,
 SearchRequest request,
 Predicate<SearchResultEntry> out)

Attempts to process the provided search operation using this virtual attribute, return true if it was successful.. 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.

Overrides:

tryProcessSearch in class VirtualAttributeProvider<IsMemberOfVirtualAttributeCfg>

Parameters:

attributeDescription - the attribute description corresponding to this virtual attribute

context - The request context

request - The search request

out - A consumer to which search result entries should be published. The predicate should return false if no more results should be computed.

Returns:

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