org.opends.server.extensions
Class EntryUUIDVirtualAttributeProvider

java.lang.Object
  org.opends.server.api.VirtualAttributeProvider<EntryUUIDVirtualAttributeCfg>
      org.opends.server.extensions.EntryUUIDVirtualAttributeProvider

public class EntryUUIDVirtualAttributeProvider
extends VirtualAttributeProvider<EntryUUIDVirtualAttributeCfg>

This class implements a virtual attribute provider that is meant to serve the entryUUID operational attribute as described in RFC 4530. Note that this should only be used for entries used in conjuntion with data in private backends (e.g., those holding the configuration, schema, monitor, and root DSE entries). Real user data should have entry UUID values generated at the time the entries are added or imported.

Constructor Summary

EntryUUIDVirtualAttributeProvider()
Creates a new instance of this entryUUID virtual attribute provider.

Method Summary

ConditionResult	approximatelyEqualTo(Entry entry, VirtualAttributeRule rule, AttributeValue value) Indicates whether this virtual attribute provider will generate any value for the provided entry that is approximately equal to the given value.
java.util.LinkedHashSet<AttributeValue>	getValues(Entry entry, VirtualAttributeRule rule) Generates a set of values for the provided entry.
ConditionResult	greaterThanOrEqualTo(Entry entry, VirtualAttributeRule rule, AttributeValue value) Indicates whether this virtual attribute provider will generate any value for the provided entry that is greater than or equal to the given value.
boolean	hasValue(Entry entry, VirtualAttributeRule rule) Indicates whether this virtual attribute provider will generate at least one value for the provided entry.
boolean	hasValue(Entry entry, VirtualAttributeRule rule, AttributeValue value) Indicates whether this virtual attribute provider will generate the provided value.
void	initializeVirtualAttributeProvider(EntryUUIDVirtualAttributeCfg configuration) Initializes this virtual attribute based on the information in the provided configuration entry.
boolean	isMultiValued() Indicates whether this virtual attribute provider may generate multiple values.
boolean	isSearchable(VirtualAttributeRule rule, SearchOperation searchOperation) Indicates whether this attribute may be included in search filters as part of the criteria for locating entries.
ConditionResult	lessThanOrEqualTo(Entry entry, VirtualAttributeRule rule, AttributeValue value) Indicates whether this virtual attribute provider will generate any value for the provided entry that is less than or equal to the given value.
ConditionResult	matchesSubstring(Entry entry, VirtualAttributeRule rule, ByteString subInitial, java.util.List<ByteString> subAny, ByteString subFinal) Indicates whether this virtual attribute provider will generate any value which matches the provided substring.
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

finalizeVirtualAttributeProvider, hasAllValues, hasAnyValue, isConfigurationAcceptable

Methods inherited from class java.lang.Object

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

Constructor Detail

EntryUUIDVirtualAttributeProvider

public EntryUUIDVirtualAttributeProvider()

Creates a new instance of this entryUUID virtual attribute provider.

Method Detail

initializeVirtualAttributeProvider

public void initializeVirtualAttributeProvider(EntryUUIDVirtualAttributeCfg configuration)
                                        throws ConfigException,
                                               InitializationException

Initializes this virtual attribute based on the information in the provided configuration entry.

Specified by:

initializeVirtualAttributeProvider in class VirtualAttributeProvider<EntryUUIDVirtualAttributeCfg>

Parameters:

configuration - The configuration to use to initialize this virtual attribute provider.

Throws:

ConfigException - If an unrecoverable problem arises in the process of performing the initialization.

InitializationException - If a problem occurs during initialization that is not related to the server configuration.

isMultiValued

public boolean isMultiValued()

Indicates whether this virtual attribute provider may generate multiple values.

Specified by:

isMultiValued in class VirtualAttributeProvider<EntryUUIDVirtualAttributeCfg>

Returns:

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

getValues

public java.util.LinkedHashSet<AttributeValue> getValues(Entry entry,
                                                         VirtualAttributeRule rule)

Generates a set of values for the provided entry.

Specified by:

getValues in class VirtualAttributeProvider<EntryUUIDVirtualAttributeCfg>

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 set of values generated for the provided entry. It may be empty, but it must not be null.

