|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opends.server.api.VirtualAttributeProvider<EntryUUIDVirtualAttributeCfg>
org.opends.server.extensions.EntryUUIDVirtualAttributeProvider
public class EntryUUIDVirtualAttributeProvider
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 |
---|
public EntryUUIDVirtualAttributeProvider()
Method Detail |
---|
public void initializeVirtualAttributeProvider(EntryUUIDVirtualAttributeCfg configuration) throws ConfigException, InitializationException
initializeVirtualAttributeProvider
in class VirtualAttributeProvider<EntryUUIDVirtualAttributeCfg>
configuration
- The configuration to use to initialize
this virtual attribute provider.
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.public boolean isMultiValued()
isMultiValued
in class VirtualAttributeProvider<EntryUUIDVirtualAttributeCfg>
true
if this virtual attribute provider may
generate multiple values, or false
if not.public java.util.LinkedHashSet<AttributeValue> getValues(Entry entry, VirtualAttributeRule rule)
getValues
in class VirtualAttributeProvider<EntryUUIDVirtualAttributeCfg>
entry
- The entry for which the values are to be
generated.rule
- The virtual attribute rule which defines the
constraints for the virtual attribute.
null
.public boolean hasValue(Entry entry, VirtualAttributeRule rule)
hasValue
in class VirtualAttributeProvider<EntryUUIDVirtualAttributeCfg>
entry
- The entry for which to make the determination.rule
- The virtual attribute rule which defines the
constraints for the virtual attribute.
true
if this virtual attribute provider will
generate at least one value for the provided entry, or
false
if not.public boolean hasValue(Entry entry, VirtualAttributeRule rule, AttributeValue value)
hasValue
in class VirtualAttributeProvider<EntryUUIDVirtualAttributeCfg>
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.
true
if this virtual attribute provider will
generate the specified vaule for the provided entry, or
false
if not.public ConditionResult matchesSubstring(Entry entry, VirtualAttributeRule rule, ByteString subInitial, java.util.List<ByteString> subAny, ByteString subFinal)
matchesSubstring
in class VirtualAttributeProvider<EntryUUIDVirtualAttributeCfg>
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.
UNDEFINED
if this attribute does not have a
substring matching rule, TRUE
if at least one
value matches the provided substring, or FALSE
otherwise.public ConditionResult greaterThanOrEqualTo(Entry entry, VirtualAttributeRule rule, AttributeValue value)
greaterThanOrEqualTo
in class VirtualAttributeProvider<EntryUUIDVirtualAttributeCfg>
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.
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.public ConditionResult lessThanOrEqualTo(Entry entry, VirtualAttributeRule rule, AttributeValue value)
lessThanOrEqualTo
in class VirtualAttributeProvider<EntryUUIDVirtualAttributeCfg>
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.
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.public ConditionResult approximatelyEqualTo(Entry entry, VirtualAttributeRule rule, AttributeValue value)
approximatelyEqualTo
in class VirtualAttributeProvider<EntryUUIDVirtualAttributeCfg>
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.
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.public boolean isSearchable(VirtualAttributeRule rule, SearchOperation searchOperation)
isSearchable
in class VirtualAttributeProvider<EntryUUIDVirtualAttributeCfg>
rule
- The virtual attribute rule which defines
the constraints for the virtual
attribute.searchOperation
- The search operation for which to make
the determination.
true
if this attribute may be included in search
filters, or false
if not.public void processSearch(VirtualAttributeRule rule, SearchOperation searchOperation)
isSearchable
returns true and it is not possible to
construct a manageable candidate list by processing other
elements of the search criteria.
processSearch
in class VirtualAttributeProvider<EntryUUIDVirtualAttributeCfg>
rule
- The virtual attribute rule which defines
the constraints for the virtual
attribute.searchOperation
- The search operation to be processed.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |