public class GoverningStructureRuleVirtualAttributeProvider extends VirtualAttributeProvider<org.forgerock.opendj.server.config.server.GoverningStructureRuleVirtualAttributeCfg>
Constructor and Description |
---|
GoverningStructureRuleVirtualAttributeProvider()
Creates a new instance of this governingStructureRule virtual attribute provider.
|
Modifier and Type | Method and Description |
---|---|
org.forgerock.opendj.ldap.ConditionResult |
approximatelyEqualTo(Entry entry,
VirtualAttributeRule rule,
org.forgerock.opendj.ldap.ByteString value)
Indicates whether this virtual attribute provider will generate
any value for the provided entry that is approximately equal to
the given value.
|
Attribute |
getValues(Entry entry,
VirtualAttributeRule rule)
Generates an unmodifiable attribute with the values for the provided entry.
|
org.forgerock.opendj.ldap.ConditionResult |
greaterThanOrEqualTo(Entry entry,
VirtualAttributeRule rule,
org.forgerock.opendj.ldap.ByteString 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 |
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.
|
org.forgerock.opendj.ldap.ConditionResult |
lessThanOrEqualTo(Entry entry,
VirtualAttributeRule rule,
org.forgerock.opendj.ldap.ByteString 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.
|
org.forgerock.opendj.ldap.ConditionResult |
matchesSubstring(Entry entry,
VirtualAttributeRule rule,
org.forgerock.opendj.ldap.ByteString subInitial,
List<org.forgerock.opendj.ldap.ByteString> subAny,
org.forgerock.opendj.ldap.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.
|
finalizeVirtualAttributeProvider, hasAllValues, hasValue, initializeVirtualAttributeProvider, isConfigurationAcceptable, matchesEqualityAssertion
public GoverningStructureRuleVirtualAttributeProvider()
public boolean isMultiValued()
VirtualAttributeProvider
isMultiValued
in class VirtualAttributeProvider<org.forgerock.opendj.server.config.server.GoverningStructureRuleVirtualAttributeCfg>
true
if this virtual attribute provider may
generate multiple values, or false
if not.public Attribute getValues(Entry entry, VirtualAttributeRule rule)
VirtualAttributeProvider
getValues
in class VirtualAttributeProvider<org.forgerock.opendj.server.config.server.GoverningStructureRuleVirtualAttributeCfg>
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)
VirtualAttributeProvider
hasValue
in class VirtualAttributeProvider<org.forgerock.opendj.server.config.server.GoverningStructureRuleVirtualAttributeCfg>
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 org.forgerock.opendj.ldap.ConditionResult matchesSubstring(Entry entry, VirtualAttributeRule rule, org.forgerock.opendj.ldap.ByteString subInitial, List<org.forgerock.opendj.ldap.ByteString> subAny, org.forgerock.opendj.ldap.ByteString subFinal)
VirtualAttributeProvider
matchesSubstring
in class VirtualAttributeProvider<org.forgerock.opendj.server.config.server.GoverningStructureRuleVirtualAttributeCfg>
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 org.forgerock.opendj.ldap.ConditionResult greaterThanOrEqualTo(Entry entry, VirtualAttributeRule rule, org.forgerock.opendj.ldap.ByteString value)
VirtualAttributeProvider
greaterThanOrEqualTo
in class VirtualAttributeProvider<org.forgerock.opendj.server.config.server.GoverningStructureRuleVirtualAttributeCfg>
entry
- The entry for which to make the determination.rule
- The virtual attribute rule which defines the constraints for the
virtual attribute.value
- The assertion 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
assertion value, or FALSE
if none of the generated values
will be greater than or equal to the specified value.public org.forgerock.opendj.ldap.ConditionResult lessThanOrEqualTo(Entry entry, VirtualAttributeRule rule, org.forgerock.opendj.ldap.ByteString value)
VirtualAttributeProvider
lessThanOrEqualTo
in class VirtualAttributeProvider<org.forgerock.opendj.server.config.server.GoverningStructureRuleVirtualAttributeCfg>
entry
- The entry for which to make the determination.rule
- The virtual attribute rule which defines the constraints for the
virtual attribute.value
- The assertion 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
assertion value, or FALSE
if none of the generated values
will be greater than or equal to the specified value.public org.forgerock.opendj.ldap.ConditionResult approximatelyEqualTo(Entry entry, VirtualAttributeRule rule, org.forgerock.opendj.ldap.ByteString value)
VirtualAttributeProvider
approximatelyEqualTo
in class VirtualAttributeProvider<org.forgerock.opendj.server.config.server.GoverningStructureRuleVirtualAttributeCfg>
entry
- The entry for which to make the determination.rule
- The virtual attribute rule which defines the
constraints for the virtual attribute.value
- The assertion value for which to make the determination.UNDEFINED
if the associated attribute type does
not have an approximate 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 assertion value.public boolean isSearchable(VirtualAttributeRule rule, SearchOperation searchOperation, boolean isPreIndexed)
VirtualAttributeProvider
isSearchable
in class VirtualAttributeProvider<org.forgerock.opendj.server.config.server.GoverningStructureRuleVirtualAttributeCfg>
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.true
if this attribute may be included in search
filters, or false
if not.public void processSearch(VirtualAttributeRule rule, SearchOperation searchOperation)
VirtualAttributeProvider
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<org.forgerock.opendj.server.config.server.GoverningStructureRuleVirtualAttributeCfg>
rule
- The virtual attribute rule which defines
the constraints for the virtual
attribute.searchOperation
- The search operation to be processed.Copyright © 2010-2017 ForgeRock AS. All Rights Reserved.