hasValue

public boolean hasValue(Entry entry,
                        VirtualAttributeRule rule)

Indicates whether this virtual attribute provider will generate at least one value for the provided entry.

Overrides:

hasValue in class VirtualAttributeProvider<EntryUUIDVirtualAttributeCfg>

Parameters:

entry - The entry for which to make the determination.

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

Returns:

true if this virtual attribute provider will generate at least one value for the provided entry, or false if not.

hasValue

public boolean hasValue(Entry entry,
                        VirtualAttributeRule rule,
                        AttributeValue value)

Indicates whether this virtual attribute provider will generate the provided value.

Overrides:

hasValue in class VirtualAttributeProvider<EntryUUIDVirtualAttributeCfg>

Parameters:

entry - The entry for which to make the determination.

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

value - The value for which to make the determination.

Returns:

true if this virtual attribute provider will generate the specified vaule for the provided entry, or false if not.

matchesSubstring

public ConditionResult matchesSubstring(Entry entry,
                                        VirtualAttributeRule rule,
                                        ByteString subInitial,
                                        java.util.List<ByteString> subAny,
                                        ByteString subFinal)

Indicates whether this virtual attribute provider will generate any value which matches the provided substring.

Overrides:

matchesSubstring in class VirtualAttributeProvider<EntryUUIDVirtualAttributeCfg>

Parameters:

entry - The entry for which to make the determination.

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

subInitial - The subInitial component to use in the determination.

subAny - The subAny components to use in the determination.

subFinal - The subFinal component to use in the determination.

Returns:

UNDEFINED if this attribute does not have a substring matching rule, TRUE if at least one value matches the provided substring, or FALSE otherwise.

greaterThanOrEqualTo

public ConditionResult greaterThanOrEqualTo(Entry entry,
                                            VirtualAttributeRule rule,
                                            AttributeValue value)

Indicates whether this virtual attribute provider will generate any value for the provided entry that is greater than or equal to the given value.

Overrides:

greaterThanOrEqualTo in class VirtualAttributeProvider<EntryUUIDVirtualAttributeCfg>

Parameters:

entry - The entry for which to make the determination.

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

value - The value for which to make the determination.

Returns:

UNDEFINED if the associated attribute type does not have an ordering matching rule, TRUE if at least one of the generated values will be greater than or equal to the specified value, or FALSE if none of the generated values will be greater than or equal to the specified value.

lessThanOrEqualTo

public ConditionResult lessThanOrEqualTo(Entry entry,
                                         VirtualAttributeRule rule,
                                         AttributeValue value)

Indicates whether this virtual attribute provider will generate any value for the provided entry that is less than or equal to the given value.

Overrides:

lessThanOrEqualTo in class VirtualAttributeProvider<EntryUUIDVirtualAttributeCfg>

Parameters:

entry - The entry for which to make the determination.

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

value - The value for which to make the determination.

Returns:

UNDEFINED if the associated attribute type does not have an ordering matching rule, TRUE if at least one of the generated values will be less than or equal to the specified value, or FALSE if none of the generated values will be greater than or equal to the specified value.

approximatelyEqualTo

public ConditionResult approximatelyEqualTo(Entry entry,
                                            VirtualAttributeRule rule,
                                            AttributeValue value)

Indicates whether this virtual attribute provider will generate any value for the provided entry that is approximately equal to the given value.

Overrides:

approximatelyEqualTo in class VirtualAttributeProvider<EntryUUIDVirtualAttributeCfg>

Parameters:

entry - The entry for which to make the determination.

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

value - The value for which to make the determination.

Returns:

UNDEFINED if the associated attribute type does not have an aproximate matching rule, TRUE if at least one of the generated values will be approximately equal to the specified value, or FALSE if none of the generated values will be approximately equal to the specified value.

isSearchable

public boolean isSearchable(VirtualAttributeRule rule,
                            SearchOperation searchOperation)

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.

Specified by:

isSearchable in class VirtualAttributeProvider<EntryUUIDVirtualAttributeCfg>

Parameters:

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

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

Returns:

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

processSearch

public void processSearch(VirtualAttributeRule rule,
                          SearchOperation searchOperation)

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

Parameters:

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

searchOperation - The search operation to be processed.